README.md in opentelemetry-exporter-otlp-0.28.1 vs README.md in opentelemetry-exporter-otlp-0.29.0
- old
+ new
@@ -71,19 +71,21 @@
## How can I configure the OTLP exporter?
The collector exporter can be configured explicitly in code, or via environment variables as shown above. The configuration parameters, environment variables, and defaults are shown below.
-| Parameter | Environment variable | Default |
-| ------------------- | -------------------------------------------- | ----------------------------------- |
-| `endpoint:` | `OTEL_EXPORTER_OTLP_ENDPOINT` | `"http://localhost:4318/v1/traces"` |
-| `certificate_file: `| `OTEL_EXPORTER_OTLP_CERTIFICATE` | |
-| `headers:` | `OTEL_EXPORTER_OTLP_HEADERS` | |
-| `compression:` | `OTEL_EXPORTER_OTLP_COMPRESSION` | `"gzip"` |
-| `timeout:` | `OTEL_EXPORTER_OTLP_TIMEOUT` | `10` |
-| `ssl_verify_mode:` | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_PEER` or | `OpenSSL::SSL:VERIFY_PEER` |
-| | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_NONE` | |
+| Parameter | Environment variable | Default |
+|---------------------------| -------------------------------------------- | ----------------------------------- |
+| `endpoint:` | `OTEL_EXPORTER_OTLP_ENDPOINT` | `"http://localhost:4318/v1/traces"` |
+| `certificate_file:` | `OTEL_EXPORTER_OTLP_CERTIFICATE` | |
+| `client_certificate_file` | `OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE` | |
+| `client_key_file` | `OTEL_EXPORTER_OTLP_CLIENT_KEY` | |
+| `headers:` | `OTEL_EXPORTER_OTLP_HEADERS` | |
+| `compression:` | `OTEL_EXPORTER_OTLP_COMPRESSION` | `"gzip"` |
+| `timeout:` | `OTEL_EXPORTER_OTLP_TIMEOUT` | `10` |
+| `ssl_verify_mode:` | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_PEER` or | `OpenSSL::SSL:VERIFY_PEER` |
+| | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_NONE` | |
`ssl_verify_mode:` parameter values should be flags for server certificate verification: `OpenSSL::SSL:VERIFY_PEER` and `OpenSSL::SSL:VERIFY_NONE` are acceptable. These values can also be set using the appropriately named environment variables as shown where `VERIFY_PEER` will take precedence over `VERIFY_NONE`. Please see [the Net::HTTP docs](https://ruby-doc.org/stdlib-2.7.6/libdoc/net/http/rdoc/Net/HTTP.html#verify_mode) for more information about these flags.
## How can I get involved?
@@ -95,11 +97,11 @@
The `opentelemetry-exporter-otlp` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
## Working with Proto Definitions
-The OTel community maintains a [repository with protobuf definitions][otel-proto-github] that language and collector implementors use to generate code.
+The OTel community maintains a [repository with protobuf definitions][otel-proto-github] that language and collector implementers use to generate code.
Maintainers are expected to keep up to date with the latest version of protos. This guide will provide you with step-by-step instructions on updating the OTLP Exporter gem with the latest definitions.
### System Requirements
@@ -134,10 +136,10 @@
$> bundle exec rake test
```
-**Commit the chnages and open a PR!**
+**Commit the changes and open a PR!**
[opentelemetry-collector-home]: https://opentelemetry.io/docs/collector/about/
[opentelemetry-home]: https://opentelemetry.io
[bundler-home]: https://bundler.io
[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby