From 5a6205be047e67fe0aa5dd8cb2206864ea01788e Mon Sep 17 00:00:00 2001 From: OpenTelemetry Bot <107717825+opentelemetrybot@users.noreply.github.com> Date: Tue, 6 Aug 2024 03:54:45 -0500 Subject: [PATCH 1/9] Auto-update registry versions (fe1a8eb25735740bb17c7e2d55c9247907fa1688) (#4968) Co-authored-by: Fabrizio Ferri-Benedetti --- data/registry/instrumentation-js-amqplib.yml | 2 +- data/registry/resource-detector-js-alibabacloud.yml | 2 +- data/registry/resource-detector-js-github.yml | 2 +- data/registry/resource-detector-js-instana.yml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/data/registry/instrumentation-js-amqplib.yml b/data/registry/instrumentation-js-amqplib.yml index f31e0fb2e998..8fe046580765 100644 --- a/data/registry/instrumentation-js-amqplib.yml +++ b/data/registry/instrumentation-js-amqplib.yml @@ -14,7 +14,7 @@ authors: package: name: '@opentelemetry/instrumentation-amqplib' registry: npm - version: 0.40.0 + version: 0.41.0 urls: repo: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-amqplib createdAt: 2020-06-15 diff --git a/data/registry/resource-detector-js-alibabacloud.yml b/data/registry/resource-detector-js-alibabacloud.yml index d4a03ae7be93..8e80e4f0b29e 100644 --- a/data/registry/resource-detector-js-alibabacloud.yml +++ b/data/registry/resource-detector-js-alibabacloud.yml @@ -16,4 +16,4 @@ createdAt: 2022-12-07 package: registry: npm name: '@opentelemetry/resource-detector-alibaba-cloud' - version: 0.28.10 + version: 0.29.0 diff --git a/data/registry/resource-detector-js-github.yml b/data/registry/resource-detector-js-github.yml index a272355fc910..bcbad98ee343 100644 --- a/data/registry/resource-detector-js-github.yml +++ b/data/registry/resource-detector-js-github.yml @@ -17,4 +17,4 @@ createdAt: 2022-12-07 package: registry: npm name: '@opentelemetry/resource-detector-github' - version: 0.28.2 + version: 0.29.0 diff --git a/data/registry/resource-detector-js-instana.yml b/data/registry/resource-detector-js-instana.yml index 4ca1e3170a04..1aad11b2b029 100644 --- a/data/registry/resource-detector-js-instana.yml +++ b/data/registry/resource-detector-js-instana.yml @@ -17,4 +17,4 @@ createdAt: 2022-12-07 package: registry: npm name: '@opentelemetry/resource-detector-instana' - version: 0.10.0 + version: 0.11.0 From 2889b28a1b8927f3107a2e975199a2153dbf55d1 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 6 Aug 2024 14:02:54 -0400 Subject: [PATCH 2/9] [CI] Run workflows on `merge_group` (#4974) --- .github/workflows/check-format.yml | 1 + .github/workflows/check-i18n.yml | 1 + .github/workflows/check-links.yml | 1 + .github/workflows/check-registry.yml | 1 + .github/workflows/check-spelling.yml | 1 + .github/workflows/check-text.yml | 1 + 6 files changed, 6 insertions(+) diff --git a/.github/workflows/check-format.yml b/.github/workflows/check-format.yml index 84096c8b11e1..8c625eca46f3 100644 --- a/.github/workflows/check-format.yml +++ b/.github/workflows/check-format.yml @@ -1,6 +1,7 @@ name: Files on: + merge_group: pull_request: jobs: diff --git a/.github/workflows/check-i18n.yml b/.github/workflows/check-i18n.yml index 9897cb3c5018..86e90550fe2d 100644 --- a/.github/workflows/check-i18n.yml +++ b/.github/workflows/check-i18n.yml @@ -1,6 +1,7 @@ name: i18n on: + merge_group: pull_request: jobs: diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml index 51f9bffff3b0..9654de10f61e 100644 --- a/.github/workflows/check-links.yml +++ b/.github/workflows/check-links.yml @@ -1,6 +1,7 @@ name: Links on: + merge_group: pull_request: jobs: diff --git a/.github/workflows/check-registry.yml b/.github/workflows/check-registry.yml index 6c80aabfed18..986ec2526b13 100644 --- a/.github/workflows/check-registry.yml +++ b/.github/workflows/check-registry.yml @@ -1,6 +1,7 @@ name: Registry Validation on: + merge_group: pull_request: # Make sure this only runs when registry entries are touched. paths: diff --git a/.github/workflows/check-spelling.yml b/.github/workflows/check-spelling.yml index 7b8c2bdf03de..567ea9e872a2 100644 --- a/.github/workflows/check-spelling.yml +++ b/.github/workflows/check-spelling.yml @@ -1,6 +1,7 @@ name: Spelling on: + merge_group: pull_request: jobs: diff --git a/.github/workflows/check-text.yml b/.github/workflows/check-text.yml index df81709b7cf0..77efa610f16f 100644 --- a/.github/workflows/check-text.yml +++ b/.github/workflows/check-text.yml @@ -1,6 +1,7 @@ name: Linter on: + merge_group: pull_request: jobs: From e8b7dcc74298056cdddd0f3ed4cb5b1296a82bf8 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 6 Aug 2024 15:06:00 -0400 Subject: [PATCH 3/9] [infra] Fix spelling errors, update and sort local dict (#4976) --- .cspell.yml | 7 ++++--- content/en/blog/2022/tail-sampling/index.md | 1 - content/en/docs/concepts/sampling/index.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.cspell.yml b/.cspell.yml index 09674be2f550..532ff7b94363 100644 --- a/.cspell.yml +++ b/.cspell.yml @@ -34,8 +34,8 @@ words: - appender - appenders - aspecto - - autoconfigure - autoconfiguration + - autoconfigure - autoinstrumentation - autoload - autoloaded @@ -46,6 +46,7 @@ words: - cartservice - cassandra - checkoutservice + - Chronosphere - classpath - cncf - currencyservice @@ -112,8 +113,8 @@ words: - otelcol - otep - otlp - - overridable - outro + - overridable - packagist - pageinfo - Paixão @@ -166,6 +167,7 @@ words: - traefik - Trask - uids + - unsampled - unshallow - upstreamed - Villela @@ -173,4 +175,3 @@ words: - WSGI - zend - zipkin - - Chronosphere diff --git a/content/en/blog/2022/tail-sampling/index.md b/content/en/blog/2022/tail-sampling/index.md index 35ec6d785fcb..f84b7a6132cb 100644 --- a/content/en/blog/2022/tail-sampling/index.md +++ b/content/en/blog/2022/tail-sampling/index.md @@ -6,7 +6,6 @@ linkTitle: Tail Sampling date: 2022-09-26 author: '[Reese Lee](https://github.com/reese-lee)' canonical_url: https://newrelic.com/blog/best-practices/open-telemetry-tail-sampling -cSpell:ignore: unsampled --- Tail sampling is useful for identifying issues in your distributed system while diff --git a/content/en/docs/concepts/sampling/index.md b/content/en/docs/concepts/sampling/index.md index a6a2095cb891..dd688b1887c1 100644 --- a/content/en/docs/concepts/sampling/index.md +++ b/content/en/docs/concepts/sampling/index.md @@ -77,7 +77,7 @@ Sampling might not be appropriate for you. You might want to avoid sampling if you meet any of the following criteria: - You generate very little data (tens of small traces per second or lower). -- You only use obsevability data in aggregate, and can thus pre-aggregate data. +- You only use observability data in aggregate, and can thus pre-aggregate data. - You are bound by circumstances such as regulation that prohibit dropping data (and cannot route unsampled data to low-cost storage). From 57cd4f78d61cc1642ce56089aeec7ae278544194 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 6 Aug 2024 15:33:44 -0400 Subject: [PATCH 4/9] [CI] Try to get streetsidesoftware/cspell-action to play nice (#4975) --- .github/workflows/check-spelling.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/check-spelling.yml b/.github/workflows/check-spelling.yml index 567ea9e872a2..41ceef742155 100644 --- a/.github/workflows/check-spelling.yml +++ b/.github/workflows/check-spelling.yml @@ -14,11 +14,12 @@ jobs: with: # Files should be consistent with check:spelling files files: | - content/en/*.md + content/en + data layouts/**/*.md - data/**/* config: .cspell.yml incremental_files_only: false + suggestions: true dict-check: name: CSPELL:IGNORE check From 4dc278f3db4073161490cf5af3238a55840c61e0 Mon Sep 17 00:00:00 2001 From: OpenTelemetry Bot <107717825+opentelemetrybot@users.noreply.github.com> Date: Wed, 7 Aug 2024 03:02:21 -0500 Subject: [PATCH 5/9] Auto-update registry versions (068c2a57ba5d859a3aef1bbab1dd89b41be14448) (#4986) --- data/registry/instrumentation-js-prisma.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/registry/instrumentation-js-prisma.yml b/data/registry/instrumentation-js-prisma.yml index 22fa2390acc4..45973a24bcee 100644 --- a/data/registry/instrumentation-js-prisma.yml +++ b/data/registry/instrumentation-js-prisma.yml @@ -17,4 +17,4 @@ createdAt: 2022-08-25 package: registry: npm name: '@prisma/instrumentation' - version: 5.17.0 + version: 5.18.0 From 8e0d3b4031dd47a60869e4c77dbb1b1f8c7044b2 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 7 Aug 2024 05:26:40 -0400 Subject: [PATCH 6/9] [Docsy] Upgrade to v0.10.0-22-g2295188b (#4983) --- .gitmodules | 2 +- themes/docsy | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitmodules b/.gitmodules index ce8e9cfc5532..ec665fc9ad4f 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,7 +1,7 @@ [submodule "themes/docsy"] path = themes/docsy url = https://github.com/google/docsy.git - docsy-pin = v0.10.0-6-g102892d + docsy-pin = v0.10.0-22-g2295188b docsy-note = "2024-04-01 Switching to google/docsy.git from cncf/docsy.git since we don't have any CNCF customizations." docsy-reminder = "Ensure that any tag referenced by `docsy-pin` is present in the remote repo (url), otherwise add (push) the tags to the repo." [submodule "content-modules/opentelemetry-specification"] diff --git a/themes/docsy b/themes/docsy index 102892d931ab..2295188b164c 160000 --- a/themes/docsy +++ b/themes/docsy @@ -1 +1 @@ -Subproject commit 102892d931ab79b573cb6aeca094b6f0f37b73b1 +Subproject commit 2295188b164c34d7039e77fe537ee469d69085d9 From 7ac35d6b429165bbe6c28bdd91feeae83fd35142 Mon Sep 17 00:00:00 2001 From: Rick Anderson <3605364+Rick-Anderson@users.noreply.github.com> Date: Tue, 6 Aug 2024 23:29:48 -1000 Subject: [PATCH 7/9] Update what-is-opentelemetry.md (#4985) Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com> Co-authored-by: Fabrizio Ferri-Benedetti --- content/en/docs/what-is-opentelemetry.md | 35 ++++++++++++------------ 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/content/en/docs/what-is-opentelemetry.md b/content/en/docs/what-is-opentelemetry.md index 4e5c1db9c431..d6d2180f985c 100644 --- a/content/en/docs/what-is-opentelemetry.md +++ b/content/en/docs/what-is-opentelemetry.md @@ -5,23 +5,24 @@ aliases: [/about, /docs/concepts/what-is-opentelemetry, /otel] weight: 150 --- -OpenTelemetry is an -[Observability](/docs/concepts/observability-primer/#what-is-observability) -framework and toolkit designed to create and manage telemetry data such as -[traces](/docs/concepts/signals/traces/), -[metrics](/docs/concepts/signals/metrics/), and -[logs](/docs/concepts/signals/logs/). Crucially, OpenTelemetry is vendor- and -tool-agnostic, meaning that it can be used with a broad variety of Observability -backends, including open source tools like -[Jaeger](https://www.jaegertracing.io/) and -[Prometheus](https://prometheus.io/), as well as commercial offerings. - -OpenTelemetry is not an observability backend like Jaeger, Prometheus, or other -commercial vendors. OpenTelemetry is focused on the generation, collection, -management, and export of telemetry. A major goal of OpenTelemetry is that you -can easily instrument your applications or systems, no matter their language, -infrastructure, or runtime environment. Crucially, the storage and visualization -of telemetry is intentionally left to other tools. +OpenTelemetry is: + +- An [Observability](/docs/concepts/observability-primer/#what-is-observability) + framework and toolkit designed to create and manage telemetry data such as + [traces](/docs/concepts/signals/traces/), + [metrics](/docs/concepts/signals/metrics/), and + [logs](/docs/concepts/signals/logs/). +- Vendor- and tool-agnostic, meaning that it can be used with a broad variety of + Observability backends, including open source tools like + [Jaeger](https://www.jaegertracing.io/) and + [Prometheus](https://prometheus.io/), as well as commercial offerings. +- Not an observability backend like Jaeger, Prometheus, or other commercial + vendors. +- Focused on the generation, collection, management, and export of telemetry. A + major goal of OpenTelemetry is that you can easily instrument your + applications or systems, no matter their language, infrastructure, or runtime + environment. The storage and visualization of telemetry is intentionally left + to other tools. ## What is observability? From 65fd0c2415d3f56b43c7b55558b86ce5fd70bc94 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 7 Aug 2024 07:17:00 -0400 Subject: [PATCH 8/9] [CI][i18n] Spell check content/pt, and enable other dicts (#4982) --- .cspell.yml | 26 +++++++------------------- .github/workflows/check-spelling.yml | 2 +- package.json | 5 +++-- 3 files changed, 11 insertions(+), 22 deletions(-) diff --git a/.cspell.yml b/.cspell.yml index 532ff7b94363..63d907d68a2a 100644 --- a/.cspell.yml +++ b/.cspell.yml @@ -2,10 +2,15 @@ # For settings, see # https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/ version: '0.2' +language: en-US +import: + - '@cspell/dict-pt-br/cspell-ext.json' caseSensitive: true ignorePaths: - '*.svg' - - 'vendors.yaml' + - vendors.yaml + - content/ja + - content/zh # words here are only listed for their spelling, if there is a certain way # to write a word (e.g. OpenTelemetry vs Opentelemetry or cloud native vs # cloud-native), edit the text-lint rules in .textlintrc.yml @@ -22,12 +27,12 @@ languageSettings: - languageId: markdown ignoreRegExpList: - CodeBlock +dictionaries: [pt-br, companies, cpp, dotnet, golang, node, softwareTerms] words: - accountingservice - actix - adservice - alibaba - - Alloc - Alolita - APAC - appdynamics @@ -35,9 +40,7 @@ words: - appenders - aspecto - autoconfiguration - - autoconfigure - autoinstrumentation - - autoload - autoloaded - autoloader - autoloading @@ -52,7 +55,6 @@ words: - currencyservice - daemonset - datadog - - declarators - discoverability - dotnet - Dyla @@ -67,7 +69,6 @@ words: - github - gitpod - grafana - - gzipped - Hausenblas - hugo - initializers @@ -89,14 +90,11 @@ words: - laravel - lifecycles - lightstep - - linux - Loffay - Mancuso - microservices - mongodb - - mysql - ndjson - - netlify - Neumann - nginx - ocaml @@ -113,20 +111,16 @@ words: - otelcol - otep - otlp - - outro - - overridable - packagist - pageinfo - Paixão - parentbased - Pavol - paymentservice - - pluggable - postgresql - Pranay - Prateek - prepper - - Println - productcatalogservice - prometheus - proto @@ -139,22 +133,16 @@ words: - redis - relref - Rexed - - roadmap - - runtimes - Rynn - semconv - servlet - Severin - Sharma - shippingservice - - shortcode - - snmp - Socha - - sqlite - Stalnaker - stdoutmetric - Strimzi - - subdir - symfony - tabpane - textlint diff --git a/.github/workflows/check-spelling.yml b/.github/workflows/check-spelling.yml index 41ceef742155..51ecbae34101 100644 --- a/.github/workflows/check-spelling.yml +++ b/.github/workflows/check-spelling.yml @@ -14,7 +14,7 @@ jobs: with: # Files should be consistent with check:spelling files files: | - content/en + content data layouts/**/*.md config: .cspell.yml diff --git a/package.json b/package.json index 52b7e46e5c30..adbe3e6248ec 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "check:links": "npm run _check:links", "check:markdown": "scripts/check-markdown-wrapper.sh", "check:registry": "npm run _check:registry -- ", - "check:spelling": "npx cspell --no-progress -c .cspell.yml content/en data 'layouts/**/*.md'", + "check:spelling": "npx cspell --no-progress -c .cspell.yml content data 'layouts/**/*.md'", "check:text": "npm run _check:text -- ", "check": "npm run seq -- $(npm run -s _list:check:*)", "clean": "make clean", @@ -109,14 +109,15 @@ "update:submodule": "set -x && git submodule update --remote ${DEPTH:- --depth 1}" }, "devDependencies": { + "@cspell/dict-pt-br": "^2.3.0", "ajv": "^8.17.1", "ajv-errors": "^3.0.0", "ajv-formats": "^3.0.1", "autoprefixer": "^10.4.20", "cspell": "^8.13.1", "gulp": "^5.0.0", - "js-yaml": "^4.1.0", "hugo-extended": "0.131.0", + "js-yaml": "^4.1.0", "markdown-link-check": "^3.12.2", "markdownlint": "^0.34.0", "postcss-cli": "^11.0.0", From 30783526402b69a3ac44eeb0f6cf066732f0bdca Mon Sep 17 00:00:00 2001 From: Erfan <69160698+Metal-Bat@users.noreply.github.com> Date: Wed, 7 Aug 2024 15:16:42 +0330 Subject: [PATCH 9/9] Fix contributor guide URL (#4978) --- content/en/docs/contributing/_index.md | 2 +- content/en/docs/contributing/requirements.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index 5057845e9788..9cdf69880ed2 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -16,7 +16,7 @@ The following guides describe how to contribute to OpenTelemetry documentation. For guidance on how to contribute to the OpenTelemetry project in general, see the -[OpenTelemetry Contributor Guide](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md) +[OpenTelemetry Contributor Guide](https://github.com/open-telemetry/community/blob/main/guides/contributor/README.md) , which provides details on the Contributor License Agreement and the Code of Conduct. Every language implementation, Collector, and conventions [repository](https://github.com/open-telemetry/) has its own specific diff --git a/content/en/docs/contributing/requirements.md b/content/en/docs/contributing/requirements.md index cd90ca36161f..87e92d63a3b7 100644 --- a/content/en/docs/contributing/requirements.md +++ b/content/en/docs/contributing/requirements.md @@ -18,7 +18,7 @@ locally, see [Development](/docs/contributing/development). ## Sign the CNCF CLA {#sign-the-cla} All OpenTelemetry contributors must read the -[Contributor guide](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md) +[Contributor guide](https://github.com/open-telemetry/community/blob/main/guides/contributor/README.md) and [sign the Contributor License Agreement (CLA)](https://docs.linuxfoundation.org/lfx/easycla/contributors).