...
Use Case: EXAMPLE
Prerequisites
Configuration
...
uc.properties
...
Name
...
Description
...
uc.otel.sdk.disabled
...
If true, disable the OpenTelemetry SDK. Defaults to false.
...
uc.otel.traces.exporter
...
Default is otlp. none means no traces exporter configured.
...
uc.otel.metrics.exporter
...
Default is otlp. none means no metrics exporter configured.
...
uc.otel.exporter.otlp.service.name
...
Specifies a custom logical name for the service.
If left unspecified, the service name is controller.
...
uc.otel.exporter.otlp.protocol
...
The transport protocol to use on OTLP trace, and metric requests. Options include grpc and http/protobuf. Default is grpc.
...
uc.otel.exporter.otlp.traces.protocol
...
The transport protocol to use on OTLP trace requests. Options include grpc and http/protobuf. Default is grpc.
...
uc.otel.exporter.otlp.metrics.protocol
...
The transport protocol to use on OTLP metric requests. Options include grpc and http/protobuf. Default is grpc.
...
uc.otel.exporter.otlp.endpoint
...
The OTLP traces, and metrics endpoint to connect to. Must be a URL with a scheme of either http or https based on the use of TLS. If protocol is http/protobuf the version and signal will be appended to the path (e.g. v1/traces, or v1/metrics). For example, http://localhost:4317 when protocol is grpc, and http://localhost:4318/v1/{signal} when protocol is http/protobuf.
...
uc.otel.exporter.otlp.traces.endpoint
...
The OTLP traces endpoint to connect to. Must be a URL with a scheme of either http or https based on the use of TLS. For example, http://localhost:4317 when protocol is grpc, and http://localhost:4318/v1/traces when protocol is http/protobuf.
...
uc.otel.exporter.otlp.metrics.endpoint
...
The OTLP metrics endpoint to connect to. Must be a URL with a scheme of either http or https based on the use of TLS. For example, http://localhost:4317 when protocol is grpc, and http://localhost:4318/v1/metrics when protocol is http/protobuf.
...
uc.otel.exporter.otlp.certificate
...
The path to the file containing trusted certificates to use when verifying an OTLP trace, or metric server's TLS credentials. The file should contain one or more X.509 certificates in PEM format. By default the host platform's trusted root certificates are used.
...
uc.otel.exporter.otlp.traces.certificate
...
The path to the file containing trusted certificates to use when verifying an OTLP trace server's TLS credentials. The file should contain one or more X.509 certificates in PEM format. By default the host platform's trusted root certificates are used.
...
uc.otel.exporter.otlp.metrics.certificate
...
The path to the file containing trusted certificates to use when verifying an OTLP metric server's TLS credentials. The file should contain one or more X.509 certificates in PEM format. By default the host platform's trusted root certificates are used.
...
uc.otel.exporter.otlp.client.key
...
The path to the file containing private client key to use when verifying an OTLP trace, or metric client's TLS credentials. The file should contain one private key PKCS8 PEM format. By default no client key is used.
...
uc.otel.exporter.otlp.traces.client.key
...
The path to the file containing private client key to use when verifying an OTLP trace client's TLS credentials. The file should contain one private key PKCS8 PEM format. By default no client key file is used.
...
uc.otel.exporter.otlp.metrics.client.key
...
The path to the file containing private client key to use when verifying an OTLP metric client's TLS credentials. The file should contain one private key PKCS8 PEM format. By default no client key file is used.
...
uc.otel.exporter.otlp.client.certificate
...
The path to the file containing trusted certificates to use when verifying an OTLP trace, or metric client's TLS credentials. The file should contain one or more X.509 certificates in PEM format. By default no chain file is used.
...
uc.otel.exporter.otlp.traces.client.certificate
...
The path to the file containing trusted certificates to use when verifying an OTLP trace server's TLS credentials. The file should contain one or more X.509 certificates in PEM format. By default no chain file is used.
...
uc.otel.exporter.otlp.metrics.client.certificate
...
The path to the file containing trusted certificates to use when verifying an OTLP metric server's TLS credentials. The file should contain one or more X.509 certificates in PEM format. By default no chain file is used.
...
uc.otel.exporter.otlp.headers
...
Key-value pairs separated by commas to pass as request headers on OTLP trace, or metric requests.
...
uc.otel.exporter.otlp.traces.headers
...
Key-value pairs separated by commas to pass as request headers on OTLP trace requests.
...
uc.otel.exporter.otlp.metrics.headers
...
Key-value pairs separated by commas to pass as request headers on OTLP metrics requests.
...
uc.otel.exporter.otlp.compression
...
The compression type to use on OTLP trace, and metric requests. Options include gzip. By default no compression will be used.
...
uc.otel.exporter.otlp.traces.compression
...
The compression type to use on OTLP trace requests. Options include gzip. By default no compression will be used.
...
uc.otel.exporter.otlp.metrics.compression
...
The compression type to use on OTLP metric requests. Options include gzip. By default no compression will be used.
...
uc.otel.exporter.otlp.timeout
...
The maximum waiting time, in milliseconds, allowed to send each OTLP trace, and metric batch. Default is 10000.
...
uc.otel.exporter.otlp.traces.timeout
...
The maximum waiting time, in milliseconds, allowed to send each OTLP trace batch. Default is 10000.
...
uc.otel.exporter.otlp.metrics.timeout
...
The maximum waiting time, in milliseconds, allowed to send each OTLP metric batch. Default is 10000.
...
uc.otel.exporter.otlp.metrics.temporality.preference
...
The preferred output aggregation temporality. Options include DELTA, LOWMEMORY, and CUMULATIVE. If CUMULATIVE, all instruments will have cumulative temporality. If DELTA, counter (sync and async) and histograms will be delta, up down counters (sync and async) will be cumulative. If LOWMEMORY, sync counter and histograms will be delta, async counter and up down counters (sync and async) will be cumulative. Default is CUMULATIVE.
...
uc.otel.exporter.otlp.metrics.default.histogram.aggregation
...
Universal Agent
Links to OMS and UAG open telemetry options.
Universal Controller
link to uc.properties open telemetry properties.
Provided Metrics
Document References
Ref# | Description |
...