Observability Descriptor reference
Akka Observability descriptor
An Akka observability descriptor describes how metrics, logs, and traces are exported to third party services. It is used by the akka project observability apply command. Exporters can be optionally defined as default exporter, meaning it will be used for the metrics, logs, and traces, but can then be optionally overridden for each of metrics, logs, and traces.
| Field | Type | Description |
|---|---|---|
exporters |
The default exporters used for metrics, logs, and traces. Will be used for each unless a respective exporter in |
|
metrics |
The exporters to use for metrics. Overrides the exporters defined in |
|
logs |
The exporters to use for logs. Overrides the exporters defined in |
|
traces |
The exporters to use for traces. Overrides the exporters defined in |
|
heapDump |
Heap dump export configuration. |
|
traceSampling |
Trace sampling configuration. Applies to all trace exporters. |
|
logLevel |
string |
Log level for the OpenTelemetry collector. Valid values are |
ObservabilityDefault
The default exporter configuration for metrics, logs, and traces. At most one default exporter may be configured.
| Field | Type | Description |
|---|---|---|
kalixConsole |
object |
If defined, metrics will be exported to the Akka Console. There are no configuration parameters for the console exporter, it should be declared as an empty object. |
otlp |
If defined, will export metrics, logs, and traces to an OpenTelemetry collector using the OTLP gRPC protocol. |
|
otlpHttp |
If defined, will export metrics, logs, and traces to an OpenTelemetry collector using the OTLP HTTP protocol. |
|
splunkHec |
If defined, will export metrics and logs to a Splunk platform instance, using the Splunk HTTP Event Collector. |
|
googleCloud |
If defined, will export metrics, logs, and traces to Google Cloud. |
|
azureMonitor |
If defined, will export metrics, logs, and traces to Azure Monitor. |
ObservabilityMetrics
The metrics exporter configuration. At most one metrics exporter may be configured. If a default exporter is configured, the exporter configured here will override that exporter for metrics.
| Field | Type | Description |
|---|---|---|
kalixConsole |
object |
If defined, metrics will be exported to the Akka Console. There are no configuration parameters for the console exporter, it should be declared as an empty object. |
otlp |
If defined, will export metrics to an OpenTelemetry collector using the OTLP gRPC protocol. |
|
otlpHttp |
If defined, will export metrics to an OpenTelemetry collector using the OTLP HTTP protocol. |
|
prometheuswrite |
If defined, will export metrics using the Prometheus remote write protocol. |
|
splunkHec |
If defined, will export metrics to a Splunk platform instance, using the Splunk HTTP Event Collector. |
|
googleCloud |
If defined, will export metrics to Google Cloud. |
|
azureMonitor |
If defined, will export metrics to Azure Monitor. |
See the metrics reference for a list of the available metrics that will be exported.
ObservabilityTraces
The traces exporter configuration. At most one traces exporter may be configured. If a default exporter is configured, the exporter configured here will override the default exporter for traces.
| Field | Type | Description |
|---|---|---|
kalixConsole |
object |
If defined, traces will be exported to the Akka Console. There are no configuration parameters for the console exporter, it should be declared as an empty object. |
otlp |
If defined, will export traces to an OpenTelemetry collector using the OTLP gRPC protocol. |
|
otlpHttp |
If defined, will export traces to an OpenTelemetry collector using the OTLP HTTP protocol. |
|
googleCloud |
If defined, will export traces to Google Cloud. |
|
azureMonitor |
If defined, will export traces to Azure Monitor. |
ObservabilityLogs
The logs exporter configuration. At most one logs exporter may be configured. If a default exporter is configured, the exporter configured here will override that exporter for logs.
| Field | Type | Description |
|---|---|---|
otlp |
If defined, will export logs to an OpenTelemetry collector using the OTLP gRPC protocol. |
|
otlpHttp |
If defined, will export logs to an OpenTelemetry collector using the OTLP HTTP protocol. |
|
splunkHec |
If defined, will export logs to a Splunk platform instance, using the Splunk HTTP Event Collector. |
|
googleCloud |
If defined, will export logs to Google Cloud. |
|
azureMonitor |
If defined, will export logs to Azure Monitor. |
ObservabilityOtlp
Configuration for an OpenTelemetry exporter using the OTLP gRPC protocol.
| Field | Type | Description |
|---|---|---|
endpoint |
string required |
The endpoint to export OTLP metrics, logs, or traces to, for example, |
tls |
TLS configuration for connections to the OpenTelemetry collector. |
|
headers |
A list of headers to add to outgoing requests. |
ObservabilityPrometheusWrite
Configuration for a Prometheus exporter using the Prometheus remote write protocol.
| Field | Type | Description |
|---|---|---|
endpoint |
string required |
The URL to export Prometheus remote write metrics to, for example, |
tls |
TLS configuration for connections to the Prometheus remote write endpoint. |
|
headers |
A list of headers to add to outgoing requests. |
ObservabilitySplunkHec
Configuration for a Splunk HEC exporter to export to Splunk Platform instance using the Splunk HTTP Event Collector.
| Field | Type | Description |
|---|---|---|
endpoint |
string required |
The URL to export Prometheus remote write metrics to, for example, |
tokenSecret |
SecretKeyRef required |
A reference to the secret and key containing the Splunk HTTP Event Collector. |
source |
string |
The Splunk source. Identifies the source of an event, that is, where the event originated. In the case of data monitored from files and directories, the source consists of the full pathname of the file or directory. In the case of a network-based source, the source field consists of the protocol and port, such as UDP:514. |
sourceType |
string |
The Splunk source type. Identifies the data structure of an event. A source type determines how the Splunk platform formats the data during the indexing process. Example source types include |
index |
string |
The splunk index, optional name of the Splunk index targeted. |
tls |
TLS configuration for connections to the Splunk HTTP Event Collector. |
ObservabilityGoogleCloud
Configuration for a Google Cloud exporter.
| Field | Type | Description |
|---|---|---|
serviceAccountKeySecret |
ObjectRef required |
A secret containing a Google service account JSON key, in a property called The service account used must have the |
ObservabilityAzureMonitor
Configuration for an Azure Monitor exporter.
| Field | Type | Description |
|---|---|---|
connectionString |
string required |
The Azure Monitor connection string, obtained from your Application Insights resource in the Azure portal. |
ObservabilityOtlpHttp
Configuration for an OpenTelemetry exporter using the OTLP HTTP protocol.
| Field | Type | Description |
|---|---|---|
endpointBaseUrl |
string required |
The base URL to export OTLP metrics, logs, or traces to, for example, |
encoding |
string |
The encoding to use, either |
tls |
TLS configuration for connections to the OpenTelemetry collector. |
|
headers |
A list of headers to add to outgoing requests. |
ObservabilityTls
Configuration for TLS connections to various exporters.
| Field | Type | Description |
|---|---|---|
insecure |
boolean |
If true, will not use TLS. Defaults to false. |
insecureSkipVerify |
boolean |
If true, will not verify the certificate presented by the server it connects to. Has no effect if |
clientCertSecret |
If configured, will use the TLS secret as a client certificate to authenticate outgoing connections to the server with. |
|
caSecret |
If configured, will use the certificate chain defined in the TLS CA secret to verify the server certificate provided by the server. |
ObservabilityHeader
Configuration for a header. Only one value field may be defined.
| Field | Type | Description |
|---|---|---|
name |
string |
The name of the header. |
value |
string |
The value for the header. Either this, or |
valueFrom |
The source of the value for the header. Either this, or |
ObservabilityHeaderSource
The source for a header value.
| Field | Type | Description |
|---|---|---|
secretKeyRef |
SecretKeyRef required |
A reference to a secret. |
HeapDump
Configuration for exporting heap dumps. Exactly one of aws or platformManaged must be configured.
| Field | Type | Description |
|---|---|---|
aws |
If defined, heap dumps will be exported to an AWS S3 bucket. |
|
platformManaged |
If defined, heap dumps will be stored using platform-managed storage. Not available in all regions. |
HeapDumpAws
Configuration for exporting heap dumps to an AWS S3 bucket.
| Field | Type | Description |
|---|---|---|
bucket |
string required |
The S3 bucket to store heap dumps in. |
region |
string required |
The AWS region of the bucket. |
pathPrefix |
string |
An optional prefix to prepend to the name of the stored object. |
concurrentUploads |
integer |
The maximum number of concurrent uploads. Defaults to |
credentialsSecretRef |
If set, will use the configured credentials to access AWS. Either this or |
|
workloadIdentity |
If set, will use workload identity to access AWS. Either this or |
HeapDumpPlatformManaged
Configuration for platform-managed heap dump storage. Not available in all regions.
| Field | Type | Description |
|---|---|---|
pathPrefix |
string |
An optional prefix to prepend to the name of the stored object. |
HeapDumpAwsWorkloadIdentity
Configuration for using AWS workload identity for heap dump uploads.
| Field | Type | Description |
|---|---|---|
roleArnOverride |
string |
If set, overrides the Role ARN configured on the service. |
HeapDumpCredentialSecretReference
References to secrets containing AWS credentials for heap dump uploads.
| Field | Type | Description |
|---|---|---|
awsAccessKeyId |
A reference to the secret and key containing the AWS access key ID. |
|
awsSecretAccessKey |
A reference to the secret and key containing the AWS secret access key. |
TraceSampling
Trace sampling configuration. Applies to all trace exporters.
| Field | Type | Description |
|---|---|---|
probabilistic |
If defined, enables probabilistic (percentage-based) sampling of traces. |
ProbabilisticSampling
Configuration for probabilistic trace sampling.
| Field | Type | Description |
|---|---|---|
percentage |
string |
The percentage of traces to sample. For example, |