diff --git a/.codespellignore b/.codespellignore deleted file mode 100644 index c43186667f..0000000000 --- a/.codespellignore +++ /dev/null @@ -1,2 +0,0 @@ -ot -te diff --git a/.codespellrc b/.codespellrc deleted file mode 100644 index 0dbfda339f..0000000000 --- a/.codespellrc +++ /dev/null @@ -1,10 +0,0 @@ -# https://github.com/codespell-project/codespell -[codespell] -builtin = clear,rare,informal -check-filenames = -check-hidden = -ignore-words = .codespellignore -interactive = 1 -skip = .git,venv,coverage,doc,docs -uri-ignore-words-list = * -write = diff --git a/.cspell.yml b/.cspell.yml new file mode 100644 index 0000000000..76c42e800c --- /dev/null +++ b/.cspell.yml @@ -0,0 +1,78 @@ +# cSpell:ignore textlintrc +# For settings, see +# https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/ +version: "0.2" +caseSensitive: false +useGitignore: true +enableGlobDot: true +import: + - https://cdn.jsdelivr.net/npm/@cspell/dict-people-names/cspell-ext.json + - https://cdn.jsdelivr.net/npm/@cspell/dict-redis/cspell-ext.json +ignorePaths: + - ".git" + - "bin" + - "CODEOWNERS" + - "*.j2" + - "*.thrift" +patterns: + - name: CodeBlock + pattern: | + / + ^(\s*[~`]{3,}) # code-block start + .* # all languages and options, e.g. shell {hl_lines=[12]} + [\s\S]*? # content + \1 # code-block end + /igmx + - name: CodeName + pattern: | + / + ([~`]) # Matches a single backtick or tilde to start a code block. + [^~`]*? # Matches any characters except backticks or tildes, non-greedy. + \1 # Matches the same symbol which started the match. + /x + - name: "GitHub Handle" + pattern: "@[a-zA-Z0-9-_]+\\b" +languageSettings: + - languageId: json, jsonc + includeRegExpList: + - CStyleComment + - languageId: markdown + ignoreRegExpList: + - CodeBlock + - CodeName + - GitHub Handle + - languageId: ruby + includeRegExpList: + - "#.*/g" + ignoreRegExpList: + - CodeName + - languageId: dockerfile, dockercompose, properties, yaml + includeRegExpList: + - "/#.*/g" + ignoreRegExpList: + - CodeName +dictionaries: + - aws + - companies + - people-names + - ruby + - ruby-gems + - softwareTerms + - software-tools + - redis +ignoreWords: + - kwarg + - MILLIS + - otcorrelations + - Rubyish +words: + - LOGRECORD + - traceid + - tracestate + - loggregator + - configurator + + - autocorrection + + - linkspector + - SARIF diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 66d9ba247e..cced51834a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Notify us of an error or incorrect behaviour +about: Notify us of an error or incorrect behavior title: '' labels: 'bug' assignees: '' @@ -9,7 +9,7 @@ assignees: '' @@ -17,7 +17,7 @@ NOTE: Please use this form to submit bugs or demonstrations of non spec complian diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3572c63ab0..c11f4b85c9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -218,9 +218,15 @@ jobs: gem: "${{ matrix.gem }}" ruby: "truffleruby" - codespell: + spelling-check: if: ${{ github.repository == 'open-telemetry/opentelemetry-ruby' }} + name: Spelling Check runs-on: ubuntu-latest steps: - - uses: actions/checkout@v6 - - run: make codespell + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 + - uses: streetsidesoftware/cspell-action@24fa8d3096a314ce263f39578744e9d9f8d80acf # v8.1.2 + with: + use_cspell_files: true + config: .cspell.yml + suggestions: true + treat_flagged_words_as_errors: true diff --git a/.github/workflows/fossa.yml b/.github/workflows/fossa.yml index 5008a3856e..a85993eeb2 100644 --- a/.github/workflows/fossa.yml +++ b/.github/workflows/fossa.yml @@ -36,7 +36,7 @@ jobs: echo "Current directory: $(pwd)" echo "Creating lock file for: $gemfile" - # Generate the gemlock files + # Generate the Gemfile.lock files bundle lock || echo "Warning: Failed to generate lock file for $gemfile, continuing..." cd "$ORIGINAL_DIR" || exit 1 diff --git a/.gitignore b/.gitignore index 9d20c23219..c8016688c9 100644 --- a/.gitignore +++ b/.gitignore @@ -22,7 +22,4 @@ # rbenv configuration .ruby-version -# Python virtual env for codespell -venv - tags diff --git a/.toys/.data/releases.yml b/.toys/.data/releases.yml index d2c3b5c8c4..3737f557ef 100644 --- a/.toys/.data/releases.yml +++ b/.toys/.data/releases.yml @@ -19,7 +19,7 @@ commit_lint: # Merge types allowed by the repo. merge: squash -# List of all releaseable gems. Each gem should include: +# List of all releasable gems. Each gem should include: # * name: The name of the gem. (Required.) # * directory: Gem directory relative to the repo root. (Required.) # * version_rb_path: Path to version.rb relative to the gem directory. @@ -28,7 +28,7 @@ commit_lint: # * version_constant: The fully-qualified version constant as an array. # (Required because the OpenTelemetry namespace does not match the gem # name "opentelemetry".) -# * changelog_path: Path to CHANGLEOG.md relative to the gem directory. +# * changelog_path: Path to CHANGELOG.md relative to the gem directory. # (Required only if it is not in the expected location.) gems: - name: opentelemetry-api @@ -61,7 +61,7 @@ gems: - name: opentelemetry-exporter-otlp # we append a slash here to avoid the naive substring start_with? directory-matching condition in underlying toys gem - # which casues exporter/otlp to incorrectly match when changes occur in exporter/otlp-logs or exporter/otlp-metrics + # which causes exporter/otlp to incorrectly match when changes occur in exporter/otlp-logs or exporter/otlp-metrics # https://github.com/dazuma/toys/blob/17ed449da8299f272b834470ff6b279a59e8070b/.toys/release/.lib/release_utils.rb#L436 # https://github.com/open-telemetry/opentelemetry-ruby/issues/1792 directory: exporter/otlp/ diff --git a/CHANGELOG.md b/CHANGELOG.md index e9c8721cd0..d0075b1fd9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,7 @@ All notable changes to this project were documented in this file. This is of his ### Bug Fix -* [#299](https://github.com/open-telemetry/opentelemetry-ruby/pull/299) Fix probabilility sampler. ([@fbogsany](https://github.com/fbogsany)) +* [#299](https://github.com/open-telemetry/opentelemetry-ruby/pull/299) Fix probability sampler. ([@fbogsany](https://github.com/fbogsany)) * [#301](https://github.com/open-telemetry/opentelemetry-ruby/pull/301) Fix require 'opentelemetry/instrumentation'. ([@fbogsany](https://github.com/fbogsany)) diff --git a/Makefile b/Makefile deleted file mode 100644 index 7b9a6baa4d..0000000000 --- a/Makefile +++ /dev/null @@ -1,35 +0,0 @@ -# Virtualized python tools via docker - -# The directory where the virtual environment is created. -VENVDIR := venv - -PYTOOLS := $(VENVDIR)/bin - -# The pip executable in the virtual environment. -PIP := $(PYTOOLS)/pip - -# The directory in the docker image where the current directory is mounted. -WORKDIR := /workdir - -# The python image to use for the virtual environment. -PYTHONIMAGE := python:3.11.3-slim-bullseye - -# Run the python image with the current directory mounted. -DOCKERPY := docker run --rm -v "$(CURDIR):$(WORKDIR)" -w $(WORKDIR) $(PYTHONIMAGE) - -# Create a virtual environment for Python tools. -$(PYTOOLS): -# The `--upgrade` flag is needed to ensure that the virtual environment is -# created with the latest pip version. - @$(DOCKERPY) bash -c "python3 -m venv $(VENVDIR) && $(PIP) install --upgrade pip" - -# Install python packages into the virtual environment. -$(PYTOOLS)/%: $(PYTOOLS) - @$(DOCKERPY) $(PIP) install -r requirements.txt - -CODESPELL = $(PYTOOLS)/codespell -$(CODESPELL): PACKAGE=codespell - -.PHONY: codespell -codespell: $(CODESPELL) - @$(DOCKERPY) $(CODESPELL) diff --git a/api/CHANGELOG.md b/api/CHANGELOG.md index b65442234f..e81ab8fbf9 100644 --- a/api/CHANGELOG.md +++ b/api/CHANGELOG.md @@ -2,10 +2,10 @@ ### v1.7.0 / 2025-09-17 -* BREAKING CHANGE: Remove Span APIs for attributes and events +- BREAKING CHANGE: Remove Span APIs for attributes and events -* ADDED: Add record_exception option for in_span -* FIXED: Remove Span APIs for attributes and events +- ADDED: Add record_exception option for in_span +- FIXED: Remove Span APIs for attributes and events ### v1.6.0 / 2025-08-14 @@ -190,7 +190,7 @@ ### v0.7.0 / 2020-10-07 - FIXED: Safely navigate span variable during error cases -- DOCS: Standardize toplevel docs structure and readme +- DOCS: Standardize top-level docs structure and readme - DOCS: Fix param description in TextMapInjector for Baggage ### v0.6.0 / 2020-09-10 diff --git a/exporter/jaeger/CHANGELOG.md b/exporter/jaeger/CHANGELOG.md index 0091053637..d60b31b4d9 100644 --- a/exporter/jaeger/CHANGELOG.md +++ b/exporter/jaeger/CHANGELOG.md @@ -111,7 +111,7 @@ - ADDED: Add service_version setter to configurator - FIXED: Update IL attribute naming convention to match spec -- DOCS: Standardize toplevel docs structure and readme +- DOCS: Standardize top-level docs structure and readme - DOCS: Use BatchSpanProcessor in examples ### v0.6.0 / 2020-09-10 diff --git a/exporter/otlp-logs/README.md b/exporter/otlp-logs/README.md index e1a9b9a5bc..093ef94320 100644 --- a/exporter/otlp-logs/README.md +++ b/exporter/otlp-logs/README.md @@ -128,7 +128,7 @@ $> bundle exec rake test ``` -**Commit the chnages and open a PR!** +**Commit the changes and open a PR!** [opentelemetry-collector-home]: https://opentelemetry.io/docs/collector/about/ [opentelemetry-home]: https://opentelemetry.io diff --git a/exporter/otlp/CHANGELOG.md b/exporter/otlp/CHANGELOG.md index ee0936ad92..e308eac718 100644 --- a/exporter/otlp/CHANGELOG.md +++ b/exporter/otlp/CHANGELOG.md @@ -2,11 +2,11 @@ ### v0.31.1 / 2025-10-21 -* FIXED: Requires minimum SDK support for new parent_span_is_remote attribute +- FIXED: Requires minimum SDK support for new parent_span_is_remote attribute ### v0.31.0 / 2025-10-14 -* ADDED: Add span flags support for isRemote property +- ADDED: Add span flags support for isRemote property ### v0.30.0 / 2025-02-25 @@ -98,7 +98,7 @@ ### v0.20.6 / 2021-10-29 -- FIXED: Add unexpected error handlign in BSP and OTLP exporter (#995) +- FIXED: Add unexpected error handling in BSP and OTLP exporter (#995) - FIXED: Handle otlp exporter race condition gzip errors with retry ### v0.20.5 / 2021-09-29 @@ -216,7 +216,7 @@ - FIXED: OTLP parent_span_id should be nil for root - DOCS: Fix use of add_event in OTLP doc -- DOCS: Standardize toplevel docs structure and readme +- DOCS: Standardize top-level docs structure and readme - DOCS: Use BatchSpanProcessor in examples ### v0.6.0 / 2020-09-10 diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index ab09daf9d5..0000000000 --- a/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -codespell==2.3.0 diff --git a/sdk/CHANGELOG.md b/sdk/CHANGELOG.md index d1d63560ef..5f04dce5e7 100644 --- a/sdk/CHANGELOG.md +++ b/sdk/CHANGELOG.md @@ -2,11 +2,11 @@ ### v1.10.0 / 2025-10-14 -* ADDED: Add span flags support for isRemote property +- ADDED: Add span flags support for isRemote property ### v1.9.0 / 2025-09-16 -* ADDED: Add record_exception option for in_span +- ADDED: Add record_exception option for in_span ### v1.8.1 / 2025-08-14 @@ -86,7 +86,7 @@ ### v1.0.1 / 2021-10-29 -- FIXED: Add unexpected error handlign in BSP and OTLP exporter (#995) +- FIXED: Add unexpected error handling in BSP and OTLP exporter (#995) ### v1.0.0 / 2021-09-29 @@ -267,7 +267,7 @@ - FIXED: Fork safety for batch processor - FIXED: Don't generate a span ID unnecessarily - DOCS: Fix Configurator#add_span_processor -- DOCS: Standardize toplevel docs structure and readme +- DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/aws/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aws/attributes.rb index f7a38d65a9..7be0532442 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/aws/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aws/attributes.rb @@ -338,7 +338,7 @@ module AWS # AWS_LAMBDA_INVOKED_ARN = 'aws.lambda.invoked_arn' - # The UUID of the [AWS Lambda EvenSource Mapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html). An event source is mapped to a lambda function. It's contents are read by Lambda and used to trigger a function. This isn't available in the lambda execution context or the lambda runtime environtment. This is going to be populated by the AWS SDK for each language when that UUID is present. Some of these operations are Create/Delete/Get/List/Update EventSourceMapping. + # The UUID of the [AWS Lambda EvenSource Mapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html). An event source is mapped to a lambda function. It's contents are read by Lambda and used to trigger a function. This isn't available in the lambda execution context or the lambda runtime environment. This is going to be populated by the AWS SDK for each language when that UUID is present. Some of these operations are Create/Delete/Get/List/Update EventSourceMapping. # # @note Stability Level: development #