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

Format config options in OTLP exporter readme #1748

Merged
merged 2 commits into from
Nov 9, 2022
Merged

Format config options in OTLP exporter readme #1748

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
864da3f
Format config options in OTLP exporter readme
ThomsonTan Nov 8, 2022
e6727df
Format table header
ThomsonTan Nov 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions exporters/otlp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,34 +44,34 @@ auto exporter = std::unique_ptr<sdktrace::SpanExporter>(new otlp::OtlpHttpExport

### Configuration options ( OTLP GRPC Exporter )

| Option | Env Variable |Default | Description |
| ------------ |---------------|------------ |----------------|
| `endpoint` | `OTEL_EXPORTER_OTLP_ENDPOINT` | `http://localhost:4317`| The OTLP GRPC endpoint to connect to |
| | `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` | | |
| `use_ssl_credentials` | `OTEL_EXPORTER_OTLP_SSL_ENABLE`| `false` | Whether the endpoint is SSL enabled |
| | `OTEL_EXPORTER_OTLP_TRACES_SSL_ENABLE` | | |
| `ssl_credentials_cacert_path` | `OTEL_EXPORTER_OTLP_CERTIFICATE` | `""` | SSL Certificate file path |
| | `OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE` | | |
| `ssl_credentials_cacert_as_string` | `OTEL_EXPORTER_OTLP_CERTIFICATE_STRING` | `""` | SSL Certifcate as in-memory string |
| | `OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE_STRING` | | | |
| `timeout` | `OTEL_EXPORTER_OTLP_TIMEOUT` | `10s` | GRPC deadline |
| | `OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` | | |
| `metadata` | `OTEL_EXPORTER_OTLP_HEADERS` | | Custom metadata for GRPC |
| | `OTEL_EXPORTER_OTLP_TRACES_HEADERS` | | |
| Option | Env Variable | Default | Description |
|----------------------------------|----------------------------------------------|-----------------------|--------------------------------------|
|`endpoint` |`OTEL_EXPORTER_OTLP_ENDPOINT` |`http://localhost:4317`| The OTLP GRPC endpoint to connect to |
| |`OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` | | |
|`use_ssl_credentials` |`OTEL_EXPORTER_OTLP_SSL_ENABLE` | `false` | Whether the endpoint is SSL enabled |
| |`OTEL_EXPORTER_OTLP_TRACES_SSL_ENABLE` | | |
|`ssl_credentials_cacert_path` |`OTEL_EXPORTER_OTLP_CERTIFICATE` | `""` | SSL Certificate file path |
| |`OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE` | | |
|`ssl_credentials_cacert_as_string`|`OTEL_EXPORTER_OTLP_CERTIFICATE_STRING` | `""` | SSL Certifcate as in-memory string |
| |`OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE_STRING`| | |
|`timeout` |`OTEL_EXPORTER_OTLP_TIMEOUT` | `10s` | GRPC deadline |
| |`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` | | |
|`metadata` |`OTEL_EXPORTER_OTLP_HEADERS` | | Custom metadata for GRPC |
| |`OTEL_EXPORTER_OTLP_TRACES_HEADERS` | | |

### Configuration options ( OTLP HTTP Exporter )

| Option | Env Variable |Default | Description |
| ------------ |-----|------------ |------|
| `url` | `OTEL_EXPORTER_OTLP_ENDPOINT` | `http://localhost:4318/v1/traces` | The OTLP HTTP endpoint to connect to |
| | `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` | | |
| `content_type` | n/a | `application/json` | Data format used - JSON or Binary |
| `json_bytes_mapping` | n/a | `JsonBytesMappingKind::kHexId` | Encoding used for trace_id and span_id |
| `use_json_name` | n/a | `false` | Whether to use json name of protobuf field to set the key of json |
| `timeout` | `OTEL_EXPORTER_OTLP_TIMEOUT` | `10s` | http timeout |
| | `OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` | |
| `http_headers` | `OTEL_EXPORTER_OTLP_HEADERS` | | http headers |
| | `OTEL_EXPORTER_OTLP_TRACES_HEADERS` | | |
| Option | Env Variable | Default | Description |
|--------------------|------------------------------------|---------------------------------|-------------------------------------------------------------------|
|`url` |`OTEL_EXPORTER_OTLP_ENDPOINT` |`http://localhost:4318/v1/traces`| The OTLP HTTP endpoint to connect to |
| |`OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`| | |
|`content_type` | n/a | `application/json` | Data format used - JSON or Binary |
|`json_bytes_mapping`| n/a | `JsonBytesMappingKind::kHexId` | Encoding used for trace_id and span_id |
|`use_json_name` | n/a | `false` | Whether to use json name of protobuf field to set the key of json |
|`timeout` |`OTEL_EXPORTER_OTLP_TIMEOUT` | `10s` | http timeout |
| |`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` | | |
|`http_headers` |`OTEL_EXPORTER_OTLP_HEADERS` | | http headers |
| |`OTEL_EXPORTER_OTLP_TRACES_HEADERS` | | |

## Example

Expand Down