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

[release-v2.1] [DOC] Update metrics generator doc and add best practices #2569

Merged
merged 10 commits into from
Jun 27, 2023

Conversation

knylander-grafana
Copy link
Contributor

Backport 9499cb9 from #2563

Backport content from metrics-generator and best practices doc update. This PR should not have any content that is unreleased.

knylander-grafana and others added 2 commits June 16, 2023 20:38
* Update metrics generator doc

* Updates from doc validator

* Fix typos and links

* Fix typo in admonition

* Fix validator issues, part 2

* Apply suggestions from code review

Co-authored-by: Heds Simons <[email protected]>

* Move content and fix admonitions

* Added best practices

* Update docs/sources/tempo/metrics-generator/span_metrics.md

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Eve Meelan <[email protected]>

* Fix links, admonitions

---------

Co-authored-by: Heds Simons <[email protected]>
Co-authored-by: Eve Meelan <[email protected]>
(cherry picked from commit 9499cb9)

# Conflicts:
#	docs/sources/tempo/configuration/grafana-agent/service-graphs.md
#	docs/sources/tempo/metrics-generator/_index.md
#	docs/sources/tempo/metrics-generator/service_graphs.md
#	docs/sources/tempo/metrics-generator/span_metrics.md
#	docs/sources/tempo/operations/_index.md
#	docs/sources/tempo/traceql/_index.md
@knylander-grafana knylander-grafana added type/docs Improvements or additions to documentation backport labels Jun 17, 2023
@knylander-grafana knylander-grafana self-assigned this Jun 17, 2023
@ie-pham
Copy link
Collaborator

ie-pham commented Jun 21, 2023

Can we add information about MetricsIngestionSlack (in cloud we are defaulting this to 30s) so all spans sent to the metrics-generator with an end time more than 30s in the past would get discarded/rejected. This metrics is exposed in metrics_generator_spans_discarded_total
https://github.com/grafana/tempo/blob/main/modules/generator/config.go#L35

@knylander-grafana
Copy link
Contributor Author

@joe-elliott Would you re-review?

@knylander-grafana
Copy link
Contributor Author

Can we add information about MetricsIngestionSlack (in cloud we are defaulting this to 30s) so all spans sent to the metrics-generator with an end time more than 30s in the past would get discarded/rejected. This metrics is exposed in metrics_generator_spans_discarded_total
https://github.com/grafana/tempo/blob/main/modules/generator/config.go#L35

@ie-pham That looks like is was added in PR#2424, which isn't released yet. I can add the information to PR#2580, where I'm adding the changes from this 2.1 backport PR to the files in main.

@joe-elliott
Copy link
Member

The metrics from spans discussion in particular is very well done. It really illuminates where the cardinality comes from.

@knylander-grafana
Copy link
Contributor Author

The metrics from spans discussion in particular is very well done. It really illuminates where the cardinality comes from.

Thank you! As always, this is a team effort for content. @hedss had some excellent content already written that was the basis for the cardinality and active series pages. There were also other pages written by Mario, Koenraad, you, and others that informed the content too.

@knylander-grafana knylander-grafana merged commit 0f08c88 into release-v2.1 Jun 27, 2023
10 checks passed
@knylander-grafana knylander-grafana deleted the backport-2563-to-release-v2.1 branch June 27, 2023 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants