From 58fda55b36d082222b800ee1d06e60324e77690e Mon Sep 17 00:00:00 2001 From: Hannah Ramadan <76922290+hannahramadan@users.noreply.github.com> Date: Tue, 16 Jul 2024 15:36:51 -0700 Subject: [PATCH] docs: add cspell to CI (#1061) * docs: add cspell to CI * docs: Update comment --------- Co-authored-by: Kayla Reopelle <87386821+kaylareopelle@users.noreply.github.com> --- .cspell.yml | 83 +++++++++++++++++++ .github/workflows/check-spelling.yml | 17 ++++ README.md | 10 +-- instrumentation/CONTRIBUTING.md | 6 +- instrumentation/README.md | 6 +- instrumentation/action_view/CHANGELOG.md | 2 +- .../active_model_serializers/CHANGELOG.md | 2 +- instrumentation/all/CHANGELOG.md | 4 +- instrumentation/aws_sdk/CHANGELOG.md | 2 +- instrumentation/base/CHANGELOG.md | 10 +-- instrumentation/concurrent_ruby/CHANGELOG.md | 6 +- instrumentation/dalli/CHANGELOG.md | 4 +- instrumentation/delayed_job/CHANGELOG.md | 2 +- instrumentation/ethon/CHANGELOG.md | 4 +- instrumentation/excon/CHANGELOG.md | 4 +- instrumentation/faraday/CHANGELOG.md | 4 +- instrumentation/graphql/CHANGELOG.md | 2 +- instrumentation/http/CHANGELOG.md | 2 +- instrumentation/http_client/CHANGELOG.md | 2 +- instrumentation/lmdb/CHANGELOG.md | 2 +- instrumentation/mongo/CHANGELOG.md | 2 +- instrumentation/mysql2/CHANGELOG.md | 4 +- instrumentation/net_http/CHANGELOG.md | 4 +- instrumentation/pg/CHANGELOG.md | 2 +- instrumentation/que/README.md | 2 +- instrumentation/rack/CHANGELOG.md | 6 +- instrumentation/rails/CHANGELOG.md | 4 +- instrumentation/rdkafka/CHANGELOG.md | 2 +- instrumentation/redis/CHANGELOG.md | 4 +- instrumentation/restclient/CHANGELOG.md | 4 +- instrumentation/ruby_kafka/CHANGELOG.md | 2 +- instrumentation/sidekiq/CHANGELOG.md | 4 +- instrumentation/sinatra/CHANGELOG.md | 4 +- propagator/ottrace/CHANGELOG.md | 2 +- propagator/xray/CHANGELOG.md | 2 +- 35 files changed, 161 insertions(+), 61 deletions(-) create mode 100644 .cspell.yml create mode 100644 .github/workflows/check-spelling.yml diff --git a/.cspell.yml b/.cspell.yml new file mode 100644 index 000000000..c4217065c --- /dev/null +++ b/.cspell.yml @@ -0,0 +1,83 @@ +# cSpell:ignore textlintrc +# For settings, see +# https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/ +version: '0.2' +caseSensitive: false +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 +languageSettings: + - languageId: markdown + ignoreRegExpList: + - CodeBlock +words: + - AWSX + - Azuma + - backports + - behaviour + - Bogsanyi + - callables + - circleci + - Clientcontext + - codeowners + - dalli + - datadog + - enqueuers + - ethon + - excon + - faas + - fanout + - faraday + - gettime + - gemfile + - Gitter + - gruf + - HTTPX + - httpx + - instrumenter + - Laurin + - Lightstep + - linux + - lmdb + - microbenchmarks + - Mustin + - myapp + - namespacing + - opentelemetry + - otelcol + - ottrace + - postgres + - postgresql + - racecar + - rabbitmq + - Railtie + - Rakefile + - Reopelle + - rdkafka + - resque + - restclient + - Robb + - rubocop + - rubydocs + - ruboproof + - rubygems + - Šimánek + - semconv + - sidekiq + - sinatra + - Solarwinds + - spanid + - toolset + - traceid + - traceresponse + - Untrace + - vitess + - webmocks + - Xuan + - yardoc diff --git a/.github/workflows/check-spelling.yml b/.github/workflows/check-spelling.yml new file mode 100644 index 000000000..4d699bea9 --- /dev/null +++ b/.github/workflows/check-spelling.yml @@ -0,0 +1,17 @@ +name: Spelling + +on: + pull_request: + +jobs: + spelling-check: + name: SPELLING check + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: streetsidesoftware/cspell-action@v6 + with: + # Files should be consistent with check:spelling files + files: | + **/*.md + config: .cspell.yml diff --git a/README.md b/README.md index 926def2f1..8be68642e 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ multiple instrumentation libraries. - [SQL Obfuscation](helpers/sql-obfuscation/) ## Additional Libraries -This repository also contains libraries to aid with interoperablity with vendor specific tracing solutions: +This repository also contains libraries to aid with interoperability with vendor specific tracing solutions: - [Context Propagation](propagator/): OTTrace and Amazon X-Ray - [Resource Detectors](resources/): @@ -74,18 +74,18 @@ This repository also contains libraries to aid with interoperablity with vendor OpenTelemetry Ruby follows the [versioning and stability document][otel-versioning] in the OpenTelemetry specification. Notably, we adhere to the outlined version numbering exception, which states that experimental signals may have a `0.x` version number. -### Library Compatability +### Library Compatibility -This project is managed on a volunteer basis and therefore we have limited capacity to support compatability with unmaintained or EOL libraries. +This project is managed on a volunteer basis and therefore we have limited capacity to support compatibility with unmaintained or EOL libraries. -We will regularly review the instrumentations to drop compatability for any versions of Ruby or gems that reach EOL or no longer receive regular maintenance. +We will regularly review the instrumentations to drop compatibility for any versions of Ruby or gems that reach EOL or no longer receive regular maintenance. Should you need instrumentation for _older_ versions of a library then you must pin to a specific version of the instrumentation that supports it, however, you will no longer receive any updates for the instrumentation from this repository. > When a release series is no longer supported, it's your own responsibility to deal with bugs and security issues. We may provide backports of the fixes and publish them to git, however there will be no new versions released. If you are not comfortable maintaining your own versions, you should upgrade to a supported version. -Consult instrumentation gem's README file and gemspec for details about library compatability. +Consult instrumentation gem's README file and gemspec for details about library compatibility. ### Releases diff --git a/instrumentation/CONTRIBUTING.md b/instrumentation/CONTRIBUTING.md index ff45dcbbb..f61b9f14c 100644 --- a/instrumentation/CONTRIBUTING.md +++ b/instrumentation/CONTRIBUTING.md @@ -173,7 +173,7 @@ For example, the `Werewolf` module generated in the example above is available v Whenever possible, use first-party extension points (hooks) to instrument libraries. This ensures that the instrumentation is compatible with the latest versions of the library and that the instrumentation is maintained by the library authors. [`ActiveSupport::Notifications`](https://guides.rubyonrails.org/active_support_instrumentation.html) and `Middleware` are good examples of first-party extension points used by our instrumentation libraries. -Monkey patching is discouraged in OpenTelemetry Ruby because it is the most common source of bugs and incompatability with the libraries we instrument. If you must monkey patch, please ensure that the monkey patch is as isolated as possible and that it is clearly documented. +Monkey patching is discouraged in OpenTelemetry Ruby because it is the most common source of bugs and incompatibility with the libraries we instrument. If you must monkey patch, please ensure that the monkey patch is as isolated as possible and that it is clearly documented. ### Use Semantic Conventions @@ -337,7 +337,7 @@ Add the service container to `jobs/instrumentation_with_services/services` and a > :information_source: Please refer to the official [GitHub Actions Documentation](https://docs.github.com/en/actions/using-containerized-services/about-service-containers) for more information on how to add a service container. -If we determine the service container slows down the test suite significantly, it may make sense to copy the marix and steps stanzas from an existing instrumentation and update it to use the new service container as a dependency: +If we determine the service container slows down the test suite significantly, it may make sense to copy the matrix and steps stanzas from an existing instrumentation and update it to use the new service container as a dependency: ```yaml @@ -407,7 +407,7 @@ In addition to that, there should also be redundant `yardoc` comments in the ent ### Examples -Executuable examples should be included in the `examples` directory that demonstrate how to use the instrumentation in a real-world scenario. +Executable examples should be included in the `examples` directory that demonstrate how to use the instrumentation in a real-world scenario. We recommend using [Bundler's inline gemfile](https://bundler.io/guides/bundler_in_a_single_file_ruby_script.html) to run the examples. Here is an example from the `grape` instrumentation: diff --git a/instrumentation/README.md b/instrumentation/README.md index 770e1a70d..3d0d8b1c1 100644 --- a/instrumentation/README.md +++ b/instrumentation/README.md @@ -40,14 +40,14 @@ Instrumentation-specific documentation can be found in each subdirectory's `READ You also have the option of installing all of the instrumentation libraries by installing `opentelemetry-instrumentation-all`. See that gem's [README](https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/all) for more. -### Maintenance and Version Compatability +### Maintenance and Version Compatibility We are a community of volunteers who do our best to provide our users with up to date support for instrumentations, -however we have limited capacity and are unable to support compatability with EOL or unmaintained libraries. +however we have limited capacity and are unable to support compatibility with EOL or unmaintained libraries. Should you need to instrument an _older_ version of a library you will have to ensure to pin to an instrumentation version that is compatible with that library. -Please review the individual instrumentation READMEs for more information about version compatability. +Please review the individual instrumentation READMEs for more information about version compatibility. ## How can I get involved? diff --git a/instrumentation/action_view/CHANGELOG.md b/instrumentation/action_view/CHANGELOG.md index 2758fae95..c648eace4 100644 --- a/instrumentation/action_view/CHANGELOG.md +++ b/instrumentation/action_view/CHANGELOG.md @@ -43,7 +43,7 @@ ### v0.2.0 / 2021-12-01 -* ADDED: Move activesupport notification subsciber out of action_view gem +* ADDED: Move activesupport notification subscriber out of action_view gem * FIXED: Instrumentation of Rails 7 ### v0.1.3 / 2021-10-06 diff --git a/instrumentation/active_model_serializers/CHANGELOG.md b/instrumentation/active_model_serializers/CHANGELOG.md index bfb5529c5..7cb9de021 100644 --- a/instrumentation/active_model_serializers/CHANGELOG.md +++ b/instrumentation/active_model_serializers/CHANGELOG.md @@ -43,7 +43,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 ### v0.17.0 / 2021-04-22 diff --git a/instrumentation/all/CHANGELOG.md b/instrumentation/all/CHANGELOG.md index 540939338..ba654bcde 100644 --- a/instrumentation/all/CHANGELOG.md +++ b/instrumentation/all/CHANGELOG.md @@ -179,7 +179,7 @@ ### v0.22.0 / 2021-12-01 -* ADDED: Move activesupport notification subsciber out of action_view gem +* ADDED: Move activesupport notification subscriber out of action_view gem ### v0.21.3 / 2021-10-07 @@ -270,7 +270,7 @@ ### v0.7.0 / 2020-10-07 -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/instrumentation/aws_sdk/CHANGELOG.md b/instrumentation/aws_sdk/CHANGELOG.md index f2674ad57..8d6430926 100644 --- a/instrumentation/aws_sdk/CHANGELOG.md +++ b/instrumentation/aws_sdk/CHANGELOG.md @@ -10,7 +10,7 @@ ### v0.5.1 / 2024-02-08 -* FIXED: Return nil for non-existant key in AwsSdk::MessageAttributeGetter +* FIXED: Return nil for non-existent key in AwsSdk::MessageAttributeGetter ### v0.5.0 / 2023-09-07 diff --git a/instrumentation/base/CHANGELOG.md b/instrumentation/base/CHANGELOG.md index b51a63149..fff58375d 100644 --- a/instrumentation/base/CHANGELOG.md +++ b/instrumentation/base/CHANGELOG.md @@ -1,9 +1,9 @@ # Release History: opentelemetry-instrumentation-base -### v0.22.4 / 2024-06-18 - -* FIXED: Relax otel common gem constraints -* DOCS: Add function doc for config_overrides_from_env +### v0.22.4 / 2024-06-18 + +* FIXED: Relax otel common gem constraints +* DOCS: Add function doc for config_overrides_from_env ### v0.22.3 / 2023-11-23 @@ -56,7 +56,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 * FIXED: Missing instrumentation classes during configuration ### v0.17.0 / 2021-04-22 diff --git a/instrumentation/concurrent_ruby/CHANGELOG.md b/instrumentation/concurrent_ruby/CHANGELOG.md index 8182bda89..20cb139c0 100644 --- a/instrumentation/concurrent_ruby/CHANGELOG.md +++ b/instrumentation/concurrent_ruby/CHANGELOG.md @@ -42,7 +42,7 @@ ### v0.19.0 / 2021-09-29 -* ADDED: Add suport for `Concurrent::Promises::Future` +* ADDED: Add support for `Concurrent::Promises::Future` ### v0.18.2 / 2021-08-12 @@ -54,7 +54,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 ### v0.17.0 / 2021-04-22 @@ -104,7 +104,7 @@ ### v0.7.0 / 2020-10-07 * DOCS: Added README for concurrent ruby -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/instrumentation/dalli/CHANGELOG.md b/instrumentation/dalli/CHANGELOG.md index 92c503a09..58380c13a 100644 --- a/instrumentation/dalli/CHANGELOG.md +++ b/instrumentation/dalli/CHANGELOG.md @@ -74,7 +74,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 ### v0.17.0 / 2021-04-22 @@ -123,7 +123,7 @@ ### v0.7.0 / 2020-10-07 -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/instrumentation/delayed_job/CHANGELOG.md b/instrumentation/delayed_job/CHANGELOG.md index 74d258391..8cf7e84a3 100644 --- a/instrumentation/delayed_job/CHANGELOG.md +++ b/instrumentation/delayed_job/CHANGELOG.md @@ -65,7 +65,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 * BREAKING CHANGE: Replace Time.now with Process.clock_gettime ### v0.17.0 / 2021-04-22 diff --git a/instrumentation/ethon/CHANGELOG.md b/instrumentation/ethon/CHANGELOG.md index 5c6418836..a187e1f49 100644 --- a/instrumentation/ethon/CHANGELOG.md +++ b/instrumentation/ethon/CHANGELOG.md @@ -72,7 +72,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 ### v0.17.0 / 2021-04-22 @@ -128,7 +128,7 @@ ### v0.7.0 / 2020-10-07 * DOCS: Add README for Ethon -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/instrumentation/excon/CHANGELOG.md b/instrumentation/excon/CHANGELOG.md index dbef84bab..509a71067 100644 --- a/instrumentation/excon/CHANGELOG.md +++ b/instrumentation/excon/CHANGELOG.md @@ -75,7 +75,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 * FIXED: Removed http.status_text attribute #750 ### v0.17.0 / 2021-04-22 @@ -130,7 +130,7 @@ ### v0.7.0 / 2020-10-07 -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/instrumentation/faraday/CHANGELOG.md b/instrumentation/faraday/CHANGELOG.md index a3e04733d..b805e43ee 100644 --- a/instrumentation/faraday/CHANGELOG.md +++ b/instrumentation/faraday/CHANGELOG.md @@ -91,7 +91,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 * FIXED: Removed http.status_text attribute #750 ### v0.17.0 / 2021-04-22 @@ -144,7 +144,7 @@ ### v0.7.0 / 2020-10-07 * DOCS: Faraday documentation -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/instrumentation/graphql/CHANGELOG.md b/instrumentation/graphql/CHANGELOG.md index 327842397..b35de4faf 100644 --- a/instrumentation/graphql/CHANGELOG.md +++ b/instrumentation/graphql/CHANGELOG.md @@ -116,7 +116,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 ### v0.17.0 / 2021-04-22 diff --git a/instrumentation/http/CHANGELOG.md b/instrumentation/http/CHANGELOG.md index 59ab58139..02683f2de 100644 --- a/instrumentation/http/CHANGELOG.md +++ b/instrumentation/http/CHANGELOG.md @@ -65,7 +65,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 ### v0.17.0 / 2021-04-22 diff --git a/instrumentation/http_client/CHANGELOG.md b/instrumentation/http_client/CHANGELOG.md index 419dfcfa4..df483006a 100644 --- a/instrumentation/http_client/CHANGELOG.md +++ b/instrumentation/http_client/CHANGELOG.md @@ -69,7 +69,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 ### v0.17.0 / 2021-04-22 diff --git a/instrumentation/lmdb/CHANGELOG.md b/instrumentation/lmdb/CHANGELOG.md index 83403f938..00a43990b 100644 --- a/instrumentation/lmdb/CHANGELOG.md +++ b/instrumentation/lmdb/CHANGELOG.md @@ -47,7 +47,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 ### v0.17.0 / 2021-04-22 diff --git a/instrumentation/mongo/CHANGELOG.md b/instrumentation/mongo/CHANGELOG.md index 6c8e51b2a..51bd62251 100644 --- a/instrumentation/mongo/CHANGELOG.md +++ b/instrumentation/mongo/CHANGELOG.md @@ -57,7 +57,7 @@ * BREAKING CHANGE: Replace Time.now with Process.clock_gettime -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 * FIXED: Replace Time.now with Process.clock_gettime * FIXED: Mongodb test asserting error message diff --git a/instrumentation/mysql2/CHANGELOG.md b/instrumentation/mysql2/CHANGELOG.md index bf4abc390..f443f0721 100644 --- a/instrumentation/mysql2/CHANGELOG.md +++ b/instrumentation/mysql2/CHANGELOG.md @@ -90,7 +90,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 * Fix: Nil value for db.name attribute #744 ### v0.17.0 / 2021-04-22 @@ -146,7 +146,7 @@ ### v0.7.0 / 2020-10-07 -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/instrumentation/net_http/CHANGELOG.md b/instrumentation/net_http/CHANGELOG.md index 50cb64973..7ed5aa510 100644 --- a/instrumentation/net_http/CHANGELOG.md +++ b/instrumentation/net_http/CHANGELOG.md @@ -76,7 +76,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 ### v0.17.0 / 2021-04-22 @@ -126,7 +126,7 @@ ### v0.7.0 / 2020-10-07 * DOCS: Added documentation for net_http gem in instrumentation -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/instrumentation/pg/CHANGELOG.md b/instrumentation/pg/CHANGELOG.md index fe3d3eb37..f22b565d2 100644 --- a/instrumentation/pg/CHANGELOG.md +++ b/instrumentation/pg/CHANGELOG.md @@ -104,7 +104,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 * ADDED: Add option to postgres instrumentation to disable db.statement ### v0.17.1 / 2021-04-23 diff --git a/instrumentation/que/README.md b/instrumentation/que/README.md index 8cd22d6e1..940aa1794 100644 --- a/instrumentation/que/README.md +++ b/instrumentation/que/README.md @@ -49,7 +49,7 @@ OpenTelemetry::SDK.configure do |c| end ``` -If you wish the job will be executed in the same logicial trace as a direct +If you wish the job will be executed in the same logical trace as a direct child of the span that enqueued the job then set propagation_style to `child`. By default the jobs are just linked together. diff --git a/instrumentation/rack/CHANGELOG.md b/instrumentation/rack/CHANGELOG.md index 540499280..5cab71fac 100644 --- a/instrumentation/rack/CHANGELOG.md +++ b/instrumentation/rack/CHANGELOG.md @@ -80,7 +80,7 @@ ### v0.20.1 / 2021-12-01 -* FIXED: [Instruentation Rack] Log content type http header +* FIXED: [Instrumentation Rack] Log content type http header * FIXED: Use monotonic clock where possible * FIXED: Rack to stop using api env getter @@ -115,7 +115,7 @@ forwards the uri path. More details on this is available in the readme. ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 * FIXED: Removed http.status_text attribute #750 ### v0.17.0 / 2021-04-22 @@ -181,7 +181,7 @@ forwards the uri path. More details on this is available in the readme. * FIXED: Remove superfluous file from Rack gem * DOCS: Added README for Rack Instrumentation -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/instrumentation/rails/CHANGELOG.md b/instrumentation/rails/CHANGELOG.md index b2dc96104..e89e820e1 100644 --- a/instrumentation/rails/CHANGELOG.md +++ b/instrumentation/rails/CHANGELOG.md @@ -87,7 +87,7 @@ ### v0.20.0 / 2021-12-01 -* ADDED: Move activesupport notification subsciber out of action_view gem +* ADDED: Move activesupport notification subscriber out of action_view gem * FIXED: Instrumentation of Rails 7 ### v0.19.4 / 2021-10-06 @@ -123,7 +123,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 ### v0.17.0 / 2021-04-22 diff --git a/instrumentation/rdkafka/CHANGELOG.md b/instrumentation/rdkafka/CHANGELOG.md index 58d8f5431..a8157a9a6 100644 --- a/instrumentation/rdkafka/CHANGELOG.md +++ b/instrumentation/rdkafka/CHANGELOG.md @@ -26,7 +26,7 @@ ### v0.4.1 / 2023-11-22 -* FIXED: Get Rdkafka version from VERSION contant +* FIXED: Get Rdkafka version from VERSION constant ### v0.4.0 / 2023-09-07 diff --git a/instrumentation/redis/CHANGELOG.md b/instrumentation/redis/CHANGELOG.md index 39cf15af2..30e952b71 100644 --- a/instrumentation/redis/CHANGELOG.md +++ b/instrumentation/redis/CHANGELOG.md @@ -82,7 +82,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 refactor: redis attribute utils [#760](https://github.com/open-telemetry/opentelemetry-ruby/pull/760) refactor: simplify redis attribute assignment [#758](https://github.com/open-telemetry/opentelemetry-ruby/pull/758) test: split redis instrumentation test [#754](https://github.com/open-telemetry/opentelemetry-ruby/pull/754) @@ -145,7 +145,7 @@ test: split redis instrumentation test [#754](https://github.com/open-telemetry/ ### v0.7.0 / 2020-10-07 * DOCS: Added redis documentation -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/instrumentation/restclient/CHANGELOG.md b/instrumentation/restclient/CHANGELOG.md index 101fa104d..1048ba87a 100644 --- a/instrumentation/restclient/CHANGELOG.md +++ b/instrumentation/restclient/CHANGELOG.md @@ -65,7 +65,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 * FIXED: Removed http.status_text attribute #750 ### v0.17.0 / 2021-04-22 @@ -119,7 +119,7 @@ ### v0.7.0 / 2020-10-07 -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/instrumentation/ruby_kafka/CHANGELOG.md b/instrumentation/ruby_kafka/CHANGELOG.md index f67fc3cf6..1f6fbabcb 100644 --- a/instrumentation/ruby_kafka/CHANGELOG.md +++ b/instrumentation/ruby_kafka/CHANGELOG.md @@ -62,7 +62,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 ### v0.17.0 / 2021-04-22 diff --git a/instrumentation/sidekiq/CHANGELOG.md b/instrumentation/sidekiq/CHANGELOG.md index 007b05113..11c0d9755 100644 --- a/instrumentation/sidekiq/CHANGELOG.md +++ b/instrumentation/sidekiq/CHANGELOG.md @@ -103,7 +103,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 * TEST: update test for redis instrumentation refactor [#760](https://github.com/open-telemetry/opentelemetry-ruby/pull/760) * BREAKING CHANGE: Remove optional parent_context from in_span @@ -161,7 +161,7 @@ * DOCS: Adding README for Sidekiq instrumentation * DOCS: Remove duplicate reference in Sidekiq README -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/instrumentation/sinatra/CHANGELOG.md b/instrumentation/sinatra/CHANGELOG.md index 331835a9b..a07c12ad1 100644 --- a/instrumentation/sinatra/CHANGELOG.md +++ b/instrumentation/sinatra/CHANGELOG.md @@ -90,7 +90,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 * BREAKING CHANGE: Remove optional parent_context from in_span * FIXED: Remove optional parent_context from in_span @@ -150,7 +150,7 @@ ### v0.7.0 / 2020-10-07 * FIXED: Default to sinatra.route for span name -* DOCS: Standardize toplevel docs structure and readme +* DOCS: Standardize top-level docs structure and readme ### v0.6.0 / 2020-09-10 diff --git a/propagator/ottrace/CHANGELOG.md b/propagator/ottrace/CHANGELOG.md index 0b8547296..e108451a5 100644 --- a/propagator/ottrace/CHANGELOG.md +++ b/propagator/ottrace/CHANGELOG.md @@ -46,7 +46,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 ### v0.17.0 / 2021-04-22 diff --git a/propagator/xray/CHANGELOG.md b/propagator/xray/CHANGELOG.md index 5448ad7b9..1a91642c3 100644 --- a/propagator/xray/CHANGELOG.md +++ b/propagator/xray/CHANGELOG.md @@ -34,7 +34,7 @@ ### v0.18.0 / 2021-05-21 -* ADDED: Updated API depedency for 1.0.0.rc1 +* ADDED: Updated API dependency for 1.0.0.rc1 * FIXED: XRay trace_id parsing length ### v0.17.0 / 2021-04-22