Package io.quarkus.opentelemetry.runtime.config.runtime.exporter

Interface OtlpExporterConfig

All Known Subinterfaces:
OtlpExporterMetricsConfig, OtlpExporterRuntimeConfig, OtlpExporterTracesConfig
public interface OtlpExporterConfig

  • Field Details

  • Method Details

    • endpoint

      @ConfigDocDefault("http://localhost:4317/") Optional<String> endpoint()
      Sets the OTLP endpoint to send telemetry data. If unset, defaults to "http://localhost:4317/".

      There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp.<signal-type>.endpoint` where <signal-type> is one of the supported signal types, like `traces` or `metrics`.

      If protocol is `http/protobuf` the version and signal will be appended to the path (e.g. v1/traces or v1/metrics) and the default port will be "http://localhost:4318/".

    • headers

      Optional<List<String>> headers()
      Key-value pairs to be used as headers associated with exporter requests. The format is similar to the OTEL_EXPORTER_OTLP_HEADERS environment variable, a list of key-value pairs separated by the "=" character. i.e.: key1=value1,key2=value2

      There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp.<signal-type>.headers` where <signal-type> is one of the supported signal types, like `traces` or `metrics`.

    • compression

      Optional<CompressionType> compression()
      Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`.

      There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp.<signal-type>.compression` where <signal-type> is one of the supported signal types, like `traces` or `metrics`.

    • timeout

      @ConfigDocDefault("10s") @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Duration timeout()
      Sets the maximum time to wait for the collector to process an exported batch of telemetry data. If unset, defaults to "10"s.

      There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp.<signal-type>.timeout` where <signal-type> is one of the supported signal types, like `traces` or `metrics`.

    • protocol

      @ConfigDocDefault("grpc") Optional<String> protocol()
      OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different.

      Currently, only grpc and http/protobuf are allowed.

      Please mind that changing the protocol requires changing the port in the endpoint as well.

      There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp.<signal-type>.protocol` where <signal-type> is one of the supported signal types, like `traces` or `metrics`.

    • keyCert

      @WithName("key-cert") OtlpExporterConfig.KeyCert keyCert()
      Key/cert configuration in the PEM format.

      There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp.<signal-type>.key-cert` where <signal-type> is one of the supported signal types, like `traces` or `metrics`.

    • trustCert

      @WithName("trust-cert") OtlpExporterConfig.TrustCert trustCert()
      Trust configuration in the PEM format.

      There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp.<signal-type>.trust-cert` where <signal-type> is one of the supported signal types, like `traces` or `metrics`.

    • tlsConfigurationName

      Optional<String> tlsConfigurationName()
      The name of the TLS configuration to use.

      If not set and the default TLS configuration is configured (quarkus.tls.*) then that will be used. If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.

      There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp.<signal-type>.tls-configuration-name` where <signal-type> is one of the supported signal types, like `traces` or `metrics`.

    • proxyOptions

      OtlpExporterConfig.ProxyConfig proxyOptions()
      Set proxy options.

      There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp.<signal-type>.proxy-options` where <signal-type> is one of the supported signal types, like `traces` or `metrics`.