Skip to content

Commit

Permalink
[chore] Correct typos in the OTel-Arrow README (open-telemetry#30767)
Browse files Browse the repository at this point in the history
**Description:** The project name is OpenTelemetry Project with Apache
Arrow. The abbreviation OTel-Arrow should not be used in the ways it
was, it is only suitable as the name of the repository and various
configuration field names.
  • Loading branch information
jmacd authored Jan 25, 2024
1 parent e5f7964 commit 0c12b22
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions exporter/otelarrowexporter/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OTel Arrow Exporter
# OpenTelemetry Protocol with Apache Arrow Exporter

<!-- status autogenerated section -->
| Status | |
Expand Down Expand Up @@ -99,7 +99,8 @@ Several helper files are leveraged to provide additional capabilities automatica
### Arrow-specific Configuration

In the `arrow` configuration block, the following settings enable and
disable the use of OTel Arrow as opposed to standard OTLP.
disable the use of OpenTelemetry Protocol with Apache Arrow as opposed
to standard OTLP.

- `disabled` (default: false): disables use of Arrow, causing the exporter to use standard OTLP
- `disable_downgrade` (default: false): prevents this exporter from using standard OTLP.
Expand Down Expand Up @@ -196,15 +197,15 @@ for general information about the choice of Zstd by default, for other
general compression configuration and benchmark information.
For the OpenTelemetry Protocol with Apache Arrow streams specifically,
gRPC-level the Zstd compression level can be configured. However, there
is an important caveat: the gRPC-Go library requires that compressor
implementations be registered statically. These libraries use
compressors named `zstdarrow1`, `zstdarrow2`, ..., `zstdarrow10`,
gRPC-level the Zstd compression level can be configured. However,
there is an important caveat: the gRPC-Go library requires that
compressor implementations be registered statically. These libraries
use compressors named `zstdarrow1`, `zstdarrow2`, ..., `zstdarrow10`,
supporting 10 configurable compression levels. Note, however that
these configurations are static and only one unique configuration is
possible per level. It is possible to configure multiple OTel-Arrow
exporters with different Zstd configuration simply by using distinct
levels.
possible per level. It is possible to configure multiple
OpenTelemetry Protocol with Apache Arrow exporters with different Zstd
configuration simply by using distinct levels.
Under `arrow`, the `zstd` sub-configuration has the following fields:
Expand Down

0 comments on commit 0c12b22

Please sign in to comment.