Skip to main content
Version: 1.16

Query API Traces

Query API (Apollo) provides querying capabilities for Kubernetes resources across multiple Crossplane control planes.

For common tracing configuration, see the distributed tracing overview.

Overview

Service name: spaces-apollo

Each request generates three span types:

  • Router ingress (routes to Apollo cluster)
  • Apollo HTTP (processes query)
  • PostgreSQL (executes SQL)

Architecture

Requests flow through Spaces Router to Apollo:

Client → Spaces Router → Apollo (Query API) → PostgreSQL
│ │ │ │
└───────────────────────────────────────────────→ Single Trace

Each request produces four spans:

  1. Router ingress - Envoy routes to spaces-apollo cluster
  2. Auth check - External authorization validates request
  3. Apollo HTTP - Query API processes request (service.name: spaces-apollo)
  4. PostgreSQL - Database executes SQL

Enabling tracing

Configure Query API tracing via Helm values:

apollo:
apollo:
observability:
enabled: true
tracing:
enabled: true
endpoint: "telemetry-spaces-collector.upbound-system.svc.cluster.local"
insecure: false
port: 4317
sampling:
rate: 0.1 # 10%
tls:
caBundleSecretRef: spaces-ca

Custom tags

Apollo spans

Apollo exports spans with service.name: query-api and includes:

AttributeDescriptionExample Value
http.request.methodHTTP methodPOST
url.pathRequest path/apis/query.spaces.upbound.io/v1alpha2/namespaces/default/queries
http.response.status_codeStatus code200
http.request.body.sizeRequest size360
http.response.body.sizeResponse size3702
server.addressServer hostname127.0.0.1
network.peer.addressClient IP192.168.2.11
user_agent.originalUser agentup-cli/v0.40.0 (darwin; arm64)

Database spans

Database spans include PostgreSQL connection pool metrics:

AttributeDescriptionExample Value
db.systemDatabase systempostgresql
db.nameDatabase nameupbound
db.operationOperation typequery
db.statementSQL queryFull SQL statement
db.pool.total_connsTotal connections1
db.pool.idle_connsIdle connections1
db.pool.acquired_connsAcquired connections0