Skip to content

Commit a220ac4

Browse files
authored
Format config options in OTLP exporter readme (#1748)
1 parent b46ca96 commit a220ac4

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

exporters/otlp/README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -44,34 +44,34 @@ auto exporter = std::unique_ptr<sdktrace::SpanExporter>(new otlp::OtlpHttpExport
4444

4545
### Configuration options ( OTLP GRPC Exporter )
4646

47-
| Option | Env Variable |Default | Description |
48-
| ------------ |---------------|------------ |----------------|
49-
| `endpoint` | `OTEL_EXPORTER_OTLP_ENDPOINT` | `http://localhost:4317`| The OTLP GRPC endpoint to connect to |
50-
| | `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` | | |
51-
| `use_ssl_credentials` | `OTEL_EXPORTER_OTLP_SSL_ENABLE`| `false` | Whether the endpoint is SSL enabled |
52-
| | `OTEL_EXPORTER_OTLP_TRACES_SSL_ENABLE` | | |
53-
| `ssl_credentials_cacert_path` | `OTEL_EXPORTER_OTLP_CERTIFICATE` | `""` | SSL Certificate file path |
54-
| | `OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE` | | |
55-
| `ssl_credentials_cacert_as_string` | `OTEL_EXPORTER_OTLP_CERTIFICATE_STRING` | `""` | SSL Certifcate as in-memory string |
56-
| | `OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE_STRING` | | | |
57-
| `timeout` | `OTEL_EXPORTER_OTLP_TIMEOUT` | `10s` | GRPC deadline |
58-
| | `OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` | | |
59-
| `metadata` | `OTEL_EXPORTER_OTLP_HEADERS` | | Custom metadata for GRPC |
60-
| | `OTEL_EXPORTER_OTLP_TRACES_HEADERS` | | |
47+
| Option | Env Variable | Default | Description |
48+
|----------------------------------|----------------------------------------------|-----------------------|--------------------------------------|
49+
|`endpoint` |`OTEL_EXPORTER_OTLP_ENDPOINT` |`http://localhost:4317`| The OTLP GRPC endpoint to connect to |
50+
| |`OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` | | |
51+
|`use_ssl_credentials` |`OTEL_EXPORTER_OTLP_SSL_ENABLE` | `false` | Whether the endpoint is SSL enabled |
52+
| |`OTEL_EXPORTER_OTLP_TRACES_SSL_ENABLE` | | |
53+
|`ssl_credentials_cacert_path` |`OTEL_EXPORTER_OTLP_CERTIFICATE` | `""` | SSL Certificate file path |
54+
| |`OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE` | | |
55+
|`ssl_credentials_cacert_as_string`|`OTEL_EXPORTER_OTLP_CERTIFICATE_STRING` | `""` | SSL Certifcate as in-memory string |
56+
| |`OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE_STRING`| | |
57+
|`timeout` |`OTEL_EXPORTER_OTLP_TIMEOUT` | `10s` | GRPC deadline |
58+
| |`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` | | |
59+
|`metadata` |`OTEL_EXPORTER_OTLP_HEADERS` | | Custom metadata for GRPC |
60+
| |`OTEL_EXPORTER_OTLP_TRACES_HEADERS` | | |
6161

6262
### Configuration options ( OTLP HTTP Exporter )
6363

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

7676
## Example
7777

0 commit comments

Comments
 (0)