Liking cljdoc? Tell your friends :D
Clojure only.

steffan-westcott.clj-otel.exporter.otlp.http.metrics

Metric data exporter using OpenTelemetry Protocol via HTTP.

Metric data exporter using OpenTelemetry Protocol via HTTP.
raw docstring

metric-exporterclj

(metric-exporter)
(metric-exporter {:keys [endpoint headers trusted-certificates-pem
                         client-private-key-pem client-certificates-pem
                         ssl-context x509-trust-manager compression-method
                         timeout connect-timeout retry-policy meter-provider-fn
                         proxy-options aggregation-temporality-selector
                         memory-mode service-classloader component-loader
                         executor-service internal-telemetry-version]
                  :or {meter-provider-fn otel/get-meter-provider}})

Returns a metric data exporter that sends span data using OTLP via HTTP, using OpenTelemetry's protobuf model. May take an option map as follows:

keydescription
:endpointOTLP endpoint, must start with "http://" or "https://" and include the full path (default: "http://localhost:4318/v1/metrics").
:headersHTTP headers to add to request (default: {}).
:trusted-certificates-pem^bytes X.509 certificate chain in PEM format for verifying servers when TLS enabled (default: system default trusted certificates).
:client-private-key-pem^bytes private key in PEM format for verifying client when TLS enabled.
:client-certificates-pem^bytes X.509 certificate chain in PEM format for verifying client when TLS enabled.
:ssl-contextSSLContext "bring your own SSLContext" alternative to setting certificate bytes when using TLS.
:x509-trust-managerX509TrustManager "bring your own SSLContext" alternative to setting certificate bytes when using TLS.
:compression-methodMethod used to compress payloads, "gzip" or "none" (default: "none").
:timeoutMaximum time to wait for export of a batch of spans. Value is either a Duration or a vector [amount ^TimeUnit unit] (default: 10s).
:connect-timeoutMaximum time to wait for new connections to be established. Value is either a Duration or a vector [amount ^TimeUnit unit] (default: 10s).
:retry-policyOption map for retry policy, see steffan-westcott.clj-otel.sdk.export/retry-policy (default: same as (retry-policy)).
:meter-provider-fnnil or fn that returns MeterProvider to collect metrics related to export. If nil, use no-op MeterProvider (default: meter provider of default OpenTelemetry).
:proxy-optionsOption map for proxy options, see steffan-westcott.clj-otel.sdk.export/proxy-options (default: no proxy used).
:aggregation-temporality-selectorFunction which takes an InstrumentType and returns an AggregationTemporality (default: constantly AggregationTemporality/CUMULATIVE).
:memory-modeEither :immutable-data for thread safe or :reusable-data for non thread safe (but reduced) data allocations (default: :reusable-data).
:service-classloaderClassLoader to load the sender API.
:component-loaderComponentLoader to load the sender API.
:executor-serviceExecutorService used to execute requests.
:internal-telemetry-versionSelf-monitoring telemetry to export, either :legacy or :latest (default: :legacy).
Returns a metric data exporter that sends span data using OTLP via HTTP,
using OpenTelemetry's protobuf model. May take an option map as follows:

| key                               | description |
|-----------------------------------|-------------|
|`:endpoint`                        | OTLP endpoint, must start with `"http://"` or `"https://"` and include the full path (default: `"http://localhost:4318/v1/metrics"`).
|`:headers`                         | HTTP headers to add to request (default: `{}`).
|`:trusted-certificates-pem`        | `^bytes` X.509 certificate chain in PEM format for verifying servers when TLS enabled (default: system default trusted certificates).
|`:client-private-key-pem`          | `^bytes` private key in PEM format for verifying client when TLS enabled.
|`:client-certificates-pem`         | `^bytes` X.509 certificate chain in PEM format for verifying client when TLS enabled.
|`:ssl-context`                     | `SSLContext` "bring your own SSLContext" alternative to setting certificate bytes when using TLS.
|`:x509-trust-manager`              | `X509TrustManager` "bring your own SSLContext" alternative to setting certificate bytes when using TLS.
|`:compression-method`              | Method used to compress payloads, `"gzip"` or `"none"` (default: `"none"`).
|`:timeout`                         | Maximum time to wait for export of a batch of spans. Value is either a `Duration` or a vector `[amount ^TimeUnit unit]` (default: 10s).
|`:connect-timeout`                 | Maximum time to wait for new connections to be established. Value is either a `Duration` or a vector `[amount ^TimeUnit unit]` (default: 10s).
|`:retry-policy`                    | Option map for retry policy, see `steffan-westcott.clj-otel.sdk.export/retry-policy` (default: same as `(retry-policy)`).
|`:meter-provider-fn`               | nil or fn that returns `MeterProvider` to collect metrics related to export. If nil, use no-op `MeterProvider` (default: meter provider of default OpenTelemetry).
|`:proxy-options`                   | Option map for proxy options, see `steffan-westcott.clj-otel.sdk.export/proxy-options` (default: no proxy used).
|`:aggregation-temporality-selector`| Function which takes an `InstrumentType` and returns an `AggregationTemporality` (default: constantly `AggregationTemporality/CUMULATIVE`).
|`:memory-mode`                     | Either `:immutable-data` for thread safe or `:reusable-data` for non thread safe (but reduced) data allocations (default: `:reusable-data`).
|`:service-classloader`             | `ClassLoader` to load the sender API.
|`:component-loader`                | `ComponentLoader` to load the sender API.
|`:executor-service`                | `ExecutorService` used to execute requests.
|`:internal-telemetry-version`      | Self-monitoring telemetry to export, either `:legacy` or `:latest` (default: `:legacy`).
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close