Fix typos, add links to examples from readme

open-telemetry · Apr 26, 2024 · d05a637 · d05a637
1 parent 54b734b
commit d05a637
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,15 @@ This repository contains the JSON schema that defines the OpenTelemetry configur
 - code generation
 - broad support across languages
 
+## Example templates
+
+The [examples](./examples) repository contains a variety of sample configuration files to help get started and illustrate useful patterns. The following are noteworthy:
+
+- [sdk-migration-config.yaml](./examples/sdk-migration-config.yaml): Includes env var substitution references to all [standard environment variables](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md) which map cleanly to file configuration (see notes in the example for the set of env vars which are not referenced). Note, SDKs parsing configuration files ignore all env vars besides those referenced via [env var substitution][]. This is a great starting point for transitioning from env var based configuration to file based configuration.
+- [sdk-config.yaml](./examples/sdk-config.yaml): Represents the typical default configuration. This is a good starting point if you are not using env var based configuration or wish to transition fully to file baed configuration. Note, SDKs parsing configuration files ignore all env vars besides those referenced via [env var substitution][].
+
+[env var substitution]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/file-configuration.md#environment-variable-substitution
+
 ## Code generation
 
 There are [several tools](https://json-schema.org/implementations.html) available to generate code from a JSON schema. The following shows an example for generating code from the JSON schema in Go:

diff --git a/examples/sdk-migration-config.yaml b/examples/sdk-migration-config.yaml
@@ -83,7 +83,7 @@ tracer_provider:
             # Configure protocol.
             protocol: ${OTEL_EXPORTER_OTLP_PROTOCOL:-http/protobuf}
             # Configure endpoint.
-            endpoint: ${OTEL_EXPORTER_OTLP_PROTOCOL:-http://localhost:-4318}
+            endpoint: ${OTEL_EXPORTER_OTLP_ENDPOINT:-http://localhost:4318}
             # Configure certificate.
             certificate: ${OTEL_EXPORTER_OTLP_CERTIFICATE}
             # Configure mTLS private client key.
@@ -150,7 +150,7 @@ meter_provider:
             # Configure protocol.
             protocol: ${OTEL_EXPORTER_OTLP_PROTOCOL:-http/protobuf}
             # Configure endpoint.
-            endpoint: ${OTEL_EXPORTER_OTLP_PROTOCOL:-http://localhost:-4318}
+            endpoint: ${OTEL_EXPORTER_OTLP_ENDPOINT:-http://localhost:4318}
             # Configure certificate.
             certificate: ${OTEL_EXPORTER_OTLP_CERTIFICATE}
             # Configure mTLS private client key.
@@ -187,7 +187,7 @@ logger_provider:
             # Configure protocol.
             protocol: ${OTEL_EXPORTER_OTLP_PROTOCOL:-http/protobuf}
             # Configure endpoint.
-            endpoint: ${OTEL_EXPORTER_OTLP_PROTOCOL:-http://localhost:4318}
+            endpoint: ${OTEL_EXPORTER_OTLP_ENDPOINT:-http://localhost:4318/v1/logs}
             # Configure certificate.
             certificate: ${OTEL_EXPORTER_OTLP_CERTIFICATE}
             # Configure mTLS private client key.