This module provides an extension for the OpenTelemetry Java Agent. The extension scans the service bindings of an application for SAP Collector as a Service (CaaS), SAP Cloud Logging and Dynatrace. If such a binding is found, the OpenTelemetry Java Agent is configured to ship observability data to those services. Thus, this extension provides a convenient auto-instrumentation for Java applications running on SAP BTP.
Note: CaaS is an SAP internal only service. The service bindings supported by this extension (v1) are no longer created. CaaS support is deprecated as of version 4.3.0 and will be removed in a future release.
The extension provides the following main features:
- auto-configuration of the generic OpenTelemetry OTLP exporter to SAP Collector as a Service (CaaS) or SAP Cloud Logging
- additional exporters for logs, metrics and traces for SAP Cloud Logging
- additional exporter for metrics for Dynatrace
- generic
vcap-serviceexporter for logs, metrics and traces to any OTLP-compatible endpoint configured via a CF service binding - adding resource attributes describing the CF application
- filtering span attributes by name before export
See the section on configuration for further details.
Any Java application can be instrumented with the OpenTelemetry Java Agent and this extension by adding the following arguments to the java command:
java -javaagent:/path/to/opentelemetry-javaagent-<version>.jar \
-Dotel.javaagent-extensions=/path/to/cf-java-logging-support-opentelemetry-agent-extension-<version>.jar \
# your Java application commandIf you are using Spring Boot, you can bundle both dependencies with the application. See the Maven pom of the Spring Boot sample application for details. When deployed to a Cloud Foundry runtime environment, the Spring Boot jar is expanded, so that the agent and extension jar are available during application start. In that case, the following Java arguments are required:
java -javaagent:BOOT-INF/lib/opentelemetry-javaagent-<version>.jar \
-Dotel.javaagent.extensions=BOOT-INF/lib/cf-java-logging-support-opentelemetry-agent-extension-<version>.jar \
# your Java application commandYou need to use the OpenTelemetry Java Agent version this extension was built against to avoid compatibility issues.
See the example manifest, how this translates into a deployment description.
Once the agent is attached to the JVM with the extension in place, the default otlp exporter is automatically configured based on available service bindings:
- CaaS Service Binding (preferred): If a CaaS service binding is found, the
otlpexporter sends data to the CaaS endpoint. - Cloud Logging Service Binding (fallback): If no CaaS binding exists, the
otlpexporter sends data to Cloud Logging.
This means metrics and traces are automatically exported without additional configuration when either service is bound. The recommended way to export data to Cloud Logging and Dynatrace is to use the provided exporters explicitly. This can be achieved via system properties or environment variables:
-Dotel.logs.exporter=cloud-logging \
-Dotel.metrics.exporter=cloud-logging,dynatrace \
-Dotel.traces.exporter=cloud-logging
#or
export OTEL_LOGS_EXPORTER=cloud-logging
export OTEL_METRICS_EXPORTER=cloud-logging,dynatrace
export OTEL_TRACES_EXPORTER=cloud-logging
java #...For the instrumentation to send observability data to SAP Cloud Logging or Dynatrace, the application needs to be bound to a corresponding service instances. The service instances can be either managed or user-provided.
The OpenTelemetry Java Agent supports a wide variety of configuration options. As the extension provides configuration via SPI, all its configuration takes lower precedence than other configuration options for OpenTelemetry. Users can easily overwrite any setting using environment variables or system properties. The full list of configuration properties provided by the extension is available in the Configuration Properties Summary section.
The extension needs to be started with the OpenTelemetry Java Agent as outlined in the Quick Start Guide.
You need to enable shipping data either by using the cloud-logging exporters for each signal type or dynatrace for metrics explicitly.
Multiple different exporters can be configured with comma separation.
Using the custom cloud-logging exporter enables you, to use the default otlp exporter for different services.
Note, that the cloud-logging and dynatrace exporters are just facades for the otlp exporter to allow configuration of multiple data sinks.
There is no custom network client provided by this extension.
Note: This section describes configuration options introduced with version 4.1.0 of the extension. Earlier versions use different property names, which are still supported as fallback. They will create warning messages during initialization as those properties are deprecated for removal.
The extension itself can be configured by specifying the following system properties:
| Property | Description | Default Value |
|---|---|---|
sap.caas.cf.binding.label.value |
Deprecated since 4.3.0. The label of the managed CaaS service binding to bind to. | caas-service |
sap.cloud-logging.cf.binding.label.value |
The label of the managed service binding to bind to. | cloud-logging |
sap.cloud-logging.cf.binding.tag.value |
The tag of any service binding (managed or user-provided) to bind to. | Cloud Logging |
sap.dynatrace.cf.binding.label.value |
The label of the managed service binding to bind to. | dynatrace |
sap.dynatrace.cf.binding.tag.value |
The tag of any service binding (managed or user-provided) to bind to. | dynatrace |
sap.dynatrace.cf.binding.token.name |
The name of the field containing the Dynatrace API token within the service binding credentials. This is required to send metrics to Dynatrace. | |
sap.cloudfoundry.otel.resources.enabled |
Whether to add CF resource attributes to all events. | true |
sap.cloudfoundry.otel.resources.format |
The semantic convention to follow for the CF resource attributes. Supported values are SAP and OTEL. |
SAP |
Each property can also be provided as environment variable, e.g.,
sap.cloud-logging.cf.binding.label.valueasSAP.CLOUD-LOGGING.CF.BINDING.LABEL.VALUE.
The extension scans the VCAP_SERVICES environment variable for CF service bindings in the following order:
- CaaS bindings: Searches for bindings matching the configured label (
sap.caas.cf.binding.label.value, default:caas-service) - Cloud Logging bindings: If no CaaS binding is found, searches for bindings matching the configured label and tag (
sap.cloud-logging.cf.binding.label.valueandsap.cloud-logging.cf.binding.tag.value)
User-provided bindings take precedence over managed bindings.
The first matching binding configures the default OpenTelemetry otlp exporter.
Bindings to Cloud Logging and Dynatrace are also used to configure the respective exporters.
The OpenTelemetry Java Agent offers a lot of configuration options. The following set of properties is recommended to be used with the extension:
java -javaagent:/path/to/opentelemetry-javaagent-<version>.jar \
-Dotel.javaagent-extensions=/path/to/cf-java-logging-support-opentelemetry-agent-extension-<versions>.jar \
# enable logs \
-Dotel.logs.exporter=otlp \
# reroute agent logs to otlp \
-Dotel.javaagent.logging=application
# configure logback context \
-Dotel.instrumentation.logback-appender.experimental.capture-mdc-attributes=* \
-Dotel.instrumentation.logback-appender.experimental.capture-key-value-pair-attributes=true \
-Dotel.instrumentation.logback-appender.experimental.capture-code-attributes=true \
-Dotel.instrumentation.logback-appender.experimental-log-attributes=true \
# Disable large resource attributes
-Dotel.resource.disabled-keys=process.command_line,process.command_args,process.executable.pathThe OpenTelemetry Java Instrumentation project provides detailed documentation on the configuration properties for Logback and Log4j.
This feature was introduced with version 4.1.0 of the extension.
You can filter which metrics are exported to Cloud Logging or Dynatrace by name using the following properties:
| Property | Description |
|---|---|
otel.exporter.cloud-logging.metrics.include.names or otel.exporter.dynatrace.metrics.include.names |
A comma-separated list of metric names to be forwarded. This may include a wildcard "*" at the end of the name. |
otel.exporter.cloud-logging.metrics.exclude.names or otel.exporter.dynatrace.metrics.exclude.names |
A comma-separated list of metric names to be rejected. This may include a wildcard "*" at the end of the name. |
Note, that the include filter is applied before the exclude filter.
That means, if a metric matches both filters, it will be excluded.
The configuration applies to both the cloud-logging and dynatrace exporters independently.
This feature was introduced with version 4.3.0 of the extension.
You can filter which span attributes are exported by name using the following properties:
| Property | Description |
|---|---|
sap.cf.integration.otel.extension.sanitizer.span.attribute.filter.include.names |
A comma-separated list of span attribute name patterns to be included. This may include a wildcard "*" at the end of the name. |
sap.cf.integration.otel.extension.sanitizer.span.attribute.filter.exclude.names |
A comma-separated list of span attribute name patterns to be excluded. This may include a wildcard "*" at the end of the name. |
The filter is only active when the sanitizer is enabled (sap.cf.integration.otel.extension.sanitizer.enabled=true) and at least one of the two properties is set.
The include filter is applied before the exclude filter.
That means, if a span attribute matches both filters, it will be excluded.
The following table summarizes all configuration properties provided by the extension:
| Property | Description | Default Value |
|---|---|---|
otel.exporter.cloud-logging.compression |
The compression algorithm to use when exporting logs. | gzip |
otel.exporter.cloud-logging.timeout |
The maximum duration to wait for Cloud Logging when exporting data. | `10000 (from OTel SDK) |
otel.exporter.cloud-logging.logs.compression |
The compression algorithm to use when exporting logs. Falls back to otel.exporter.cloud-logging.compression if not set. |
gzip (from otel.exporter.cloud-logging.compression) |
otel.exporter.cloud-logging.logs.timeout |
The maximum duration to wait for Cloud Logging when exporting logs. Falls back to otel.exporter.cloud-logging.timeout if not set. |
10000 (from OTel SDK) |
otel.exporter.cloud-logging.metrics.compression |
The compression algorithm to use when exporting metrics. Falls back to otel.exporter.cloud-logging.compression if not set. |
gzip (from otel.exporter.cloud-logging.compression) |
otel.exporter.cloud-logging.metrics.default.histogram.aggregation |
The default histogram aggregation for metrics exported to Cloud Logging. Delegates to the underlying OTLP exporter, supporting all its configurations. | EXPLICIT_BUCKET_HISTOGRAM (from OTel SDK) |
otel.exporter.cloud-logging.metrics.exclude.names |
A comma-separated list of metric name patterns to be excluded when exporting metrics to Cloud Logging. Wildcard "*" is only supported at the end of the name. If not set, no metrics are excluded. | |
otel.exporter.cloud-logging.metrics.include.names |
A comma-separated list of metric name patterns to be included when exporting metrics to Cloud Logging. Wildcard "*" is only supported at the end of the name. If not set, all metrics are exported. | |
otel.exporter.cloud-logging.metrics.temporality.preference |
The preferred aggregation temporality for metrics exported to Cloud Logging. Can be either cumulative, delta, or lowmemory. |
cumulative |
otel.exporter.cloud-logging.metrics.timeout |
The maximum duration to wait for Cloud Logging when exporting metrics. Falls back to otel.exporter.cloud-logging.timeout if not set. |
10000 (from OTel SDK) |
otel.exporter.cloud-logging.traces.compression |
The compression algorithm to use when exporting traces. Falls back to otel.exporter.cloud-logging.compression if not set. |
gzip (from otel.exporter.cloud-logging.compression) |
otel.exporter.cloud-logging.traces.timeout |
The maximum duration to wait for Cloud Logging when exporting traces. Falls back to otel.exporter.cloud-logging.timeout if not set. |
10000 (from OTel SDK) |
otel.exporter.dynatrace.metrics.compression |
The compression algorithm to use when exporting metrics. | gzip |
otel.exporter.dynatrace.metrics.default.histogram.aggregation |
The default histogram aggregation for metrics exported to Dynatrace. Delegates to the underlying OTLP exporter, supporting all its configurations. | EXPLICIT_BUCKET_HISTOGRAM (from OTel SDK) |
otel.exporter.dynatrace.metrics.exclude.names |
A comma-separated list of metric name patterns to be excluded when exporting metrics to Dynatrace. Wildcard "*" is only supported at the end of the name. If not set, no metrics are excluded. | |
otel.exporter.dynatrace.metrics.include.names |
A comma-separated list of metric name patterns to be included when exporting metrics to Dynatrace. Wildcard "*" is only supported at the end of the name. If not set, all metrics are exported. | |
otel.exporter.dynatrace.metrics.temporality.preference |
The default histogram aggregation for metrics exported to Dynatrace. Delegates to the underlying OTLP exporter, supporting all its configurations. The Dynatrace metrics exporter provides an additional option always_delta which always uses delta aggregation temporality. This is also the default behavior if the property is not set. |
always_delta |
otel.exporter.dynatrace.metrics.timeout |
The maximum duration to wait for Dynatrace when exporting metrics. | 10000 (from OTel SDK) |
sap.cf.integration.otel.extension.sanitizer.enabled |
Enables or disables the sanitizer. | true |
sap.cf.integration.otel.extension.sanitizer.span.attribute.filter.exclude.names |
A comma-separated list of span attribute name patterns to be excluded. Wildcard "*" is only supported at the end of the name. If not set, no span attributes are excluded. Requires the sanitizer to be enabled and at least one filter property to be set. | |
sap.cf.integration.otel.extension.sanitizer.span.attribute.filter.include.names |
A comma-separated list of span attribute name patterns to be included. Wildcard "*" is only supported at the end of the name. If not set, all span attributes are included. Requires the sanitizer to be enabled and at least one filter property to be set. | |
sap.cloudfoundry.otel.resources.enabled |
Should Cloud Foundry resource attributes be added to the OpenTelemetry resource? | true |
sap.cloudfoundry.otel.resources.format |
Determines the semantic convention used for Cloud Foundry resource attributes names. SAP - use SAP specific attribute names (default). OTEL - use OpenTelemetry semantic convention attribute names. |
SAP |
sap.cloud-logging.cf.binding.label.value |
The label value used to identify managed Cloud Logging service bindings. | cloud-logging |
sap.cloud-logging.cf.binding.tag.value |
The tag value used to identify managed Cloud Logging service bindings. | Cloud Logging |
sap.dynatrace.cf.binding.label.value |
The label value used to identify managed Dynatrace service bindings. | dynatrace |
sap.dynatrace.cf.binding.tag.value |
The tag value used to identify managed Dynatrace service bindings. | dynatrace |
sap.dynatrace.cf.binding.token.name |
The name of the field containing the Dynatrace API token within the service binding credentials. | |
sap.vcap-service.cf.binding.name |
The name of the CF service binding to use for the vcap-service exporter. When not set, the first binding matching the label/tag filters is used. |
|
sap.vcap-service.cf.binding.label.value |
The service label used to filter CF service bindings for the vcap-service exporter. When not set, any label is accepted. |
|
sap.vcap-service.cf.binding.tag.value |
The service tag used to filter CF service bindings for the vcap-service exporter. When not set, any tag is accepted. |
|
sap.vcap-service.cf.binding.credentials.otlp.endpoint |
The name of the credential field that holds the OTLP endpoint URL. Used as fallback for all signals when the signal-specific keys are not set. | |
sap.vcap-service.cf.binding.credentials.otlp.logs.endpoint |
The name of the credential field that holds the OTLP logs endpoint URL. Falls back to otlp.endpoint. |
(from otlp.endpoint) |
sap.vcap-service.cf.binding.credentials.otlp.metrics.endpoint |
The name of the credential field that holds the OTLP metrics endpoint URL. Falls back to otlp.endpoint. |
(from otlp.endpoint) |
sap.vcap-service.cf.binding.credentials.otlp.traces.endpoint |
The name of the credential field that holds the OTLP traces endpoint URL. Falls back to otlp.endpoint. |
(from otlp.endpoint) |
sap.vcap-service.cf.binding.credentials.otlp.auth-token |
The name of the credential field that holds the authentication token. | |
sap.vcap-service.cf.binding.credentials.otlp.auth-header-name |
The HTTP header name used to send the authentication token. | Authorization |
sap.vcap-service.cf.binding.credentials.otlp.client-key |
The name of the credential field that holds the mTLS client private key in PEM format. | |
sap.vcap-service.cf.binding.credentials.otlp.client-cert |
The name of the credential field that holds the mTLS client certificate in PEM format. | |
sap.vcap-service.cf.binding.credentials.otlp.server-cert |
The name of the credential field that holds the trusted server CA certificate in PEM format. When not set and mTLS is used, the certificate is downloaded from the endpoint automatically. | |
otel.exporter.vcap-service.compression |
The compression algorithm to use for the vcap-service exporter. Applies to all signals unless overridden per signal. |
gzip |
otel.exporter.vcap-service.protocol |
The transport protocol for the vcap-service exporter: http/protobuf or grpc. Applies to all signals unless overridden per signal. |
http/protobuf |
otel.exporter.vcap-service.timeout |
The maximum duration to wait when exporting data. Applies to all signals unless overridden per signal. | (OTel SDK default) |
otel.exporter.vcap-service.logs.compression |
Compression for logs. Falls back to otel.exporter.vcap-service.compression. |
(from vcap-service.compression) |
otel.exporter.vcap-service.logs.protocol |
Transport protocol for logs. Falls back to otel.exporter.vcap-service.protocol. |
(from vcap-service.protocol) |
otel.exporter.vcap-service.logs.timeout |
Export timeout for logs. Falls back to otel.exporter.vcap-service.timeout. |
(from vcap-service.timeout) |
otel.exporter.vcap-service.metrics.compression |
Compression for metrics. Falls back to otel.exporter.vcap-service.compression. |
(from vcap-service.compression) |
otel.exporter.vcap-service.metrics.default.histogram.aggregation |
The default histogram aggregation for metrics. Delegates to the underlying OTLP exporter. | (OTel SDK default) |
otel.exporter.vcap-service.metrics.exclude.names |
A comma-separated list of metric name patterns to be excluded. Wildcard * is only supported at the end of the name. Applied after the include filter. |
|
otel.exporter.vcap-service.metrics.include.names |
A comma-separated list of metric name patterns to be included. Wildcard * is only supported at the end of the name. When not set, all metrics are exported. |
|
otel.exporter.vcap-service.metrics.protocol |
Transport protocol for metrics. Falls back to otel.exporter.vcap-service.protocol. |
(from vcap-service.protocol) |
otel.exporter.vcap-service.metrics.temporality.preference |
The preferred aggregation temporality for metrics: cumulative, delta, or lowmemory. |
cumulative |
otel.exporter.vcap-service.metrics.timeout |
Export timeout for metrics. Falls back to otel.exporter.vcap-service.timeout. |
(from vcap-service.timeout) |
otel.exporter.vcap-service.traces.compression |
Compression for traces. Falls back to otel.exporter.vcap-service.compression. |
(from vcap-service.compression) |
otel.exporter.vcap-service.traces.protocol |
Transport protocol for traces. Falls back to otel.exporter.vcap-service.protocol. |
(from vcap-service.protocol) |
otel.exporter.vcap-service.traces.timeout |
Export timeout for traces. Falls back to otel.exporter.vcap-service.timeout. |
(from vcap-service.timeout) |
The extension provides support not only for managed service instance of SAP Cloud Logging but also for user-provided service instances. This helps to fine-tune the configuration, e.g., leave out or reconfigure the syslog drain. Furthermore, this helps on sharing service instances across CF orgs or landscapes.
The extension requires four fields in the user-provided service credentials and needs to be tagged with the otel.javaagent.extension.sap.cf.binding.cloud-logging.tag (default: Cloud Logging) documented in section Configuration.
| Field name | Contents |
|---|---|
ingest-otlp-endpoint |
The OTLP endpoint including port. It will be prefixed with https://. |
ingest-otlp-key |
The mTLS client key in PCKS#8 format. Line breaks as \n. |
ingest-otlp-cert |
The mTLS client certificate in PEM format matching the client key. Line breaks as \n. |
server-ca |
The trusted mTLS server certificate in PEM format. Line breaks as \n. |
If you have a SAP Cloud Logging service key, you can generate the required JSON file with jq:
cf service-key cls test \
| tail -n +2 \
| jq '.credentials | {"ingest-otlp-endpoint":."ingest-otlp-endpoint", "ingest-otlp-cert":."ingest-otlp-cert", "ingest-otlp-key":."ingest-otlp-key", "server-ca":."server-ca"}' \
> ups.jsonUsing this file, you can create the required user-provided service:
cf cups <your-service-name> -p ups.json -t "Cloud Logging" Note, that you can easily feed arbitrary credentials to the extension. It does not need to be SAP Cloud Logging. You can even change the tag using the configuration parameters of the extension.
SAP BTP internally offers a managed Dynatrace service, that is recognized by the extension.
Externally, user-provided service instances need to be created.
The Dynatrace documentation explains, how to generate the necessary access url and tokens.
The extension requires two fields in the user-provided service credentials and needs to be tagged with the sap.dynatrace.cf.binding.tag.value (default: dynatrace) documented in section Configuration.
| Field name | Contents |
|---|---|
apiurl |
The Dynatrace API endpoint, e.g. https://apm.example.com/e/<some-uuid>/api. This url will be appended with /v2/otlp/v1/metrics to create the full endpoint url. |
<your_token_field> |
The API token to be used with the above endpoint. Ensure, that it has the required permissions to ingest data over the endpoint. |
Do not forget to configure the name chosen for <your_token_field> via the respective configuration property:
java #... \
-Dsap.dynatrace.cf.binding.token.name=<your_token_field> \
# ...
# or
SAP_DYNATRACE_CF_BINDING_TOKEN_NAME=<your_token_field>
java #...This feature was introduced with version 4.3.0 of the extension.
The vcap-service exporter lets you ship logs, metrics, and traces to any OTLP-compatible endpoint that is described by a Cloud Foundry service binding.
Unlike the cloud-logging or dynatrace exporters, it does not require a specific service type.
The names of the credential fields that carry the endpoint URL, TLS certificates, and authentication token are freely configurable via environment variables.
Select it per signal with the standard OTel exporter environment variables:
export OTEL_LOGS_EXPORTER=vcap-service
export OTEL_METRICS_EXPORTER=vcap-service
export OTEL_TRACES_EXPORTER=vcap-serviceMultiple exporters can be combined with comma separation, e.g., OTEL_LOGS_EXPORTER=cloud-logging,vcap-service.
The exporter reads the OTLP connection details from the credentials of a CF service binding. It is compatible with both managed and user-provided service instances. The credential field names are not fixed — you tell the exporter which field to read via configuration (see Credential Mapping below).
A minimal user-provided service binding using token authentication looks like this:
{
"user-provided": [{
"name": "my-otlp-service",
"label": "user-provided",
"tags": [],
"credentials": {
"otlp-logs-endpoint": "https://collector.example.com/v1/logs",
"otlp-metrics-endpoint": "https://collector.example.com/v1/metrics",
"otlp-traces-endpoint": "https://collector.example.com/v1/traces",
"auth-token": "Bearer my-token"
}
}]
}A binding using mTLS instead of token authentication would provide three additional fields (client key, client certificate, and optionally the server CA certificate).
Use the following properties to tell the exporter which binding to use:
| Property | Env variable | Description | Default |
|---|---|---|---|
sap.vcap-service.cf.binding.name |
SAP_VCAP_SERVICE_CF_BINDING_NAME |
Exact name of the service binding. | (first matching binding) |
sap.vcap-service.cf.binding.label.value |
SAP_VCAP_SERVICE_CF_BINDING_LABEL_VALUE |
Filter by service label (e.g. user-provided). |
(any label) |
sap.vcap-service.cf.binding.tag.value |
SAP_VCAP_SERVICE_CF_BINDING_TAG_VALUE |
Filter by service tag. | (any tag) |
At least sap.vcap-service.cf.binding.name or one of the filter properties should be set, otherwise the first binding in VCAP_SERVICES is picked.
The following properties name the credential field that holds each piece of connection information.
Setting a property to the value my-field means the exporter reads credentials["my-field"] from the chosen service binding.
| Property | Env variable | Description | Default |
|---|---|---|---|
sap.vcap-service.cf.binding.credentials.otlp.endpoint |
SAP_VCAP_SERVICE_CF_BINDING_CREDENTIALS_OTLP_ENDPOINT |
Credential field that holds the OTLP endpoint URL (fallback for all signals). | (required unless signal-specific keys are set) |
sap.vcap-service.cf.binding.credentials.otlp.logs.endpoint |
SAP_VCAP_SERVICE_CF_BINDING_CREDENTIALS_OTLP_LOGS_ENDPOINT |
Credential field for the OTLP logs endpoint URL. Falls back to otlp.endpoint. |
(falls back to otlp.endpoint) |
sap.vcap-service.cf.binding.credentials.otlp.metrics.endpoint |
SAP_VCAP_SERVICE_CF_BINDING_CREDENTIALS_OTLP_METRICS_ENDPOINT |
Credential field for the OTLP metrics endpoint URL. Falls back to otlp.endpoint. |
(falls back to otlp.endpoint) |
sap.vcap-service.cf.binding.credentials.otlp.traces.endpoint |
SAP_VCAP_SERVICE_CF_BINDING_CREDENTIALS_OTLP_TRACES_ENDPOINT |
Credential field for the OTLP traces endpoint URL. Falls back to otlp.endpoint. |
(falls back to otlp.endpoint) |
sap.vcap-service.cf.binding.credentials.otlp.auth-token |
SAP_VCAP_SERVICE_CF_BINDING_CREDENTIALS_OTLP_AUTH_TOKEN |
Credential field that holds the authentication token. Not required when mTLS is used. | (no token authentication) |
sap.vcap-service.cf.binding.credentials.otlp.auth-header-name |
SAP_VCAP_SERVICE_CF_BINDING_CREDENTIALS_OTLP_AUTH_HEADER_NAME |
Name of the HTTP header used to send the token. | Authorization |
sap.vcap-service.cf.binding.credentials.otlp.client-key |
SAP_VCAP_SERVICE_CF_BINDING_CREDENTIALS_OTLP_CLIENT_KEY |
Credential field that holds the mTLS client private key in PEM format. | (no mTLS) |
sap.vcap-service.cf.binding.credentials.otlp.client-cert |
SAP_VCAP_SERVICE_CF_BINDING_CREDENTIALS_OTLP_CLIENT_CERT |
Credential field that holds the mTLS client certificate in PEM format. | (no mTLS) |
sap.vcap-service.cf.binding.credentials.otlp.server-cert |
SAP_VCAP_SERVICE_CF_BINDING_CREDENTIALS_OTLP_SERVER_CERT |
Credential field that holds the trusted server CA certificate in PEM format. When not set and mTLS is used, the extension downloads the certificate from the endpoint automatically. | (auto-download when mTLS is configured) |
Endpoint URL format: The endpoint URL must include the full path for http/protobuf (e.g. https://collector.example.com/v1/logs). For grpc, provide the host and port without a path (e.g. https://collector.example.com:443).
Authentication: Exactly one of token authentication or mTLS must be configured. When a token field is set, mTLS credential fields are ignored.
General settings apply to all signals. Per-signal settings take precedence when set.
| Property | Description | Default |
|---|---|---|
otel.exporter.vcap-service.protocol |
Transport protocol: http/protobuf or grpc. |
http/protobuf |
otel.exporter.vcap-service.compression |
Compression: gzip or none. |
gzip |
otel.exporter.vcap-service.timeout |
Export timeout (e.g. 10000ms, 30s). |
(OTel SDK default) |
otel.exporter.vcap-service.logs.protocol |
Protocol for logs. Falls back to vcap-service.protocol. |
(from general) |
otel.exporter.vcap-service.logs.compression |
Compression for logs. Falls back to vcap-service.compression. |
(from general) |
otel.exporter.vcap-service.logs.timeout |
Timeout for logs. Falls back to vcap-service.timeout. |
(from general) |
otel.exporter.vcap-service.metrics.protocol |
Protocol for metrics. Falls back to vcap-service.protocol. |
(from general) |
otel.exporter.vcap-service.metrics.compression |
Compression for metrics. Falls back to vcap-service.compression. |
(from general) |
otel.exporter.vcap-service.metrics.timeout |
Timeout for metrics. Falls back to vcap-service.timeout. |
(from general) |
otel.exporter.vcap-service.metrics.temporality.preference |
Aggregation temporality: cumulative, delta, or lowmemory. |
cumulative |
otel.exporter.vcap-service.metrics.default.histogram.aggregation |
Default histogram aggregation. Delegates to the OTLP exporter. | (OTel SDK default) |
otel.exporter.vcap-service.metrics.include.names |
Comma-separated metric name patterns to include. Wildcard * supported at end. |
(all metrics) |
otel.exporter.vcap-service.metrics.exclude.names |
Comma-separated metric name patterns to exclude. Wildcard * supported at end. Applied after include filter. |
(none excluded) |
otel.exporter.vcap-service.traces.protocol |
Protocol for traces. Falls back to vcap-service.protocol. |
(from general) |
otel.exporter.vcap-service.traces.compression |
Compression for traces. Falls back to vcap-service.compression. |
(from general) |
otel.exporter.vcap-service.traces.timeout |
Timeout for traces. Falls back to vcap-service.timeout. |
(from general) |
The cloud-logging exporter provided by this extension is a facade for the OtlpGrpcExporter provided by the OpenTelemetry Java Agent, just like the otlp exporter.
The difference is just during the bootstrapping phase.
The main differences are:
- The
cloud-loggingexporter will send data to all found Cloud Logging bindings, while theotlpexporter uses the first CaaS or Cloud Logging binding found. - The
otlpconfiguration will write the required certificates and keys to temporary files, which are deleted when the JVM is shut down. Thecloud-loggingexporter will keep the secrets in memory. - The
cloud-loggingexporter needs to be configured explicitly.