| Status | |
|---|---|
| Stability | traces [stable] |
| Supported pipeline types | traces |
| Distributions | contrib |
Exports traces and/or metrics via HTTP to an APIClarity endpoint for analysis.
The following settings are required:
endpoint(no default): The target base URL to send data to (e.g.: https://example.com:4318). The trace signal will be added to this base URL, i.e. "/api/telemetry" will be appended.
The following settings can be optionally configured:
tls: see here for the full set of available options.timeout(default = 30s): HTTP request time limit. For details see https://golang.org/pkg/net/http/#Clientread_buffer_size(default = 0): ReadBufferSize for HTTP client.write_buffer_size(default = 512 * 1024): WriteBufferSize for HTTP client.
Example:
exporters:
apiclarity:
endpoint: https://example.com:4318/The full list of settings exposed for this exporter are documented here with detailed sample configurations here.
In order to use the APIClarity Exporter, you will need to build your own OpenTelemetry Collector with the Exporter included. The instructions to build a custom collector are here.
An example builder-config.yaml file including the exporter could be:
dist:
name: otelcol-api
description: "OTel Collector distribution with APIClarity support"
output_path: ./otelcol-api
exporters:
- gomod: "github.com/openclarity/apiclarity/plugins/otel-collector/apiclarityexporter v0.0.0"
- gomod:
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/jaegerexporter
v0.53.0"
- import: go.opentelemetry.io/collector/exporter/loggingexporter
gomod: go.opentelemetry.io/collector v0.53.0
replaces:
- github.com/openclarity/apiclarity/plugins/otel-collector/apiclarityexporter v0.0.0 => github.com/openclarity/apiclarity/plugins/otel-collector/apiclarityexporter v0.0.0-20220915093602-8a11adcdb9e1
- github.com/openclarity/apiclarity/plugins/api v0.0.0 => github.com/openclarity/apiclarity/plugins/api v0.0.0-20220915093602-8a11adcdb9e1
receivers:
- import: go.opentelemetry.io/collector/receiver/otlpreceiver
gomod: go.opentelemetry.io/collector v0.53.0
processors:
- import: go.opentelemetry.io/collector/processor/batchprocessor
gomod: go.opentelemetry.io/collector v0.53.0