diff --git a/docs/tempo/website/configuration/_index.md b/docs/tempo/website/configuration/_index.md index a851674ed12..1d79af797de 100644 --- a/docs/tempo/website/configuration/_index.md +++ b/docs/tempo/website/configuration/_index.md @@ -978,6 +978,16 @@ overrides: # used set in the metrics_generator config block. [metrics_generator_collection_interval: ] + # Per-user flag of the registry collection operation. If set, the registry will not be + # collected and no samples will be exported from the metrics-generator. The metrics-generator + # will still ingest spans and update its internal counters, including the amount of active + # series. To disable metrics generation entirely, clear metrics_generator_processors for this + # tenant. + # + # This setting is useful if you wish to test how many active series a tenant will generate, without + # actually writing these metrics. + [metrics_generator_disable_collection: | default = false] + # Tenant-specific overrides settings configuration file. The empty string (default # value) disables using an overrides file. [per_tenant_override_config: | default = ""] diff --git a/modules/overrides/overrides.go b/modules/overrides/overrides.go index 2cab55ee590..08f029acd76 100644 --- a/modules/overrides/overrides.go +++ b/modules/overrides/overrides.go @@ -286,7 +286,7 @@ func (o *Overrides) MetricsGeneratorCollectionInterval(userID string) time.Durat return o.getOverridesForUser(userID).MetricsGeneratorCollectionInterval } -// MetricsGeneratorDisableRemoteWrite controls whether metrics are remote written for this tenant. +// MetricsGeneratorDisableCollection controls whether metrics are remote written for this tenant. func (o *Overrides) MetricsGeneratorDisableCollection(userID string) bool { return o.getOverridesForUser(userID).MetricsGeneratorDisableCollection }