Skip to main content
Version: main 🚧

Fleet Observability labels reference

The Write Gateway owns the full vcluster_platform_* label namespace. These labels are stamped from authenticated Platform context and are safe to use for dashboards, recording rules, and backend queries.

warning

Don't set labels with the vcluster_platform_* prefix in collectors or applications. The Write Gateway strips caller-supplied platform labels before adding authenticated values.

Scope-controlling labels​

The Query Proxy uses these labels for read authorization.

LabelMeaningHeader equivalent
vcluster_platform_clusterControl plane cluster identity.X-Vcluster-Platform-Cluster
vcluster_platform_projectTenant cluster project.X-Vcluster-Platform-Project
vcluster_platform_instanceVirtualClusterInstance name.X-Vcluster-Platform-Instance

Use either cluster scope or tenant scope, not both:

  • Cluster scope: vcluster_platform_cluster
  • Tenant scope: vcluster_platform_project and vcluster_platform_instance

Descriptive labels​

These labels are stamped at write time for filtering and grouping, but they don't authorize reads.

LabelMeaning
vcluster_platform_hosted_onRegistered control plane cluster that hosts the tenant cluster.
vcluster_platform_placementPlacement category, such as hosted, standalone, or external.
vcluster_platform_shapeNode arrangement, such as control_plane, shared_nodes, or private_nodes.
vcluster_platform_node_managementPrivate-node management mode, such as manual or auto. Empty for non-private-node shapes.

Matcher rules​

The Query Proxy restricts matchers on scope-controlling labels:

MatcherScope labelsExample
EqualityAllowedvcluster_platform_instance="api"
Literal alternation regular expressionAllowedvcluster_platform_instance=~"api|worker"
Negative equalityRejectedvcluster_platform_instance!="api"
Negative regular expressionRejectedvcluster_platform_instance!~"api"
Wildcard regular expressionRejectedvcluster_platform_instance=~".*"

Descriptive labels can use normal PromQL matcher forms because they don't determine authorization scope.

Label examples​

Tenant cluster metric:

vcluster_platform_project="team-a"
vcluster_platform_instance="api"
vcluster_platform_hosted_on="local-cluster"
vcluster_platform_placement="hosted"
vcluster_platform_shape="shared_nodes"

Control plane cluster metric:

vcluster_platform_cluster="local-cluster"

Private-nodes tenant cluster metric:

vcluster_platform_project="gpu-team"
vcluster_platform_instance="inference"
vcluster_platform_hosted_on="local-cluster"
vcluster_platform_placement="hosted"
vcluster_platform_shape="private_nodes"
vcluster_platform_node_management="auto"

Migration from older labels​

Aggregating metrics and Fleet monitoring with OpenTelemetry predate the Fleet Observability gateway and use their own self-reported label schemes. These aren't migrations in the sense of a renamed field. The authenticated vcluster_platform_* labels come from a different collection and authorization model, so some older labels have no direct equivalent. Prefer vcluster_platform_* for anything going through the Fleet Observability gateway.

Older labelSource guideMeaningvcluster_platform_* equivalent
clusterFleet monitoring with OpenTelemetryControl plane cluster hosting the tenant cluster (this guide's pipeline always pairs it with tenant identity)vcluster_platform_hosted_on. vcluster_platform_cluster is reserved for cluster-scoped metrics with no tenant identity, which this guide's pipeline doesn't produce.
vcluster_nameFleet monitoring with OpenTelemetryTenant cluster namevcluster_platform_instance
vcluster_projectFleet monitoring with OpenTelemetryProjectvcluster_platform_project
vcluster_project_namespaceFleet monitoring with OpenTelemetryNamespace backing the tenant clusterNo direct equivalent — the gateway doesn't expose the backing namespace as a scope label
vcluster_userFleet monitoring with OpenTelemetryTenant cluster ownerNo direct equivalent — not part of the authenticated scope model
vcluster_virtual_namespaceFleet monitoring with OpenTelemetryNamespace as seen inside the tenant clusterNo direct equivalent
vcluster_virtual_podFleet monitoring with OpenTelemetryPod as seen inside the tenant clusterNo direct equivalent
loft_project_nameAggregating MetricsProjectvcluster_platform_project
loft_virtualcluster_nameAggregating MetricsTenant cluster namevcluster_platform_instance
loft_space_nameAggregating MetricsSpace name (Space-type tenants only)No direct equivalent

For the status and operational ownership of each architecture, see Fleet metrics architectures.