Delete generated comments from examples

.github/workflows/build-check.yaml

@@ -30,9 +30,8 @@ jobs:
 
     - name: check for diff
       run: |
-        # need to "git add" to detect any changes to descriptions which are not checked in
+        # need to "git add" to detect any changes which are not checked in
         # select files from locations managed by meta schema
-        git add examples**
         git add schema/meta_schema_*
         git add schema-docs.md
         if git diff --cached --quiet

Makefile

@@ -38,19 +38,12 @@ update-file-format:
 fix-meta-schema:
 	npm run-script fix-meta-schema || exit 1; \
 
-.PHONY: generate-descriptions
-generate-descriptions:
-	@if ! npm ls minimatch yaml; then npm install; fi
-	@for f in $(EXAMPLE_FILES); do \
-	    npm run-script generate-descriptions -- $(shell pwd)/examples/$$f $(shell pwd)/examples/$$f || exit 1; \
-	done
-
 .PHONY: generate-markdown
 generate-markdown:
 	npm run-script generate-markdown || exit 1; \
 
 .PHONY: all-meta-schema
-all-meta-schema: fix-meta-schema generate-descriptions generate-markdown
+all-meta-schema: fix-meta-schema generate-markdown
 
 .PHONY: install-tools
 install-tools:

examples/sdk-config.yaml

@@ -1,270 +1,94 @@
 # sdk-config.yaml is a typical starting point for configuring the SDK, including exporting to
 # localhost via OTLP.
-
+#
 # NOTE: With the exception of env var substitution syntax (i.e. ${MY_ENV}), SDKs ignore
 # environment variables when interpreting config files. This including ignoring all env
 # vars defined in https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/.
-
-# The file format version.
-# The yaml format is documented at
-# https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema
+#
+# For schema documentation, including required properties, semantics, default behavior, etc,
+# see: https://github.com/open-telemetry/opentelemetry-configuration/blob/main/schema-docs.md
 file_format: "1.0-rc.2"
-# Configure if the SDK is disabled or not.
-# If omitted or null, false is used.
 disabled: false
-# Configure the log level of the internal logger used by the SDK.
-# If omitted, info is used.
 log_level: info
-# Configure resource for all signals.
-# If omitted, the default resource is used.
 resource:
-  # Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list.
   attributes:
-    - # The attribute name.
-      name: service.name
-      # The attribute value.
-      # The type of value must match .type.
+    - name: service.name
       value: unknown_service
-# Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits.
 attribute_limits:
-  # Configure max attribute value size. 
-  # Value must be non-negative.
-  # If omitted or null, there is no limit.
   attribute_value_length_limit:
-  # Configure max attribute count. 
-  # Value must be non-negative.
-  # If omitted or null, 128 is used.
   attribute_count_limit: 128
-# Configure text map context propagators.
-# If omitted, a noop propagator is used.
 propagator:
-  # Configure the propagators in the composite text map propagator. Entries from .composite_list are appended to the list here with duplicates filtered out.
-  # Built-in propagator keys include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party keys include: xray. 
-  # If the resolved list of propagators (from .composite and .composite_list) is empty, a noop propagator is used.
   composite:
-    - # Include the w3c trace context propagator.
-      tracecontext:
-    - # Include the w3c baggage propagator.
-      baggage:
-# Configure tracer provider.
-# If omitted, a noop tracer provider is used.
+    - tracecontext:
+    - baggage:
 tracer_provider:
-  # Configure span processors.
   processors:
-    - # Configure a batch span processor.
-      batch:
-        # Configure delay interval (in milliseconds) between two consecutive exports. 
-        # Value must be non-negative.
-        # If omitted or null, 5000 is used.
+    - batch:
         schedule_delay: 5000
-        # Configure maximum allowed time (in milliseconds) to export data. 
-        # Value must be non-negative. A value of 0 indicates no limit (infinity).
-        # If omitted or null, 30000 is used.
         export_timeout: 30000
-        # Configure maximum queue size. Value must be positive.
-        # If omitted or null, 2048 is used.
         max_queue_size: 2048
-        # Configure maximum batch size. Value must be positive.
-        # If omitted or null, 512 is used.
         max_export_batch_size: 512
-        # Configure exporter.
         exporter:
-          # Configure exporter to be OTLP with HTTP transport.
           otlp_http:
-            # Configure endpoint, including the signal specific path.
-            # If omitted or null, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used.
             endpoint: http://localhost:4318/v1/traces
-            # Configure TLS settings for the exporter.
             tls:
-              # Configure certificate used to verify a server's TLS credentials. 
-              # Absolute path to certificate file in PEM format.
-              # If omitted or null, system default certificate verification is used for secure connections.
               certificate_file:
-              # Configure mTLS private client key. 
-              # Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
-              # If omitted or null, mTLS is not used.
               client_key_file:
-              # Configure mTLS client certificate. 
-              # Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
-              # If omitted or null, mTLS is not used.
               client_certificate_file:
-            # Configure compression.
-            # Values include: gzip, none. Implementations may support other compression algorithms.
-            # If omitted or null, none is used.
             compression: gzip
-            # Configure max time (in milliseconds) to wait for each export.
-            # Value must be non-negative. A value of 0 indicates no limit (infinity).
-            # If omitted or null, 10000 is used.
             timeout: 10000
-  # Configure span limits. See also attribute_limits.
   limits:
-    # Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. 
-    # Value must be non-negative.
-    # If omitted or null, there is no limit.
     attribute_value_length_limit:
-    # Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. 
-    # Value must be non-negative.
-    # If omitted or null, 128 is used.
     attribute_count_limit: 128
-    # Configure max span event count. 
-    # Value must be non-negative.
-    # If omitted or null, 128 is used.
     event_count_limit: 128
-    # Configure max span link count. 
-    # Value must be non-negative.
-    # If omitted or null, 128 is used.
     link_count_limit: 128
-    # Configure max attributes per span event. 
-    # Value must be non-negative.
-    # If omitted or null, 128 is used.
     event_attribute_count_limit: 128
-    # Configure max attributes per span link. 
-    # Value must be non-negative.
-    # If omitted or null, 128 is used.
     link_attribute_count_limit: 128
-  # Configure the sampler.
-  # If omitted, parent based sampler with a root of always_on is used.
   sampler:
-    # Configure sampler to be parent_based.
     parent_based:
-      # Configure root sampler.
-      # If omitted or null, always_on is used.
       root:
-        # Configure sampler to be always_on.
         always_on:
-      # Configure remote_parent_sampled sampler.
-      # If omitted or null, always_on is used.
       remote_parent_sampled:
-        # Configure sampler to be always_on.
         always_on:
-      # Configure remote_parent_not_sampled sampler.
-      # If omitted or null, always_off is used.
       remote_parent_not_sampled:
-        # Configure sampler to be always_off.
         always_off:
-      # Configure local_parent_sampled sampler.
-      # If omitted or null, always_on is used.
       local_parent_sampled:
-        # Configure sampler to be always_on.
         always_on:
-      # Configure local_parent_not_sampled sampler.
-      # If omitted or null, always_off is used.
       local_parent_not_sampled:
-        # Configure sampler to be always_off.
         always_off:
-# Configure meter provider.
-# If omitted, a noop meter provider is used.
 meter_provider:
-  # Configure metric readers.
   readers:
-    - # Configure a periodic metric reader.
-      periodic:
-        # Configure delay interval (in milliseconds) between start of two consecutive exports. 
-        # Value must be non-negative.
-        # If omitted or null, 60000 is used.
+    - periodic:
         interval: 60000
-        # Configure maximum allowed time (in milliseconds) to export data. 
-        # Value must be non-negative. A value of 0 indicates no limit (infinity).
-        # If omitted or null, 30000 is used.
         timeout: 30000
-        # Configure exporter.
         exporter:
-          # Configure exporter to be OTLP with HTTP transport.
           otlp_http:
-            # Configure endpoint, including the signal specific path.
-            # If omitted or null, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used.
             endpoint: http://localhost:4318/v1/metrics
-            # Configure TLS settings for the exporter.
             tls:
-              # Configure certificate used to verify a server's TLS credentials. 
-              # Absolute path to certificate file in PEM format.
-              # If omitted or null, system default certificate verification is used for secure connections.
               certificate_file:
-              # Configure mTLS private client key. 
-              # Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
-              # If omitted or null, mTLS is not used.
               client_key_file:
-              # Configure mTLS client certificate. 
-              # Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
-              # If omitted or null, mTLS is not used.
               client_certificate_file:
-            # Configure compression.
-            # Values include: gzip, none. Implementations may support other compression algorithms.
-            # If omitted or null, none is used.
             compression: gzip
-            # Configure max time (in milliseconds) to wait for each export.
-            # Value must be non-negative. A value of 0 indicates no limit (infinity).
-            # If omitted or null, 10000 is used.
             timeout: 10000
-            # Configure temporality preference.
-            # Values include: cumulative, delta, low_memory. For behavior of values, see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk_exporters/otlp.md.
-            # If omitted or null, cumulative is used.
             temporality_preference: cumulative
-            # Configure default histogram aggregation.
-            # Values include: explicit_bucket_histogram, base2_exponential_bucket_histogram. For behavior of values, see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk_exporters/otlp.md.
-            # If omitted or null, explicit_bucket_histogram is used.
             default_histogram_aggregation: explicit_bucket_histogram
-  # Configure the exemplar filter. 
-  # Values include: trace_based, always_on, always_off. For behavior of values see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#metrics-sdk-configuration.
-  # If omitted or null, trace_based is used.
   exemplar_filter: trace_based
-# Configure logger provider.
-# If omitted, a noop logger provider is used.
 logger_provider:
-  # Configure log record processors.
   processors:
-    - # Configure a batch log record processor.
-      batch:
-        # Configure delay interval (in milliseconds) between two consecutive exports. 
-        # Value must be non-negative.
-        # If omitted or null, 1000 is used.
+    - batch:
         schedule_delay: 1000
-        # Configure maximum allowed time (in milliseconds) to export data. 
-        # Value must be non-negative. A value of 0 indicates no limit (infinity).
-        # If omitted or null, 30000 is used.
         export_timeout: 30000
-        # Configure maximum queue size. Value must be positive.
-        # If omitted or null, 2048 is used.
         max_queue_size: 2048
-        # Configure maximum batch size. Value must be positive.
-        # If omitted or null, 512 is used.
         max_export_batch_size: 512
-        # Configure exporter.
         exporter:
-          # Configure exporter to be OTLP with HTTP transport.
           otlp_http:
-            # Configure endpoint, including the signal specific path.
-            # If omitted or null, the http://localhost:4318/v1/{signal} (where signal is 'traces', 'logs', or 'metrics') is used.
             endpoint: http://localhost:4318/v1/logs
-            # Configure TLS settings for the exporter.
             tls:
-              # Configure certificate used to verify a server's TLS credentials. 
-              # Absolute path to certificate file in PEM format.
-              # If omitted or null, system default certificate verification is used for secure connections.
               certificate_file:
-              # Configure mTLS private client key. 
-              # Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
-              # If omitted or null, mTLS is not used.
               client_key_file:
-              # Configure mTLS client certificate. 
-              # Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
-              # If omitted or null, mTLS is not used.
               client_certificate_file:
-            # Configure compression.
-            # Values include: gzip, none. Implementations may support other compression algorithms.
-            # If omitted or null, none is used.
             compression: gzip
-            # Configure max time (in milliseconds) to wait for each export.
-            # Value must be non-negative. A value of 0 indicates no limit (infinity).
-            # If omitted or null, 10000 is used.
             timeout: 10000
-  # Configure log record limits. See also attribute_limits.
   limits:
-    # Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. 
-    # Value must be non-negative.
-    # If omitted or null, there is no limit.
     attribute_value_length_limit:
-    # Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. 
-    # Value must be non-negative.
-    # If omitted or null, 128 is used.
     attribute_count_limit: 128