Skip to content

Commit b3a9c66

Browse files
authored
docs: update exporter default compression setting (#1364)
By default the OTLP exporters use gzip for compression, as specified with `default: 'gzip'` in the files linked below. The `README.md` files of the exporter gems document no particular default. This commit updates documentation of the compression env vars to mention the default compression config value. - Base exporter setting: https://github.com/open-telemetry/opentelemetry-ruby/blob/03e36cec755df97e08139494b85473a7ad547001/exporter/otlp/lib/opentelemetry/exporter/otlp/exporter.rb#L52 - HTTP exporter setting: https://github.com/open-telemetry/opentelemetry-ruby/blob/03e36cec755df97e08139494b85473a7ad547001/exporter/otlp-http/lib/opentelemetry/exporter/otlp/http/trace_exporter.rb#L39
1 parent 03e36ce commit b3a9c66

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

exporter/otlp-http/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ The collector exporter can be configured explicitly in code, or via environment
7373
| `endpoint:` | `OTEL_EXPORTER_OTLP_ENDPOINT` | `"http://localhost:4318/v1/traces"` |
7474
| `certificate_file: `| `OTEL_EXPORTER_OTLP_CERTIFICATE` | |
7575
| `headers:` | `OTEL_EXPORTER_OTLP_HEADERS` | |
76-
| `compression:` | `OTEL_EXPORTER_OTLP_COMPRESSION` | |
76+
| `compression:` | `OTEL_EXPORTER_OTLP_COMPRESSION` | `"gzip"` |
7777
| `timeout:` | `OTEL_EXPORTER_OTLP_TIMEOUT` | `10` |
7878
| `ssl_verify_mode:` | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_PEER` or | `OpenSSL::SSL:VERIFY_PEER` |
7979
| | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_NONE` | |

exporter/otlp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ The collector exporter can be configured explicitly in code, or via environment
7373
| `endpoint:` | `OTEL_EXPORTER_OTLP_ENDPOINT` | `"http://localhost:4318/v1/traces"` |
7474
| `certificate_file: `| `OTEL_EXPORTER_OTLP_CERTIFICATE` | |
7575
| `headers:` | `OTEL_EXPORTER_OTLP_HEADERS` | |
76-
| `compression:` | `OTEL_EXPORTER_OTLP_COMPRESSION` | |
76+
| `compression:` | `OTEL_EXPORTER_OTLP_COMPRESSION` | `"gzip"` |
7777
| `timeout:` | `OTEL_EXPORTER_OTLP_TIMEOUT` | `10` |
7878
| `ssl_verify_mode:` | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_PEER` or | `OpenSSL::SSL:VERIFY_PEER` |
7979
| | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_NONE` | |

0 commit comments

Comments
 (0)