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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for native histograms in the generator #3929

Merged
merged 3 commits into from
Aug 6, 2024
Merged

Add docs for native histograms in the generator #3929

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ebfd20
Add docs for native histograms in the generator
zalegrala Jul 31, 2024
ab73164
Add link to page about native histograms
zalegrala Aug 6, 2024
4b0732d
Drop hyphens
zalegrala Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/sources/tempo/configuration/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1591,6 +1591,11 @@ overrides:
# This is to filter out spans that are outdated.
[ingestion_time_range_slack: <duration>]

# Configures the histogram implementation to use for span-metrics and
# service-graphs processors. If native histograms are desired, the
# receiver must be configured to ingest native histograms.
zalegrala marked this conversation as resolved.
Show resolved Hide resolved
[generate_native_histograms: <classic|native|both> | default = classic]

# Distributor -> metrics-generator forwarder related overrides
forwarder:
# Spans are stored in a queue in the distributor before being sent to the metrics-generators.
Expand Down
8 changes: 8 additions & 0 deletions docs/sources/tempo/metrics-generator/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,11 @@ To learn more about the endpoint configuration, refer to the [Metrics-generator]
Writing interval can be controlled via `metrics_generator.registry.collection_interval`.

When multi-tenancy is enabled, the metrics-generator forwards the `X-Scope-OrgID` header of the original request to the `remote_write` endpoint. This feature can be disabled by setting `remote_write_add_org_id_header` to false.

## Native histograms

The metrics-generator supports the ability to produce native histograms, for
high-resolution data. Users must [update the receiving endpoint](https://grafana.com/docs/mimir/latest/configure/configure-native-histograms-ingestion/) to ingest native
Copy link
Contributor

@knylander-grafana knylander-grafana Aug 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@zalegrala Clarifying question here. Does metrics-generator require a Prometheus or MImir endpoint? Asking because I wasn't sure if Tempo was doing this or not.

If it makes things easier, we can share content from Mimir docs to Tempo.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Correct, Tempo metrics do require Mimir or Prometheus.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've added a link to where we talk about native histograms.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you

histograms, and [update histogram queries](https://grafana.com/docs/mimir/latest/visualize/native-histograms/) in their dashboards.

To learn more about the configuration, refer to the [Metrics-generator]({{< relref "../configuration#metrics-generator" >}}) section of the Tempo Configuration documentation.
Loading