Class OpenShiftTelemetryExportOptions
Namespace: Cephalon.Observability.OpenShift.Configuration
Assembly: Cephalon.Observability.OpenShift.dll
Configures Red Hat OpenShift observability defaults on top of the shared Cephalon telemetry contract.
public sealed class OpenShiftTelemetryExportOptionsInheritance
Section titled “Inheritance”object ← OpenShiftTelemetryExportOptions
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”OpenShiftTelemetryExportOptions()
Section titled “ OpenShiftTelemetryExportOptions()”Initializes a new instance of the
public OpenShiftTelemetryExportOptions()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 OpenShift 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 OpenShift 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 OpenShift 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 OpenShift collector endpoint.
public string? CollectorServiceName { get; set; }Property Value
Section titled “Property Value”Headers
Section titled “ Headers”Gets or sets the raw OTLP headers string added to OpenShift 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.
HostedPlatform
Section titled “ HostedPlatform”Gets or sets the OpenShift deployment target whose hosted defaults should be applied.
public string? HostedPlatform { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”Supported values are openshift, aro, and rosa.
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.
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 OpenShift collectors.
public string? TrustedCaCertificatePath { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”This setting is intended for OpenShift service CAs or other cluster-local trust roots. 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 OpenShift 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 OpenShift telemetry export options from configuration.
public static OpenShiftTelemetryExportOptions 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”OpenShiftTelemetryExportOptions
The bound OpenShift telemetry export options.