Skip to content

victoriametrics

VictoriaMetrics storage, used to define VictoriaMetrics or other PromQL-compatible time-series backend metadata for query planning. It reuses the label-timeseries query family via spec.family, requiring no UModel code.

Kind: victoriametrics

Every element shares the standard envelope kind · metadata · schema.

spec fields

FieldTypeRequiredDefaultDescription
familystringThe query family this storage renders through. VictoriaMetrics is PromQL-compatible, so setting label-timeseries reuses the Prometheus query-plan renderer with no Go code — exactly how a new same-family backend is add…
endpointstringyesThe endpoint URL of VictoriaMetrics or a PromQL-compatible service, for example http://victoriametrics:8428.
api_prefixstring/api/v1PromQL HTTP API prefix. Defaults to /api/v1.
default_query_typeenum: instant, rangeinstantDefault PromQL query type. instant means instant query and range means range query.
default_stepstringDefault step for range queries, for example 60s or 1m.
lookback_deltastringDefault PromQL lookback window used by query planning, for example 5m.
tenantstringOptional tenant identifier for multi-tenant VictoriaMetrics cluster deployments.
tenant_headerstringTenant HTTP header name used by multi-tenant systems, for example X-Scope-OrgID.
credential_refstringCredential reference, for example secret://victoriametrics-prod-readonly. Plaintext usernames, passwords, or tokens must not be stored in UModel.
tls_verifybooleantrueWhether TLS certificates should be verified. Defaults to true.
external_labelsmap<string, string>External labels used to enrich query-planning context or describe result origin.
headersmap<string, string>Non-sensitive HTTP headers for tenant or routing context. Authentication secrets must not be stored here.
propertiesmap<string, string>Additional non-sensitive VictoriaMetrics configuration, stored as key-value pairs.
tagsmap<string, string>Tags used to describe this VictoriaMetrics storage.

Released under the Apache-2.0 License.