otelcol.extensions.gardener.cloud.md

API Reference

Packages

• otelcol.extensions.gardener.cloud/v1alpha1

otelcol.extensions.gardener.cloud/v1alpha1

Package v1alpha1 provides the v1alpha1 version of the external API types.

CollectorConfigSpec

CollectorConfigSpec specifies the desired state of [CollectorConfig]

Appears in:

• CollectorConfig

Field	Description	Default	Validation
targets Target array	Targets is a list of collector destinations. Each target consists of a self-contained exporter and the signals it receives.		Required: {}
logs CollectorLogsConfig	Logs specifies the settings for the collector logs.		Optional: {}
metrics CollectorMetricsConfig	Metrics specifies the settings for the internal collector metrics.		Optional: {}

CollectorExportersConfig

CollectorExportersConfig provides the OTLP exporter settings.

Appears in:

• Target

Field	Description	Default	Validation
otlp_grpc OTLPGRPCExporterConfig	OTLPGRPCExporter provides the OTLP gRPC Exporter settings.		Optional: {}
otlp_http OTLPHTTPExporterConfig	OTLPHTTPExporter provides the OTLP HTTP Exporter settings.		Optional: {}
debug DebugExporterConfig	DebugExporter provides the settings for the debug exporter.		Optional: {}

CollectorLogsConfig

CollectorLogsConfig provides the settings for the collector internal logs.

See Configure internal logs for more details.

Appears in:

• CollectorConfigSpec

Field	Description	Default	Validation
level LogLevel	Level specifies the log level of the collector.		Optional: {}
encoding LogEncoding	Encoding specifies the encoding for logs of the collector.		Optional: {}

CollectorMetricsConfig

CollectorMetricsConfig provides the settings for the collector internal metrics.

See Metrics verbosity for more details.

Appears in:

• CollectorConfigSpec

Field	Description	Default	Validation
level MetricsVerbosityLevel	Level specifies the collector internal metrics verbosity level.		Optional: {}

Compression

Underlying type: string

Compression specifies the compression used by the collector.

Appears in:

• OTLPGRPCExporterConfig
• OTLPHTTPExporterConfig

Field	Description
gzip	CompressionGzip specifies that gzip compression is used.
zstd	CompressionZstd specifies that zstd compression is used.
snappy	CompressionSnappy specifies that snappy compression is used.
none	CompressionNone specifies that no compression is used.

DebugExporterConfig

DebugExporterConfig provides the settings for the debug exporter

Appears in:

• CollectorExportersConfig

Field	Description	Default	Validation
verbosity DebugExporterVerbosity	Verbosity specifies the verbosity level for the debug exporter.		Optional: {}

DebugExporterVerbosity

Underlying type: string

DebugExporterVerbosity specifies the verbosity level for the debug exporter.

Appears in:

• DebugExporterConfig

Field	Description
basic	DebugExporterVerbosityBasic specifies basic level of verbosity.
normal	DebugExporterVerbosityNormal specifies normal level of verbosity.
detailed	DebugExporterVerbosityDetailed specifies detailed level of verbosity.

LogEncoding

Underlying type: string

LogEncoding specifies the encoding for the internal collector logger.

See the link below for more details.

https://opentelemetry.io/docs/collector/internal-telemetry/#configure-internal-logs

Appears in:

• CollectorLogsConfig

Field	Description
console	LogEncodingConsole sets the collector's internal logger with console encoding.
json	LogEncodingJSON sets the collector's internal logger with JSON encoding.

LogLevel

Underlying type: string

LogLevel specifies the minimum enabled logging level for the collector.

See the link below for more details.

https://opentelemetry.io/docs/collector/internal-telemetry/#configure-internal-logs

Appears in:

• CollectorLogsConfig

Field	Description
INFO	LogLevelInfo sets the collector's internal logger to INFO level.
WARN	LogLevelWarn sets the collector's internal logger to WARN level.
ERROR	LogLevelError sets the collector's internal logger to ERROR level.
DEBUG	LogLevelDebug sets the collector's internal logger to DEBUG level.

MessageEncoding

Underlying type: string

MessageEncoding specifies the encoding used by the collector exporters.

Appears in:

• OTLPHTTPExporterConfig

Field	Description
proto	MessageEncodingProto specifies that proto encoding is used for messages.
json	MessageEncodingJSON specifies that JSON is used for encoding messages.

MetricsVerbosityLevel

Underlying type: string

MetricsVerbosityLevel specifies the verbosity of the internal collector metrics.

See the link below for more details.

https://opentelemetry.io/docs/collector/internal-telemetry/#metric-verbosity

Appears in:

• CollectorMetricsConfig

Field	Description
none	MetricsVerbosityLevelNone disables the internal collector metrics.
basic	MetricsVerbosityLevelBasic configures the collector to emit basic metrics only.
normal	MetricsVerbosityLevelNormal configures the collector with standard indicators on top of the basic ones.
detailed	MetricsVerbosityLevelDetailed configures the collector with the most verbose level, which includes dimensions and views.

OTLPGRPCExporterConfig

OTLPGRPCExporterConfig provides the OTLP gRPC Exporter config settings.

See OTLP gRPC Exporter for more details.

Appears in:

• CollectorExportersConfig

Field	Description	Default	Validation
endpoint string	Endpoint specifies the gRPC endpoint to which signals will be exported. Check the link below for more details about the format of this field. https://github.com/grpc/grpc/blob/master/doc/naming.md		Required: {}
tls TLSConfig	TLS specifies the TLS configuration settings for the exporter.		Optional: {}
token ResourceReference	Token references a bearer token for authentication.
timeout Duration	Timeout specifies the time to wait per individual attempt to send data to the backend.		Optional: {}
read_buffer_size integer	ReadBufferSize specifies the ReadBufferSize for the gRPC client. Default value is [DefaultGRPCExporterClientReadBufferSize].		Optional: {}
write_buffer_size integer	WriteBufferSize specifies the WriteBufferSize for the gRPC client. Default value is [DefaultGRPCExporterClientWriteBufferSize].		Optional: {}
retry_on_failure RetryOnFailureConfig	RetryOnFailure specifies the retry policy of the exporter.		Optional: {}
compression Compression	Compression specifies the compression to use. The default value is [CompressionGzip].		Optional: {}

OTLPHTTPExporterConfig

OTLPHTTPExporterConfig provides the OTLP HTTP Exporter configuration settings.

See OTLP HTTP Exporter for more details.

Appears in:

• CollectorExportersConfig

Field	Description	Default	Validation
endpoint string	Endpoint specifies the target base URL to send data to, e.g. https://example.com:4318 To send each signal a corresponding path will be added to this base URL, i.e. for metrics "/v1/metrics" will be appended, for logs "/v1/logs" will be appended.		Optional: {}
tls TLSConfig	TLS specifies the TLS configuration settings for the exporter.		Optional: {}
token ResourceReference	Token references a bearer token for authentication.		Optional: {}
timeout Duration	Timeout specifies the HTTP request time limit. Default value is [DefaultHTTPExporterClientTimeout].		Optional: {}
read_buffer_size integer	ReadBufferSize specifies the ReadBufferSize for the HTTP client. Default value is [DefaultHTTPExporterClientReadBufferSize].		Optional: {}
write_buffer_size integer	WriteBufferSize specifies the WriteBufferSize for the HTTP client. Default value is [DefaultHTTPExporterClientWriteBufferSize].		Optional: {}
encoding MessageEncoding	Encoding specifies the encoding to use for the messages. The default value is [MessageEncodingProto].		Optional: {}
retry_on_failure RetryOnFailureConfig	RetryOnFailure specifies the retry policy of the exporter.		Optional: {}
compression Compression	Compression specifies the compression to use. The default value is [CompressionGzip].		Optional: {}

ResourceReference

ResourceReference references data from a Secret.

Appears in:

• OTLPGRPCExporterConfig
• OTLPHTTPExporterConfig
• TLSConfig

Field	Description	Default	Validation
resourceRef ResourceReferenceDetails	ResourceRef references a resource in the shoot.		Required: {}

ResourceReferenceDetails

ResourceReferenceDetails references a resource (e.g., a Secret) in the garden cluster.

Appears in:

• ResourceReference

Field	Description	Default	Validation
name string	Name is the name of thresource e reference in .spec.resources in the Shoot resource.		Required: {}
dataKey string	DataKey is the key in the resource data map.		Required: {}

RetryOnFailureConfig

RetryOnFailureConfig provides the retry policy for an exporter.

Appears in:

• OTLPGRPCExporterConfig
• OTLPHTTPExporterConfig

Field	Description	Default	Validation
enabled boolean	Enabled specifies whether retry on failure is enabled or not. Default is true.	true	Optional: {}
initial_interval Duration	InitialInterval specifies the time to wait after the first failure before retrying. The default value is [DefaultRetryInitialInterval].		Optional: {}
max_interval Duration	MaxInterval specifies the upper bound on backoff. Default value is [DefaultRetryMaxInterval].		Optional: {}
max_elapsed_time Duration	MaxElapsedTime specifies the maximum amount of time spent trying to send a batch. If set to 0, the retries are never stopped. The default value is [DefaultRetryMaxElapsedTime].		Optional: {}
multiplier float	Multiplier specifies the factor by which the retry interval is multiplied on each attempt. The default value is [DefaultRetryMultiplier].		Optional: {}

SignalType

Underlying type: string

SignalType identifies a telemetry signal the collector can collect and export.

Appears in:

• Target

Field	Description
logs	SignalLogs is the signal for logs received via OTLP.
events	SignalEvents is the signal for Kubernetes events collected from the shoot cluster.
metrics	SignalMetrics is the signal for metrics scraped via Prometheus.

TLSConfig

TLSConfig provides the TLS settings used by exporters.

Appears in:

• OTLPGRPCExporterConfig
• OTLPHTTPExporterConfig

Field	Description	Default	Validation
insecureSkipVerify boolean	InsecureSkipVerify specifies whether to skip verifying the certificate or not.	false	Optional: {}
ca ResourceReference	CA references the CA certificate to use for verifying the server certificate. For a client this verifies the server certificate. For a server this verifies client certificates. If empty uses system root CA.		Optional: {}
cert ResourceReference	Cert references the client certificate to use for TLS required connections.		Optional: {}
key ResourceReference	Key references the client key to use for TLS required connections.		Optional: {}
reloadInterval Duration	ReloadInterval specifies mTLS key and cert reload interval from mounted secret volume		Optional: {}

Target

Target consists of exporter configurations for signals.

Appears in:

• CollectorConfigSpec

Field	Description	Default	Validation
exporter CollectorExportersConfig	Exporters specifies the exporters configuration of the collector.		Required: {}
signals SignalType array	Signals lists the telemetry signals the collector should collect and export. Valid values are "logs", "events" and "metrics". If empty, all signals are enabled.		Optional: {}