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.

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

Already on GitHub? Sign in to your account

Backport of Update telemetry.mdx RPC Metrics into release/1.12.x #19944

Conversation

hc-github-team-consul-core
Copy link
Contributor

Backport

This PR is auto-generated from #19593 to be assessed for backporting due to the inclusion of the label backport/1.12.

🚨

Warning automatic cherry-pick of commits failed. If the first commit failed,
you will see a blank no-op commit below. If at least one commit succeeded, you
will see the cherry-picked commits up to, not including, the commit where
the merge conflict occurred.

The person who merged in the original PR is:
@natemollica-nm
This person should manually cherry-pick the original PR into a new backport PR,
and close this one when the manual backport PR is merged in.

merge conflict error: POST https://api.github.com/repos/hashicorp/consul/merges: 409 Merge conflict []

The below text is copied from the body of the original PR.


Update Server Workload telemetry section to demonstrate explicitly enabling metric emission as they're default disabled.

Description

Customers need to be aware that if investigating server workload via metrics this needs to be explicitly enabled.

Testing & Reproduction steps

  • Run any support version of Consul or Consul Enterprise
  • Enable telemetry in agent config viaprometheus_retention_time
  • Observe default blocked prefixes showing consul.rpc.server.call:
$ consul agent -dev -node localhost -client 127.0.0.1 -hcl 'telemetry { prometheus_retention_time = "10m" }'

$ curl -s localhost:8500/v1/agent/self | jq -r '.DebugConfig.Telemetry.BlockedPrefixes'                                                                                                                                                                                          
[
  "consul.rpc.server.call"
]
  • Enable RPC metrics using telemetry.prefix_filter and observe permission and emission of desired metrics:
$ consul agent -dev -node localhost -client 127.0.0.1 -hcl 'telemetry { prometheus_retention_time = "10m" prefix_filter = [ "+consul.rpc.server.call" ]}'

$ curl -s localhost:8500/v1/agent/self | jq -r '.DebugConfig.Telemetry.AllowedPrefixes'                                                                                                                                                                                  
[
  "consul.rpc.server.call"
]

Links

PR Checklist

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

Overview of commits

@hashicorp-cla
Copy link

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes


temp seems not to be a GitHub user.
You need a GitHub account to be able to sign the CLA. If you already have a GitHub account, please add the email address used for this commit to your account.

Have you signed the CLA already but the status is still pending? Recheck it.

Copy link

Choose a reason for hiding this comment

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

Auto approved Consul Bot automated PR

@vercel vercel bot temporarily deployed to Preview – consul December 14, 2023 18:59 Inactive
@natemollica-nm natemollica-nm marked this pull request as ready for review December 14, 2023 19:14
@natemollica-nm natemollica-nm enabled auto-merge (squash) December 14, 2023 19:17
@natemollica-nm
Copy link
Contributor

Closed as this backport was to an unsupported version

auto-merge was automatically disabled December 14, 2023 19:55

Pull request was closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants