Skip to main content

MCPTelemetryConfig

MCPTelemetryConfig defines telemetry settings that can be shared across multiple MCP workloads. MCPServer, MCPRemoteProxy, and VirtualMCPServer reference a single MCPTelemetryConfig to emit traces and metrics to a common backend.

API: toolhive.stacklok.dev/v1alpha1 · Scope: Namespaced · Short names: mcpotel

Example​

mcptelemetryconfig.yaml
apiVersion: toolhive.stacklok.dev/v1alpha1
kind: MCPTelemetryConfig
metadata:
  name: my-mcptelemetryconfig
  namespace: default
spec: {}

Schema​

spec​

MCPTelemetryConfigSpec defines the desired state of MCPTelemetryConfig. The spec uses a nested structure with openTelemetry and prometheus sub-objects for clear separation of concerns.

FieldTypeDescription
openTelemetryobject

OpenTelemetry defines OpenTelemetry configuration (OTLP endpoint, tracing, metrics)

prometheusobject

Prometheus defines Prometheus-specific configuration

spec.openTelemetry​

OpenTelemetry defines OpenTelemetry configuration (OTLP endpoint, tracing, metrics)

FieldTypeDescription
caBundleRefobject

CABundleRef references a ConfigMap containing a CA certificate bundle for the OTLP endpoint. When specified, the operator mounts the ConfigMap into the proxyrunner pod and configures the OTLP exporters to trust the custom CA. This is useful when the OTLP collector uses TLS with certificates signed by an internal or private CA.

enabledboolean

Enabled controls whether OpenTelemetry is enabled


default false
endpointstring

Endpoint is the OTLP endpoint URL for tracing and metrics

headersmap<string, string>

Headers contains authentication headers for the OTLP endpoint. For secret-backed credentials, use sensitiveHeaders instead.

insecureboolean

Insecure indicates whether to use HTTP instead of HTTPS for the OTLP endpoint


default false
metricsobject

Metrics defines OpenTelemetry metrics-specific configuration

resourceAttributesmap<string, string>

ResourceAttributes contains custom resource attributes to be added to all telemetry signals. These become OTel resource attributes (e.g., deployment.environment, service.namespace). Note: service.name is intentionally excluded — it is set per-server via MCPTelemetryConfigReference.ServiceName.

sensitiveHeadersobject[]

SensitiveHeaders contains headers whose values are stored in Kubernetes Secrets. Use this for credential headers (e.g., API keys, bearer tokens) instead of embedding secrets in the headers field.

tracingobject

Tracing defines OpenTelemetry tracing configuration

useLegacyAttributesboolean

UseLegacyAttributes controls whether legacy attribute names are emitted alongside the new MCP OTEL semantic convention names. Defaults to true for backward compatibility. This will change to false in a future release and eventually be removed.


default true
↑ Back to spec
spec.openTelemetry.caBundleRef​

CABundleRef references a ConfigMap containing a CA certificate bundle for the OTLP endpoint. When specified, the operator mounts the ConfigMap into the proxyrunner pod and configures the OTLP exporters to trust the custom CA. This is useful when the OTLP collector uses TLS with certificates signed by an internal or private CA.

FieldTypeDescription
configMapRefobject

ConfigMapRef references a ConfigMap containing the CA certificate bundle. If Key is not specified, it defaults to "ca.crt".

↑ Back to spec.openTelemetry
spec.openTelemetry.caBundleRef.configMapRef​

ConfigMapRef references a ConfigMap containing the CA certificate bundle. If Key is not specified, it defaults to "ca.crt".

FieldTypeDescription
keyrequiredstring

The key to select.

namestring

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names


default ""
optionalboolean

Specify whether the ConfigMap or its key must be defined

↑ Back to spec.openTelemetry.caBundleRef
spec.openTelemetry.metrics​

Metrics defines OpenTelemetry metrics-specific configuration

FieldTypeDescription
enabledboolean

Enabled controls whether OTLP metrics are sent


default false
↑ Back to spec.openTelemetry
spec.openTelemetry.sensitiveHeaders[]​

SensitiveHeaders contains headers whose values are stored in Kubernetes Secrets. Use this for credential headers (e.g., API keys, bearer tokens) instead of embedding secrets in the headers field.

FieldTypeDescription
namerequiredstring

Name is the header name (e.g., "Authorization", "X-API-Key")


minLength 1
secretKeyRefrequiredobject

SecretKeyRef is a reference to a Kubernetes Secret key containing the header value

↑ Back to spec.openTelemetry
spec.openTelemetry.sensitiveHeaders.secretKeyRef​

SecretKeyRef is a reference to a Kubernetes Secret key containing the header value

FieldTypeDescription
keyrequiredstring

Key is the key within the secret

namerequiredstring

Name is the name of the secret

↑ Back to spec.openTelemetry.sensitiveHeaders
spec.openTelemetry.tracing​

Tracing defines OpenTelemetry tracing configuration

FieldTypeDescription
enabledboolean

Enabled controls whether OTLP tracing is sent


default false
samplingRatestring

SamplingRate is the trace sampling rate (0.0-1.0)


default "0.05" · pattern ^(0(\.\d+)?|1(\.0+)?)$
↑ Back to spec.openTelemetry

spec.prometheus​

Prometheus defines Prometheus-specific configuration

FieldTypeDescription
enabledboolean

Enabled controls whether Prometheus metrics endpoint is exposed


default false
↑ Back to spec

status​

MCPTelemetryConfigStatus defines the observed state of MCPTelemetryConfig

FieldTypeDescription
conditionsobject[]

Conditions represent the latest available observations of the MCPTelemetryConfig's state

configHashstring

ConfigHash is a hash of the current configuration for change detection

observedGenerationinteger

ObservedGeneration is the most recent generation observed for this MCPTelemetryConfig.


format int64
referencingWorkloadsobject[]

ReferencingWorkloads lists workloads that reference this MCPTelemetryConfig

status.conditions[]​

Conditions represent the latest available observations of the MCPTelemetryConfig's state

FieldTypeDescription
lastTransitionTimerequiredstring

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.


format date-time
messagerequiredstring

message is a human readable message indicating details about the transition. This may be an empty string.


maxLength 32768
observedGenerationinteger

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.


format int64 · min 0
reasonrequiredstring

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.


pattern ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ · minLength 1 · maxLength 1024
statusrequiredstring

status of the condition, one of True, False, Unknown.


enum: True | False | Unknown
typerequiredstring

type of condition in CamelCase or in foo.example.com/CamelCase.


pattern ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$ · maxLength 316
↑ Back to status

status.referencingWorkloads[]​

ReferencingWorkloads lists workloads that reference this MCPTelemetryConfig

FieldTypeDescription
kindrequiredstring

Kind is the type of workload resource


enum: MCPServer | VirtualMCPServer | MCPRemoteProxy
namerequiredstring

Name is the name of the workload resource


minLength 1
↑ Back to status

Referenced by: