code review fix - better documentation

open-telemetry · Feb 18, 2022 · c1b1401 · c1b1401
1 parent b5ff50e
commit c1b1401
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 18 deletions.
diff --git a/src/OpenTelemetry.Exporter.Jaeger/README.md b/src/OpenTelemetry.Exporter.Jaeger/README.md
@@ -64,25 +64,26 @@ properties:
 
 * `Protocol`: The protocol to use. The default value is `UdpCompactThrift`.
 
-  | Protocol       | Description                                           |
-  |----------------|-------------------------------------------------------|
-  |`udp/thrift.compact`| Apache Thrift compact over UDP to a Jaeger Agent.     |
-  |`http/thrift.binary`| Apache Thrift binary over HTTP to a Jaeger Collector. |
+  | Protocol         | Description                                           |
+  |------------------|-------------------------------------------------------|
+  |`UdpCompactThrift`| Apache Thrift compact over UDP to a Jaeger Agent.     |
+  |`HttpBinaryThrift`| Apache Thrift binary over HTTP to a Jaeger Collector. |
 
 See the [`TestJaegerExporter.cs`](../../examples/Console/TestJaegerExporter.cs)
 for an example of how to use the exporter.
 
 ## Environment Variables
 
 The following environment variables can be used to override the default
-values of the `JaegerExporterOptions`.
-
-| Environment variable               | `JaegerExporterOptions` property |
-| ---------------------------------- | -------------------------------- |
-| `OTEL_EXPORTER_JAEGER_AGENT_HOST`  | `AgentHost`                      |
-| `OTEL_EXPORTER_JAEGER_AGENT_PORT`  | `AgentPort`                      |
-| `OTEL_EXPORTER_JAEGER_ENDPOINT`    | `Endpoint`                       |
-| `OTEL_EXPORTER_JAEGER_PROTOCOL`    | `Protocol`                       |
+values of the `JaegerExporterOptions`
+(following the [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#jaeger-exporter)).
+
+| Environment variable               | `JaegerExporterOptions` property                         |
+| ---------------------------------- | -------------------------------------------------------- |
+| `OTEL_EXPORTER_JAEGER_AGENT_HOST`  | `AgentHost`                                              |
+| `OTEL_EXPORTER_JAEGER_AGENT_PORT`  | `AgentPort`                                              |
+| `OTEL_EXPORTER_JAEGER_ENDPOINT`    | `Endpoint`                                               |
+| `OTEL_EXPORTER_JAEGER_PROTOCOL`    | `Protocol` (`udp/thrift.compact` or `http/thrift.binary`)|
 
 `FormatException` is thrown in case of an invalid value for any of the
 supported environment variables.

diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md
@@ -56,12 +56,12 @@ The following environment variables can be used to override the default
 values of the `OtlpExporterOptions`
 (following the [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md)).
 
-| Environment variable          | `OtlpExporterOptions` property    |
-| ------------------------------| ----------------------------------|
-| `OTEL_EXPORTER_OTLP_ENDPOINT` | `Endpoint`                        |
-| `OTEL_EXPORTER_OTLP_HEADERS`  | `Headers`                         |
-| `OTEL_EXPORTER_OTLP_TIMEOUT`  | `TimeoutMilliseconds`             |
-| `OTEL_EXPORTER_OTLP_PROTOCOL` | `Protocol` (grpc or http/protobuf)|
+| Environment variable          | `OtlpExporterOptions` property        |
+| ------------------------------| --------------------------------------|
+| `OTEL_EXPORTER_OTLP_ENDPOINT` | `Endpoint`                            |
+| `OTEL_EXPORTER_OTLP_HEADERS`  | `Headers`                             |
+| `OTEL_EXPORTER_OTLP_TIMEOUT`  | `TimeoutMilliseconds`                 |
+| `OTEL_EXPORTER_OTLP_PROTOCOL` | `Protocol` (`grpc` or `http/protobuf`)|
 
 `FormatException` is thrown in case of an invalid value for any of the
 supported environment variables.