Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add target group info metric #3581

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add target group info metric #3581

wants to merge 1 commit into from

Conversation

msvticket
Copy link

@msvticket msvticket commented Feb 16, 2024 •
edited

Description

When monitoring target groups by importing cloudwatch metrics it's tricky to see what service an alert corresponds to. This PR adds a relation metric called aws_target_group_info that you can use to enrich the metric from cloudwatch with labels for service and namespace.

Example PromQL:

aws_target_group_info * on(target_group) group_left last_over_time(aws_applicationelb_healthy_host_count_minimum[20m])

Checklist

  • Added tests that cover your change (if possible)
  • Added/modified documentation as required (such as the README.md, or the docs directory)
  • Manually tested
  • Made sure the title of the PR is a good description that can go into the release notes

BONUS POINTS checklist: complete for good vibes and maybe prizes?! 馃く

  • Backfilled missing tests for code in same general area 馃帀
  • Refactored something and made the world a better place 馃専

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 16, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @msvticket. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 16, 2024
@oliviassss
Copy link
Collaborator

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 13, 2024
@msvticket
Copy link
Author

Could you please review as well @oliviassss ?

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 21, 2024
oliviassss
oliviassss reviewed May 21, 2024
View reviewed changes
controllers/ingress/group_controller.go
networkingSGReconciler networkingpkg.SecurityGroupReconciler,
subnetsResolver networkingpkg.SubnetsResolver,
elbv2TaggingManager elbv2deploy.TaggingManager,
targetGroupMetric *prometheus.GaugeVec,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: maybe name it as targetGroupMetricAgent or targetGroupMetricCollect ?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see how that would make the code clearer

controllers/service/service_controller.go
subnetsResolver networking.SubnetsResolver,
vpcInfoProvider networking.VPCInfoProvider,
elbv2TaggingManager elbv2deploy.TaggingManager,
targetGroupMetric *prometheus.GaugeVec,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

main.go
@@ -114,11 +116,15 @@ func main() {
cloud.VpcID(), cloud.EC2(), mgr.GetClient(), controllerCFG.DefaultTags, ctrl.Log.WithName("backend-sg-provider"))
sgResolver := networking.NewDefaultSecurityGroupResolver(cloud.EC2(), cloud.VpcID())
elbv2TaggingManager := elbv2deploy.NewDefaultTaggingManager(cloud.ELBV2(), cloud.VpcID(), controllerCFG.FeatureGates, cloud.RGT(), ctrl.Log)
targetGroupMetric, err := metrics.RegisterTargetGroupInfoMetric(k8smetric.Registry)
if err != nil {
setupLog.Error(err, "failed to register target binding information metric")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: should it be target group instead of target binding?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, that depends if look at it from the AWS or k8s perspectives. The k8s resource created by alb controller for a AWS target group is a targetgroupbinding. So either would be correct...

pkg/aws/metrics/target_group.go
)

const (
metricTargetGroupBinding = "target_group_info"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: metricTargetGroup maybe more precise?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

pkg/aws/metrics/target_group.go Outdated Show resolved Hide resolved
@oliviassss
Copy link
Collaborator

@msvticket, sorry for the delay, and thanks for the contribution to improve the observability for LBC!
I left some nit comments. Also, can you please adding the unit test coverage for pkg/aws/metrics/target_group.go?

@oliviassss
Copy link
Collaborator

want some second opnions from @M00nF1sh
/assign @M00nF1sh

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: msvticket
Once this PR has been reviewed and has the lgtm label, please ask for approval from m00nf1sh. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oliviassss oliviassss oliviassss left review comments

@M00nF1sh M00nF1sh Awaiting requested review from M00nF1sh

Assignees

@M00nF1sh M00nF1sh

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@msvticket @k8s-ci-robot @oliviassss @M00nF1sh