Getting startedGuidesReferenceChangelog
Apoxy:// Docs / Reference / TaskAgentMetrics

TaskAgentMetrics

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

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

Operations

List TaskAgentMetrics

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

list objects of kind TaskAgentMetrics

Response

  • 200: OK

List TaskAgentMetrics

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

list objects of kind TaskAgentMetrics

Response

  • 200: OK

Get TaskAgentMetric

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

Get the specified TaskAgentMetrics

Response

  • 200: OK

Query TaskAgentMetrics series

GET/apis/metrics.clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/taskagentmetrics/{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

TaskAgentMetrics

FieldTypeDescription
timestampTimeTimestamp is when the rollup was computed (the query time). (required)
usageobjectUsage is the scalar rollup. See the Usage* key constants. (required)
windowDurationWindow is the look-back the usage values cover, e.g. 24h. Making the window self-describing on every object resolves the telemetry read model's standing ambiguity, where an unset since/until means "the latest N records" rather than a stated span. (required)