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

Updated metrics generator note #4141

Closed
wants to merge 1 commit into from
Closed

Updated metrics generator note #4141

wants to merge 1 commit into from

Conversation

ej25a
Copy link

@ej25a ej25a commented Sep 29, 2024

Added a note that Metrics Generator can be enabled via Application Observability or to contact support for custom Metrics Generator configs. Mirrors the note found on this page for Metrics Generator https://grafana.com/docs/grafana-cloud/send-data/traces/metrics-generator/

Which issue(s) this PR fixes:
Fixes https://github.com/grafana/support-escalations/issues/12501

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

Added a note that Metrics Generator can be enabled via Application  Observability or to contact support for custome Metrics Generator configs.
@ej25a ej25a added the type/docs Improvements or additions to documentation label Sep 29, 2024
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

github-actions bot commented Oct 2, 2024

This PR must be merged before a backport PR will be created.

@@ -21,7 +21,7 @@ but it has distributed tracing implemented.
You get out-of-the-box metrics from your tracing pipeline.

{{< admonition type="note" >}}
Metrics generation is disabled by default. Contact Grafana Support to enable metrics generation in your organization.
Metrics generation is disabled by default. You can enable it for use with Application Observability defaults in Application Observability, or contact Grafana Support to enable metrics-generation for your organization with custom settings.
Copy link
Contributor

@knylander-grafana knylander-grafana Oct 2, 2024

Choose a reason for hiding this comment

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

Greetings. Thank you for taking the time to submit a change to the docs. What prompted the update to focus on Application Observability within this note specifically?

I see that this is a copy of a note from the Cloud docs. The wording could be improved, but it brings up a larger issue. Does this note really belong in the Tempo docs or should we be directing people only to the Cloud Traces docs for setting up metrics-generator in the Cloud?

Copy link
Contributor

@knylander-grafana knylander-grafana left a comment

Choose a reason for hiding this comment

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

See my other comment. We should consider whether this is an appropriate update to the text in the Grafana Tempo docs. There may be another spot better suited to mentioning that metrics-generator is useful/required for Application Observability.

@knylander-grafana
Copy link
Contributor

knylander-grafana commented Oct 2, 2024

I read through the original issue linked in the description and found a few things:

  • There are notes in the Tempo docs that were copied from the Cloud docs -- and should have remained only in the Cloud docs.
  • Any information about configuration related to the Cloud Traces and metrics generator should be in the Cloud Traces docs and not in the Tempo docs.

I've corrected these things in this PR: #4151

If you feel that my PR meets the documentation needs for the support issue, my sugegstion is that we close this PR in favor of mine.

Thank you.

@knylander-grafana
Copy link
Contributor

I'm going to close this PR in favor of this one: #4151

Please let me know if you feel that this other PR doesn't cover the content from the support issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants