Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: OTEL_EXPORTER_OTLP_ENDPOINT append version and signal #2438

Merged
merged 6 commits into from Aug 31, 2021
Merged

feat: OTEL_EXPORTER_OTLP_ENDPOINT append version and signal #2438

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c928207
fix(@opentelemetry/exporter-collector): OTEL_EXPORTER_OTLP_ENDPOINT a…
Aug 28, 2021
b23f4e8
docs: update exporter collector readme
Aug 30, 2021
6474283
docs: update exporter readme
Aug 30, 2021
43b9707
refactor: append util
Aug 30, 2021
2e24a03
fix: lint on readme
Aug 30, 2021
c8074c0
Merge branch 'main' into fix/exporter-collector-endpoint-path
obecny Aug 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 15 additions & 2 deletions packages/opentelemetry-exporter-collector/README.md
View file
Open in desktop
Expand Up @@ -28,7 +28,7 @@ import { WebTracerProvider } from '@opentelemetry/sdk-trace-web';
import { CollectorTraceExporter } from '@opentelemetry/exporter-collector';

const collectorOptions = {
url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/trace
url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/traces
headers: {}, // an optional object containing custom headers to be sent with each request
concurrencyLimit: 10, // an optional limit on pending requests
};
Expand Down Expand Up @@ -83,7 +83,7 @@ const { BasicTracerProvider, BatchSpanProcessor } = require('@opentelemetry/sdk-
const { CollectorTraceExporter } = require('@opentelemetry/exporter-collector');

const collectorOptions = {
url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/trace
url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/traces
headers: {
foo: 'bar'
}, // an optional object containing custom headers to be sent with each request will only work with http
Expand Down Expand Up @@ -134,6 +134,18 @@ For GRPC please check [npm-url-grpc]

For PROTOBUF please check [npm-url-proto]

## Configuration options as environment variables

Instead of providing options to `CollectorMetricExporter` and `CollectorTraceExporter` explicitly, environment variables may be provided instead.

```sh
OTEL_EXPORTER_OTLP_ENDPOINT=https://localhost:4317
longility marked this conversation as resolved.
Show resolved Hide resolved
# this will automatically append the version and signal path
# e.g. https://localhost:4317/v1/traces for `CollectorTraceExporter` and https://localhost:4317/v1/metrics for `CollectorMetricExporter`
```

For more details, see [OpenTelemetry Specification on Protocol Exporter][opentelemetry-spec-protocol-exporter].

## Running opentelemetry-collector locally to see the traces

1. Go to examples/collector-exporter-node
Expand Down Expand Up @@ -162,4 +174,5 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[npm-url-proto]: https://www.npmjs.com/package/@opentelemetry/exporter-collector-proto
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fexporter-collector.svg
[opentelemetry-collector-url]: https://github.com/open-telemetry/opentelemetry-collector
[opentelemetry-spec-protocol-exporter]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options
[semconv-resource-service-name]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service