gtsocial-umbx

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

README.md (2965B)

      1 # OpenTelemetry-Go Jaeger Exporter
      2 
      3 [![Go Reference](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/jaeger.svg)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/jaeger)
      4 
      5 [OpenTelemetry span exporter for Jaeger](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/sdk_exporters/jaeger.md) implementation.
      6 
      7 ## Installation
      8 
      9 ```
     10 go get -u go.opentelemetry.io/otel/exporters/jaeger
     11 ```
     12 
     13 ## Example
     14 
     15 See [../../example/jaeger](../../example/jaeger).
     16 
     17 ## Configuration
     18 
     19 The exporter can be used to send spans to:
     20 
     21 - Jaeger agent using `jaeger.thrift` over compact thrift protocol via
     22   [`WithAgentEndpoint`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/jaeger#WithAgentEndpoint) option.
     23 - Jaeger collector using `jaeger.thrift` over HTTP via
     24   [`WithCollectorEndpoint`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/jaeger#WithCollectorEndpoint) option.
     25 
     26 ### Environment Variables
     27 
     28 The following environment variables can be used
     29 (instead of options objects) to override the default configuration.
     30 
     31 | Environment variable              | Option                                                                                        | Default value                       |
     32 | --------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------------- |
     33 | `OTEL_EXPORTER_JAEGER_AGENT_HOST` | [`WithAgentHost`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/jaeger#WithAgentHost) | `localhost`                         |
     34 | `OTEL_EXPORTER_JAEGER_AGENT_PORT` | [`WithAgentPort`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/jaeger#WithAgentPort) | `6831`                              |
     35 | `OTEL_EXPORTER_JAEGER_ENDPOINT`   | [`WithEndpoint`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/jaeger#WithEndpoint)   | `http://localhost:14268/api/traces` |
     36 | `OTEL_EXPORTER_JAEGER_USER`       | [`WithUsername`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/jaeger#WithUsername)   |                                     |
     37 | `OTEL_EXPORTER_JAEGER_PASSWORD`   | [`WithPassword`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/jaeger#WithPassword)   |                                     |
     38 
     39 Configuration using options have precedence over the environment variables.
     40 
     41 ## Contributing
     42 
     43 This exporter uses a vendored copy of the Apache Thrift library (v0.14.1) at a custom import path.
     44 When re-generating Thrift code in the future, please adapt import paths as necessary.
     45 
     46 ## References
     47 
     48 - [Jaeger](https://www.jaegertracing.io/)
     49 - [OpenTelemetry to Jaeger Transformation](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/sdk_exporters/jaeger.md)
     50 - [OpenTelemetry Environment Variable Specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/sdk-environment-variables.md#jaeger-exporter)