Mcptelemetryconfig v1alpha1 — toolhive.stacklok.dev

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object

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

openTelemetry object

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

caBundleRef object

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.

configMapRef object

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

key string required

The key to select.

name string

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

optional boolean

Specify whether the ConfigMap or its key must be defined

enabled boolean

Enabled controls whether OpenTelemetry is enabled

endpoint string

Endpoint is the OTLP endpoint URL for tracing and metrics

headers object

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

insecure boolean

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

metrics object

Metrics defines OpenTelemetry metrics-specific configuration

enabled boolean

Enabled controls whether OTLP metrics are sent

resourceAttributes object

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.

sensitiveHeaders []object

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.

name string required

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

minLength: 1

secretKeyRef object required

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

key string required

Key is the key within the secret

name string required

Name is the name of the secret

tracing object

Tracing defines OpenTelemetry tracing configuration

enabled boolean

Enabled controls whether OTLP tracing is sent

samplingRate string

SamplingRate is the trace sampling rate (0.0-1.0)

pattern: ^(0(\.\d+)?|1(\.0+)?)$

useLegacyAttributes boolean

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.

prometheus object

Prometheus defines Prometheus-specific configuration

enabled boolean

Enabled controls whether Prometheus metrics endpoint is exposed

status object

MCPTelemetryConfigStatus defines the observed state of MCPTelemetryConfig

conditions []object

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

lastTransitionTime string required

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

message string required

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

maxLength: 32768

observedGeneration integer

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

minimum: 0

reason string required

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

status string required

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

enum: True, False, Unknown

type string required

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

configHash string

ConfigHash is a hash of the current configuration for change detection

observedGeneration integer

ObservedGeneration is the most recent generation observed for this MCPTelemetryConfig.

format: int64

referencingWorkloads []object

ReferencingWorkloads lists workloads that reference this MCPTelemetryConfig

kind string required

Kind is the type of workload resource

enum: MCPServer, VirtualMCPServer, MCPRemoteProxy

name string required

Name is the name of the workload resource

minLength: 1