Merge remote-tracking branch 'origin/main' into otelbot/spec-integration-v1.51.0-dev

Author: otelbot[bot]

content/en/docs/contributing/pr-checks.md

@@ -82,15 +82,15 @@ This check will verify that all words in your cSpell ignore list are normalized.
 If this check fails, run `npm run fix:dict` locally and push the changes in a
 new commit.
 
-### `FILENAME check` {.notranslate lang=en}
+### `FILE FORMAT` {.notranslate lang=en}
 
-This check verifies that all
-[files are formatted by prettier](../style-guide/#file-format).
+This check verifies that all files conform to
+[Prettier format rules](../style-guide/#file-format).
 
 If this check fails, run `npm run fix:format` locally and push the changes in a
 new commit.
 
-### `FILE FORMAT` {.notranslate lang=en}
+### `FILENAME check` {.notranslate lang=en}
 
 This check verifies that all
 [file names are in kebab-case](../style-guide/#file-names).

content/en/docs/contributing/style-guide.md

@@ -88,8 +88,13 @@ title: registryEntryTitle
 
 ## File format
 
-We enforce file formatting using [Prettier]. Invoke it using
-`npm run fix:format`.
+We use [Prettier] to enforce file formatting. Invoke it using:
+
+- `npm run fix:format` to format all files
+- `npm run fix:format:diff` to format only the files that have changed since the
+  last commit
+- `npm run fix:format:staged` to format only the files that are staged for the
+  next commit
 
 ## File names
 

content/en/docs/languages/sdk-configuration/general.md

@@ -9,7 +9,7 @@ cSpell:ignore: ottrace
 {{% alert title="Note" %}}
 
 Support for environment variables is optional. For detailed information on which
-environment variables each language implementation supports, please consult the
+environment variables each language implementation supports, see the
 [Implementation Compliance Matrix](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md#environment-variables).
 
 {{% /alert %}}
@@ -19,63 +19,70 @@ environment variables each language implementation supports, please consult the
 Sets the value of the [`service.name`](/docs/specs/semconv/resource/#service)
 resource attribute.
 
-**Default value:** `"unknown_service"`
+**Default value:** `unknown_service`
 
 If `service.name` is also provided in `OTEL_RESOURCE_ATTRIBUTES`, then
 `OTEL_SERVICE_NAME` takes precedence.
 
 **Example:**
 
-`export OTEL_SERVICE_NAME="your-service-name"`
+```sh
+export OTEL_SERVICE_NAME="your-service-name"
+```
 
 ## `OTEL_RESOURCE_ATTRIBUTES`
 
-Key-value pairs to be used as resource attributes. See
-[Resource SDK](/docs/specs/otel/resource/sdk#specifying-resource-information-via-an-environment-variable)
-for more details.
-
-**Default value:** Empty.
+Key-value pairs to be used as resource attributes.
 
-See
-[Resource semantic conventions](/docs/specs/semconv/resource/#semantic-attributes-with-sdk-provided-default-value)
-for semantic conventions to follow for common resource types.
+**Default value:** empty
 
 **Example:**
 
-`export OTEL_RESOURCE_ATTRIBUTES="key1=value1,key2=value2"`
+```sh
+export OTEL_RESOURCE_ATTRIBUTES="key1=value1,key2=value2"
+```
+
+**References:**
+
+- [Resource SDK](/docs/specs/otel/resource/sdk#specifying-resource-information-via-an-environment-variable)
+- [Resource semantic conventions](/docs/specs/semconv/resource/#semantic-attributes-with-sdk-provided-default-value)
+  for common resource type semantic conventions
 
 ## `OTEL_TRACES_SAMPLER`
 
 Specifies the Sampler used to sample traces by the SDK.
 
-**Default value:** `"parentbased_always_on"`
+**Default value:** `parentbased_always_on`
 
 **Example:**
 
-`export OTEL_TRACES_SAMPLER="traceidratio"`
+```sh
+export OTEL_TRACES_SAMPLER="traceidratio"
+```
 
 Accepted values for `OTEL_TRACES_SAMPLER` are:
 
-- `"always_on"`: `AlwaysOnSampler`
-- `"always_off"`: `AlwaysOffSampler`
-- `"traceidratio"`: `TraceIdRatioBased`
-- `"parentbased_always_on"`: `ParentBased(root=AlwaysOnSampler)`
-- `"parentbased_always_off"`: `ParentBased(root=AlwaysOffSampler)`
-- `"parentbased_traceidratio"`: `ParentBased(root=TraceIdRatioBased)`
-- `"parentbased_jaeger_remote"`: `ParentBased(root=JaegerRemoteSampler)`
-- `"jaeger_remote"`: `JaegerRemoteSampler`
-- `"xray"`:
-  [AWS X-Ray Centralized Sampling](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-sampling.html)
-  (_third party_)
+- `always_on`: `AlwaysOnSampler`
+- `always_off`: `AlwaysOffSampler`
+- `traceidratio`: `TraceIdRatioBased`
+- `parentbased_always_on`: `ParentBased(root=AlwaysOnSampler)`
+- `parentbased_always_off`: `ParentBased(root=AlwaysOffSampler)`
+- `parentbased_traceidratio`: `ParentBased(root=TraceIdRatioBased)`
+- `parentbased_jaeger_remote`: `ParentBased(root=JaegerRemoteSampler)`
+- `jaeger_remote`: `JaegerRemoteSampler`
+- `xray`: [AWS X-Ray Centralized Sampling][] (_third party_)
+
+[AWS X-Ray Centralized Sampling]:
+  https://docs.aws.amazon.com/xray/latest/devguide/xray-console-sampling.html
 
 ## `OTEL_TRACES_SAMPLER_ARG`
 
-Specifies arguments, if applicable, to the sampler defined in by
+Specifies arguments, if applicable, to the sampler defined by
 `OTEL_TRACES_SAMPLER`. The specified value will only be used if
 `OTEL_TRACES_SAMPLER` is set. Each Sampler type defines its own expected input,
 if any. Invalid or unrecognized input is logged as an error.
 
-**Default value:** Empty.
+**Default value:** empty
 
 **Example:**
 
@@ -93,7 +100,7 @@ be set as follows:
 - For `jaeger_remote` and `parentbased_jaeger_remote`: The value is a comma
   separated list:
   - Example:
-    `"endpoint=http://localhost:14250,pollingIntervalMs=5000,initialSamplingRate=0.25"`
+    `endpoint=http://localhost:14250,pollingIntervalMs=5000,initialSamplingRate=0.25`
   - `endpoint`: the endpoint in form of `scheme://host:port` of gRPC server that
     serves the sampling strategy for the service
     ([sampling.proto](https://github.com/jaegertracing/jaeger-idl/blob/main/proto/api_v2/sampling.proto)).
@@ -109,82 +116,80 @@ be set as follows:
 
 Specifies Propagators to be used in a comma-separated list.
 
-**Default value:** `"tracecontext,baggage"`
+**Default value:** `tracecontext,baggage`
 
 **Example:**
 
 `export OTEL_PROPAGATORS="b3"`
 
 Accepted values for `OTEL_PROPAGATORS` are:
 
-- `"tracecontext"`: [W3C Trace Context](https://www.w3.org/TR/trace-context/)
-- `"baggage"`: [W3C Baggage](https://www.w3.org/TR/baggage/)
-- `"b3"`: [B3 Single](/docs/specs/otel/context/api-propagators#configuration)
-- `"b3multi"`:
-  [B3 Multi](/docs/specs/otel/context/api-propagators#configuration)
-- `"jaeger"`:
+- `tracecontext`: [W3C Trace Context](https://www.w3.org/TR/trace-context/)
+- `baggage`: [W3C Baggage](https://www.w3.org/TR/baggage/)
+- `b3`: [B3 Single](/docs/specs/otel/context/api-propagators#configuration)
+- `b3multi`: [B3 Multi](/docs/specs/otel/context/api-propagators#configuration)
+- `jaeger`:
   [Jaeger](https://www.jaegertracing.io/docs/1.21/client-libraries/#propagation-format)
-- `"xray"`:
+- `xray`:
   [AWS X-Ray](https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader)
   (_third party_)
-- `"ottrace"`:
-  [OT Trace](https://github.com/opentracing?q=basic&type=&language=) (_third
-  party_)
-- `"none"`: No automatically configured propagator.
+- `ottrace`: [OT Trace](https://github.com/opentracing?q=basic&type=&language=)
+  (_third party_)
+- `none`: No automatically configured propagator.
 
 ## `OTEL_TRACES_EXPORTER`
 
 Specifies which exporter is used for traces. Depending on the implementation it
 may be a comma-separated list.
 
-**Default value:** `"otlp"`
+**Default value:** `otlp`
 
 **Example:**
 
 `export OTEL_TRACES_EXPORTER="jaeger"`
 
 Accepted values for are:
 
-- `"otlp"`: [OTLP][]
-- `"jaeger"`: export in Jaeger data model
-- `"zipkin"`: [Zipkin](https://zipkin.io/zipkin-api/)
-- `"console"`: [Standard Output](/docs/specs/otel/trace/sdk_exporters/stdout/)
-- `"none"`: No automatically configured exporter for traces.
+- `otlp`: [OTLP][]
+- `jaeger`: Export in Jaeger data model.
+- `zipkin`: [Zipkin](https://zipkin.io/zipkin-api/)
+- `console`: [Standard Output](/docs/specs/otel/trace/sdk_exporters/stdout/)
+- `none`: No automatically configured exporter for traces.
 
 ## `OTEL_METRICS_EXPORTER`
 
 Specifies which exporter is used for metrics. Depending on the implementation it
 may be a comma-separated list.
 
-**Default value:** `"otlp"`
+**Default value:** `otlp`
 
 **Example:**
 
 `export OTEL_METRICS_EXPORTER="prometheus"`
 
 Accepted values for `OTEL_METRICS_EXPORTER` are:
 
-- `"otlp"`: [OTLP][]
-- `"prometheus"`:
+- `otlp`: [OTLP]
+- `prometheus`:
   [Prometheus](https://github.com/prometheus/docs/blob/main/docs/instrumenting/exposition_formats.md)
-- `"console"`: [Standard Output](/docs/specs/otel/metrics/sdk_exporters/stdout/)
-- `"none"`: No automatically configured exporter for metrics.
+- `console`: [Standard Output](/docs/specs/otel/metrics/sdk_exporters/stdout/)
+- `none`: No automatically configured exporter for metrics.
 
 ## `OTEL_LOGS_EXPORTER`
 
 Specifies which exporter is used for logs. Depending on the implementation it
 may be a comma-separated list.
 
-**Default value:** `"otlp"`
+**Default value:** `otlp`
 
 **Example:**
 
 `export OTEL_LOGS_EXPORTER="otlp"`
 
 Accepted values for `OTEL_LOGS_EXPORTER` are:
 
-- `"otlp"`: [OTLP][]
-- `"console"`: [Standard Output](/docs/specs/otel/logs/sdk_exporters/stdout/)
-- `"none"`: No automatically configured exporter for logs.
+- `otlp`: [OTLP]
+- `console`: [Standard Output](/docs/specs/otel/logs/sdk_exporters/stdout/)
+- `none`: No automatically configured exporter for logs.
 
 [otlp]: /docs/specs/otlp/

data/community/members.yaml

@@ -5,12 +5,12 @@ governance-committee:
   - name: austinlparker
     html_url: https://github.com/austinlparker
     avatar_url: https://avatars.githubusercontent.com/u/4140740?v=4
-  - name: danielgblanco
-    html_url: https://github.com/danielgblanco
-    avatar_url: https://avatars.githubusercontent.com/u/4158734?v=4
   - name: jpkrohling
     html_url: https://github.com/jpkrohling
     avatar_url: https://avatars.githubusercontent.com/u/13387?v=4
+  - name: maryliag
+    html_url: https://github.com/maryliag
+    avatar_url: https://avatars.githubusercontent.com/u/1017486?v=4
   - name: mtwo
     html_url: https://github.com/mtwo
     avatar_url: https://avatars.githubusercontent.com/u/1144235?v=4

package.json

@@ -7,7 +7,7 @@
     "__check:links": "make --keep-going check-links",
     "__check:format:nowrap": "npm run _check:format:any -- --prose-wrap preserve",
     "_build": "npm run _hugo -- -e dev --buildDrafts --buildFuture --baseURL \"${DEPLOY_PRIME_URL:-http://localhost}\"",
-    "__check:format": "./scripts/npx-helper.sh prettier",
+    "__check:format": "./scripts/npx-helper.sh prettier --ignore-unknown",
     "_check:format:any": "npm run __check:format -- --check --ignore-path ''",
     "_check:format:nowrap": "npm run __check:format:nowrap -- content/ja content/uk content/zh",
     "_check:format": "npm run __check:format -- --check .",
@@ -24,7 +24,7 @@
     "_fail": "exit 1",
     "_filename-error": "echo 'ERROR: the following files violate naming conventions; fix using: `npm run fix:filenames`'; echo; npm run -s _ls-bad-filenames; exit 1",
     "_fix:trailing-spaces": "find content -name '*.md' -exec perl -i -pe 's/[ \t]+$//g' {} +",
-    "_fix:format:diff": "npm run __check:format -- --write $(npm -s run _list:diff)",
+    "_fix:format:diff": "npm run __check:format -- --write",
     "_get:no": "echo SKIPPING get operation",
     "_get:submodule": "set -x && git submodule update --init ${DEPTH:- --depth 999}",
     "_hugo": "hugo --cleanDestinationDir",
@@ -33,7 +33,8 @@
     "_list:check:*": "npm run --loglevel=warn | grep -Ee '^\\s*check:[^:]+$'",
     "_list:check:for-test-and-fix": "npm -s run _list:check:* | grep -Ev \"i18n|${CMD_SKIP:-noop}\"",
     "_list:dict": "grep '^\\s*\"@cspell' package.json | awk -F: '{print $1}'  | tr -d '\"'",
-    "_list:diff": "git diff --name-only --diff-filter=AM",
+    "_list:diff-never-empty": "echo README.md && npm run _list:diff",
+    "_list:diff": "git diff --name-only --diff-filter=AMR",
     "_list:fix:*": "npm run --loglevel=warn | grep -Ee '^\\s*fix:[^:]+$' | grep -v 'fix:all'",
     "_list:fix:for-test-and-fix": "npm -s run _list:fix:* | grep -Ev \"i18n|refcache|submodule|${CMD_SKIP:-noop}\"",
     "_ls-bad-filenames": "find assets content static -name '*_*' ! -name '[_.]*'",
@@ -72,6 +73,8 @@
     "fix:dict": "find content layouts -name \"*.md\" -print0 | xargs -0 scripts/normalize-cspell-front-matter.pl",
     "fix:expired": "npm run -s check:expired -- -q | xargs -r -I {} sh -c 'echo \"Deleting expired file: {}\" && rm {}'",
     "fix:filenames": "npm run _rename-to-kebab-case",
+    "fix:format:diff": "npm run _fix:format:diff -- $(npm -s run _list:diff-never-empty)",
+    "fix:format:staged": "npm run _fix:format:diff -- $(npm -s run _list:diff-never-empty -- --cached)",
     "fix:format": "npm run format; npm run _fix:trailing-spaces",
     "fix:htmltest-config": "scripts/htmltest-config.sh",
     "fix:i18n:status": "scripts/check-i18n.sh -D",

scripts/git/pre-commit.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+#
+# Pre-commit hook that runs formatting on staged files
+#
+
+exec npm run fix:format:staged
+