Skip to content

clickhouse

ClickHouse storage, used to define ClickHouse or other SQL-table backend metadata for query planning. It routes to the sql-table query family via spec.family, rendering get_metrics as SQL.

Kind: clickhouse

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

spec fields

FieldTypeRequiredDefaultDescription
familystringThe query family this storage renders through. Set sql-table to render get_metrics as SQL via the sql-table renderer; omit it and the storage stays passthrough-only. Every backend in the family after the first is conf…
endpointstringyesThe endpoint URL of ClickHouse, for example http://clickhouse:8123.
databasestringThe database name used for queries.
tablestringyesThe table holding the metrics. The sql-table renderer SELECTs from this table.
time_columnstringtimestampThe time column used for time-range filtering and downsampling. Defaults to timestamp.
value_columnstringvalueThe metric value column. Defaults to value.
metric_columnstringmetric_nameThe column holding the metric name, used to filter by metric. Defaults to metric_name.
default_query_typeenum: instant, rangerangeDefault query type. instant returns the latest value, range downsamples over an interval.
default_stepstringDefault downsampling step for range queries, for example 60s or 1m.
credential_refstringCredential reference, for example secret://clickhouse-prod-readonly. Plaintext usernames, passwords, or tokens must not be stored in UModel.
tls_verifybooleantrueWhether TLS certificates should be verified. Defaults to true.
propertiesmap<string, string>Additional non-sensitive ClickHouse configuration, stored as key-value pairs.
tagsmap<string, string>Tags used to describe this ClickHouse storage.

Released under the Apache-2.0 License.