Getting startedGuidesReferenceChangelog
Apoxy:// Docs / Reference / Metric

Metric

API reference for Metrics (metrics.clrk.apoxy.dev/v1alpha1)

API Group: metrics.clrk.apoxy.dev/v1alpha1

Operations

List Metric

GET/apis/metrics.clrk.apoxy.dev/v1alpha1/metrics

list objects of kind Metric

Response

  • 200: OK

List Metric

GET/apis/metrics.clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/metrics

list objects of kind Metric

Response

  • 200: OK

Get Metric

GET/apis/metrics.clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/metrics/{name}

Get the specified Metric

Response

  • 200: OK

Query Metric series

GET/apis/metrics.clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/metrics/{name}/series

Runs a metric query and returns a MetricSeriesSet. The query parameters (metric, groupBy, since, until, step, quantiles, scopeKind, scopeName) and the response shape are documented in Query fleet metrics.


Schema Reference

Metric

FieldTypeDescription
defaultGroupBystringDefaultGroupBy is the dimension the console selects by default.
descriptionstringDescription is a one-line human summary.
groupBystring[]GroupBy is the set of dimension keys this metric may be grouped by (the chart legends). One is passed as ?groupBy on the series subresource.
legendstringLegend is a short human label for the default dimension.
measuresstring[]Measures are the named sub-values a single point carries when a metric reports more than one (e.g. gen_ai.tokens -> input/output). Each becomes a "measure" label on its series. Empty for single-valued metrics.
sourcestringSource is the backing table the recipe scans: "traces" or "logs". (required)
typestringType is Counter, Gauge, or Histogram. A histogram is queried with ?quantiles and returns one series per (group x quantile). (required)
unitstringUnit is the value unit ("tokens", "requests", "bytes", "ms", ...). (required)