Class KubernetesTelemetryExportOptions
Namespace: Cephalon.Observability.Kubernetes.Configuration
Assembly: Cephalon.Observability.Kubernetes.dll
Configures Kubernetes observability defaults on top of the shared Cephalon telemetry contract.
public sealed class KubernetesTelemetryExportOptionsInheritance
Section titled “Inheritance”object ← KubernetesTelemetryExportOptions
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”KubernetesTelemetryExportOptions()
Section titled “ KubernetesTelemetryExportOptions()”Initializes a new instance of the
public KubernetesTelemetryExportOptions()Properties
Section titled “Properties”ClusterName
Section titled “ ClusterName”Gets or sets the Kubernetes cluster name to stamp onto exported resources.
public string? ClusterName { get; set; }Property Value
Section titled “Property Value”CollectorNamespace
Section titled “ CollectorNamespace”Gets or sets the collector namespace used to build the in-cluster Kubernetes collector endpoint.
public string? CollectorNamespace { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”When omitted, the package falls back to POD_NAMESPACE when
the host runs inside a pod.
CollectorPort
Section titled “ CollectorPort”Gets or sets the collector port used for the in-cluster Kubernetes collector endpoint.
public int? CollectorPort { get; set; }Property Value
Section titled “Property Value”int?
Remarks
Section titled “Remarks”When omitted, the package falls back to 4317 for otlp / otlp/grpc and
4318 for otlp/http.
CollectorScheme
Section titled “ CollectorScheme”Gets or sets the URI scheme used for the in-cluster Kubernetes collector endpoint.
public string? CollectorScheme { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”Supported values are http and https. The default is http.
CollectorServiceName
Section titled “ CollectorServiceName”Gets or sets the collector service name used to build the in-cluster Kubernetes collector endpoint.
public string? CollectorServiceName { get; set; }Property Value
Section titled “Property Value”ContainerName
Section titled “ ContainerName”Gets or sets the container name to stamp onto exported resources.
public string? ContainerName { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”When omitted, the package falls back to the CONTAINER_NAME environment variable when it is available.
Headers
Section titled “ Headers”Gets or sets the raw OTLP headers string added to Kubernetes collector requests.
public string? Headers { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”Use the standard OTLP key=value comma-separated format when a collector, gateway, or route
expects explicit headers.
Namespace
Section titled “ Namespace”Gets or sets the workload namespace to stamp onto exported resources.
public string? Namespace { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”When omitted, the package falls back to the current pod namespace through the POD_NAMESPACE
environment variable when it is available.
NodeName
Section titled “ NodeName”Gets or sets the Kubernetes node name to stamp onto exported resources.
public string? NodeName { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”When omitted, the package falls back to the NODE_NAME environment variable when it is available.
PodName
Section titled “ PodName”Gets or sets the pod name to stamp onto exported resources.
public string? PodName { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”When omitted, the package falls back to POD_NAME and then HOSTNAME when those environment
variables are available.
PodUid
Section titled “ PodUid”Gets or sets the pod UID to stamp onto exported resources.
public string? PodUid { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”When omitted, the package falls back to the POD_UID environment variable when it is available.
ServiceDnsSuffix
Section titled “ ServiceDnsSuffix”Gets or sets the service DNS suffix used to build the in-cluster Kubernetes collector endpoint.
public string? ServiceDnsSuffix { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”The default is svc.cluster.local. Set this when a cluster uses a non-default service DNS suffix.
TrustedCaCertificatePath
Section titled “ TrustedCaCertificatePath”Gets or sets the filesystem path to a trusted CA bundle used for HTTPS OTLP/HTTP traces and metrics against in-cluster or shared Kubernetes collectors.
public string? TrustedCaCertificatePath { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”Because the current OTLP logging exporter does not support custom HttpClient wiring for HTTP,
the package rejects configurations that require this custom CA path for logs. OTLP/gRPC custom CA
wiring is also left explicit and unsupported for now.
UseInClusterCollectorService
Section titled “ UseInClusterCollectorService”Gets or sets a value indicating whether the package should target an in-cluster collector service when no shared endpoint is configured.
public bool UseInClusterCollectorService { get; set; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”FromConfiguration(IConfiguration, string)
Section titled “ FromConfiguration(IConfiguration, string)”Binds Kubernetes telemetry export options from configuration.
public static KubernetesTelemetryExportOptions FromConfiguration(IConfiguration configuration, string sectionPath = "Engine")Parameters
Section titled “Parameters”configuration IConfiguration
The application configuration root.
sectionPath string
The configuration section path that contains the engine settings. The default is Engine.
Returns
Section titled “Returns”KubernetesTelemetryExportOptions
The bound Kubernetes telemetry export options.