Skip to main content

types.TelemetryConfig

authentication object

Optional authentication configuration for telemetry exporters

namespacestring

Namespace is used to group telemetry data for all nodes in a namespace

tokenstring

Token is the authentication token or password

typestring

Type represents the authentication type, currently only supports "Basic"

do_not_trackboolean

DoNotTrack disables telemetry collection (default: false, meaning telemetry is enabled)

endpointstring

Endpoint is the telemetry collector endpoint and should not include a path, use EndpointPath for that. Examples: "localhost:4317", "https://collector.example.com:4318"

endpoint_pathstring

Some endpoints have a path under which they serve /v1/metrics or similar, but this cannot be included in Endpoint directly.

export_intervalinteger<int64>

ExportInterval is how often metrics are exported (default: 30s)

Possible values: [-9223372036854776000, 9223372036854776000, 1, 1000, 1000000, 1000000000, 60000000000, 3600000000000]

headers object

Headers are optional headers for authentication

property name*string
include_go_metricsboolean

IncludeGoMetrics enables collection of Go runtime metrics (GC, goroutines, etc.)

insecureboolean

Insecure disables TLS verification (for development/testing)

process_metrics_intervalinteger<int64>

ProcessMetricsInterval is how often process metrics are collected (default: 15s) Process metrics (CPU, memory, file descriptors) are always enabled

Possible values: [-9223372036854776000, 9223372036854776000, 1, 1000, 1000000, 1000000000, 60000000000, 3600000000000]

protocolstring

Protocol specifies the export protocol: "grpc" or "http"

resource_attributes object

ResourceAttributes are additional attributes to include with all telemetry data

property name*string
types.TelemetryConfig
{
"authentication": {
"namespace": "string",
"token": "string",
"type": "string"
},
"do_not_track": true,
"endpoint": "string",
"endpoint_path": "string",
"export_interval": -9223372036854776000,
"headers": {},
"include_go_metrics": true,
"insecure": true,
"process_metrics_interval": -9223372036854776000,
"protocol": "string",
"resource_attributes": {}
}