diff --git a/.github/workflows/ci-markdownlint.yml b/.github/workflows/ci-markdownlint.yml index 35e35f397b..ada59ffc7a 100644 --- a/.github/workflows/ci-markdownlint.yml +++ b/.github/workflows/ci-markdownlint.yml @@ -11,7 +11,7 @@ jobs: # equivalent cli: markdownlint-cli2 "**/*.md" "#**/CHANGELOG.md" --config .markdownlint.json - name: "Markdown Lint Check" - uses: DavidAnson/markdownlint-cli2-action@v19 + uses: DavidAnson/markdownlint-cli2-action@v20 continue-on-error: true with: fix: false diff --git a/.instrumentation_generator/templates/Readme.md.tt b/.instrumentation_generator/templates/Readme.md.tt index 68b6399770..5b3e33e61d 100644 --- a/.instrumentation_generator/templates/Readme.md.tt +++ b/.instrumentation_generator/templates/Readme.md.tt @@ -32,7 +32,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/<%= instrumentation_name %>/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/<%= instrumentation_name %>/example/trace_demonstration.rb) ## How can I get involved? diff --git a/README.md b/README.md index 65d33dfd0c..33c7c0f83f 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ Consult instrumentation gem's README file and gemspec for details about library ### Releases -This repository was extracted from the [OpenTelemetry Ruby repository][otel-ruby]. Versions of libraries contained in this repo released prior to 2022-06-13 are available on the [OpenTelemetry Ruby Releases][otel-ruby-releases] page. Newer versions are available [here][otel-ruby-contrib-releases] +This repository was extracted from the [OpenTelemetry Ruby repository][otel-ruby]. Versions of libraries contained in this repo released prior to 2022-06-13 are available on the [OpenTelemetry Ruby Releases][otel-ruby-releases] page. Newer versions are available [on the opentelemetry-ruby-contrib Releases page][otel-ruby-contrib-releases]. ## Useful links diff --git a/instrumentation/README.md b/instrumentation/README.md index dec813917c..614c832717 100644 --- a/instrumentation/README.md +++ b/instrumentation/README.md @@ -8,7 +8,7 @@ Instrumentation libraries provide pre-built OpenTelemetry instrumentation for po Released instrumentations can be found at the [OpenTelemetry registry](https://opentelemetry.io/registry/?language=ruby&component=instrumentation#). You can also look in this project's Github repository: Individual instrumentation libraries can be found in subdirectories under `/instrumentation`. -In-progress instrumentations can be found [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues?q=is%3Aopen+label%3Ainstrumentation+-label%3A%22help+wanted%22+). +[In-progress instrumentations can be found here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues?q=is%3Aopen+label%3Ainstrumentation+-label%3A%22help+wanted%22+). ## How do I get started? @@ -49,7 +49,7 @@ Please review the individual instrumentation READMEs for more information about The source for all OpenTelemetry Ruby instrumentation gems is [on github](https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation). -If you are interested in helping out with an instrumentation, you can see instrumentations that have been requested but are not currently in-progress [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues?q=is%3Aopen+label%3Ainstrumentation+label%3A%22help+wanted%22). +If you are interested in helping out with an instrumentation, check out [instrumentations that have been requested but are not currently in-progress](https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues?q=is%3Aopen+label%3Ainstrumentation+label%3A%22help+wanted%22). The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig]. diff --git a/instrumentation/action_mailer/README.md b/instrumentation/action_mailer/README.md index 3d429e7d2c..edb5590eaa 100644 --- a/instrumentation/action_mailer/README.md +++ b/instrumentation/action_mailer/README.md @@ -91,7 +91,7 @@ Internal spans are named using the name of the `ActiveSupport` event that was pr ## Examples -Example usage can be seen in the `./example/trace_request_demonstration.ru` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/action_mailer/example/trace_request_demonstration.ru) +Example usage can be seen in the [`./example/trace_request_demonstration.ru` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/action_mailer/example/trace_request_demonstration.ru) ## How can I get involved? diff --git a/instrumentation/action_pack/README.md b/instrumentation/action_pack/README.md index c8b84f5ef8..8eb0fd76eb 100644 --- a/instrumentation/action_pack/README.md +++ b/instrumentation/action_pack/README.md @@ -69,7 +69,7 @@ The error object will be retained within `payload[:exception_object]`. Additiona ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/action_pack/example/trace_demonstration.ru) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/action_pack/example/trace_demonstration.ru) ## How can I get involved? diff --git a/instrumentation/action_view/README.md b/instrumentation/action_view/README.md index 340a285c9e..208f5877d3 100644 --- a/instrumentation/action_view/README.md +++ b/instrumentation/action_view/README.md @@ -34,7 +34,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_request_demonstration.ru` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/action_view/example/trace_request_demonstration.ru) +Example usage can be seen in the [`./example/trace_request_demonstration.ru` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/action_view/example/trace_request_demonstration.ru) ## Known issues diff --git a/instrumentation/active_job/README.md b/instrumentation/active_job/README.md index ee8a01432f..52ad445101 100644 --- a/instrumentation/active_job/README.md +++ b/instrumentation/active_job/README.md @@ -90,7 +90,7 @@ In order to preserve this behavior you will have to update the span yourself, e. ## Examples -Example usage can be seen in the `./example/active_job.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_job/example/active_job.rb) +Example usage can be seen in the [`./example/active_job.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_job/example/active_job.rb) ## How can I get involved? diff --git a/instrumentation/active_model_serializers/README.md b/instrumentation/active_model_serializers/README.md index 7e8fe0bd5c..f095dcdbde 100644 --- a/instrumentation/active_model_serializers/README.md +++ b/instrumentation/active_model_serializers/README.md @@ -32,7 +32,7 @@ end ## Examples -Example usage of active_model_serializers can be seen in the `./example/` folder [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/active_model_serializers/example) +Example usage of active_model_serializers can be seen [in the `./example/` folder](https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/active_model_serializers/example) ## How can I get involved? diff --git a/instrumentation/active_record/README.md b/instrumentation/active_record/README.md index c64e2da1fc..6eba159909 100644 --- a/instrumentation/active_record/README.md +++ b/instrumentation/active_record/README.md @@ -32,7 +32,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_record/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_record/example/trace_demonstration.rb) ## How can I get involved? diff --git a/instrumentation/active_storage/README.md b/instrumentation/active_storage/README.md index 3ee418aafb..17abb1dc2f 100644 --- a/instrumentation/active_storage/README.md +++ b/instrumentation/active_storage/README.md @@ -75,7 +75,7 @@ Attributes attached to each event payload are prefixed with `active_storage.` (e ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_storage/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_storage/example/trace_demonstration.rb) ## How can I get involved? diff --git a/instrumentation/active_support/README.md b/instrumentation/active_support/README.md index 2a305e163e..519b20323a 100644 --- a/instrumentation/active_support/README.md +++ b/instrumentation/active_support/README.md @@ -42,7 +42,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_support/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_support/example/trace_demonstration.rb) ## How can I get involved? diff --git a/instrumentation/bunny/README.md b/instrumentation/bunny/README.md index d3c0d936a1..a0de6d56f5 100644 --- a/instrumentation/bunny/README.md +++ b/instrumentation/bunny/README.md @@ -32,7 +32,7 @@ end ## Examples -Example usage can be seen in the `./example/bunny.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/bunny/example/bunny.rb) +Example usage can be seen in the [`./example/bunny.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/bunny/example/bunny.rb) ## How can I get involved? diff --git a/instrumentation/delayed_job/README.md b/instrumentation/delayed_job/README.md index 0a72d2cb07..c5994c5798 100644 --- a/instrumentation/delayed_job/README.md +++ b/instrumentation/delayed_job/README.md @@ -32,7 +32,7 @@ end ## Examples -Example usage of delayed_job can be seen in the `./example/delayed_job.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/delayed_job/example/delayed_job.rb) +Example usage of delayed_job can be seen in the [`./example/delayed_job.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/delayed_job/example/delayed_job.rb) ## How can I get involved? diff --git a/instrumentation/ethon/README.md b/instrumentation/ethon/README.md index fcf92dca7c..bb686b09e0 100644 --- a/instrumentation/ethon/README.md +++ b/instrumentation/ethon/README.md @@ -32,7 +32,7 @@ end ## Examples -Example usage of faraday can be seen in the `./example/ethon.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/ethon/example/ethon.rb) +Example usage of faraday can be seen in the [`./example/ethon.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/ethon/example/ethon.rb) ## How can I get involved? diff --git a/instrumentation/faraday/README.md b/instrumentation/faraday/README.md index f8e23bc45e..095c7cd001 100644 --- a/instrumentation/faraday/README.md +++ b/instrumentation/faraday/README.md @@ -32,7 +32,7 @@ end ## Examples -Example usage of faraday can be seen in the `./example/faraday.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/faraday/example/faraday.rb) +Example usage of faraday can be seen in the [`./example/faraday.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/faraday/example/faraday.rb) ## How can I get involved? diff --git a/instrumentation/grape/README.md b/instrumentation/grape/README.md index ca046a2350..be1fd5708c 100644 --- a/instrumentation/grape/README.md +++ b/instrumentation/grape/README.md @@ -2,7 +2,7 @@ The Grape instrumentation is a community-maintained instrumentation for [Grape][grape], a REST-like API framework for Ruby. -It relies on the Grape built-in support for `ActiveSupport::Notifications` (more info [here](https://github.com/ruby-grape/grape#active-support-instrumentation)) and the [OpenTelemetry Rack instrumentation](https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-rack/v0.24.6/instrumentation/rack). +It relies on the [Grape built-in support for `ActiveSupport::Notifications`](https://github.com/ruby-grape/grape#active-support-instrumentation) and the [OpenTelemetry Rack instrumentation](https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/opentelemetry-instrumentation-rack/v0.24.6/instrumentation/rack). It currently supports the following events: @@ -69,7 +69,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/grape/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/grape/example/trace_demonstration.rb) ## How can I get involved? diff --git a/instrumentation/grpc/README.md b/instrumentation/grpc/README.md index b7cf4839e6..822133fc64 100644 --- a/instrumentation/grpc/README.md +++ b/instrumentation/grpc/README.md @@ -43,7 +43,7 @@ instrumentation. ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/grpc/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/grpc/example/trace_demonstration.rb) ## Development diff --git a/instrumentation/gruf/README.md b/instrumentation/gruf/README.md index fae675ebc6..4edc9838e6 100644 --- a/instrumentation/gruf/README.md +++ b/instrumentation/gruf/README.md @@ -37,7 +37,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/gruf/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/gruf/example/trace_demonstration.rb) ## How can I get involved? diff --git a/instrumentation/http/README.md b/instrumentation/http/README.md index 91d7fe8d99..2c4512abd7 100644 --- a/instrumentation/http/README.md +++ b/instrumentation/http/README.md @@ -44,7 +44,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/http/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/http/example/trace_demonstration.rb) ## How can I get involved? diff --git a/instrumentation/http_client/README.md b/instrumentation/http_client/README.md index 3f5719d971..126ee790b1 100644 --- a/instrumentation/http_client/README.md +++ b/instrumentation/http_client/README.md @@ -32,7 +32,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/http_client/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/http_client/example/trace_demonstration.rb) ## How can I get involved? diff --git a/instrumentation/koala/README.md b/instrumentation/koala/README.md index b304d01b54..ceecc2bee5 100644 --- a/instrumentation/koala/README.md +++ b/instrumentation/koala/README.md @@ -33,7 +33,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/koala/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/koala/example/trace_demonstration.rb) ## How can I get involved? diff --git a/instrumentation/racecar/README.md b/instrumentation/racecar/README.md index a7f93d5f1c..6f2b11ef26 100644 --- a/instrumentation/racecar/README.md +++ b/instrumentation/racecar/README.md @@ -36,7 +36,7 @@ end ## Examples -Example usage can be seen in the `./example` directory [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/racecar/example). Run `./trace_demonstration.sh` to see its behaviour. +Example usage can be seen in the [`./example` directory](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/racecar/example). Run `./trace_demonstration.sh` to see its behaviour. ## How can I get involved? diff --git a/instrumentation/rack/README.md b/instrumentation/rack/README.md index 79c935c08f..6373900448 100644 --- a/instrumentation/rack/README.md +++ b/instrumentation/rack/README.md @@ -81,7 +81,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/rack/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/rack/example/trace_demonstration.rb) ## How can I get involved? diff --git a/instrumentation/rails/README.md b/instrumentation/rails/README.md index efb048ca8b..5f51e354c6 100644 --- a/instrumentation/rails/README.md +++ b/instrumentation/rails/README.md @@ -64,7 +64,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/rails/example/trace_request_demonstration.ru) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/rails/example/trace_request_demonstration.ru) ## How can I get involved? diff --git a/instrumentation/rake/README.md b/instrumentation/rake/README.md index bcdccaa030..b119f2730b 100644 --- a/instrumentation/rake/README.md +++ b/instrumentation/rake/README.md @@ -32,7 +32,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/opentelemetry-instrumentation-rake/v0.2.2/instrumentation/rake/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/opentelemetry-instrumentation-rake/v0.2.2/instrumentation/rake/example/trace_demonstration.rb) ## How can I get involved? diff --git a/instrumentation/rdkafka/README.md b/instrumentation/rdkafka/README.md index 21c57c3d71..8cf9e7384e 100644 --- a/instrumentation/rdkafka/README.md +++ b/instrumentation/rdkafka/README.md @@ -32,7 +32,7 @@ end ## Examples -Example usage can be seen in the `./example/rdkafka_trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/rdkafka/example/rdkafka_trace_demonstration.rb) +Example usage can be seen in the [`./example/rdkafka_trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/rdkafka/example/rdkafka_trace_demonstration.rb) ## How can I get involved? diff --git a/instrumentation/resque/README.md b/instrumentation/resque/README.md index fc46ca1add..7aa498b45c 100644 --- a/instrumentation/resque/README.md +++ b/instrumentation/resque/README.md @@ -32,7 +32,7 @@ end ## Examples -Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/resque/example/trace_demonstration.rb) +Example usage can be seen in the [`./example/trace_demonstration.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/resque/example/trace_demonstration.rb) ## How can I get involved? diff --git a/instrumentation/rspec/README.md b/instrumentation/rspec/README.md index c14f7674fa..c9814cd8d6 100644 --- a/instrumentation/rspec/README.md +++ b/instrumentation/rspec/README.md @@ -55,7 +55,7 @@ To avoid spans from being dropped, which will mean you lose insight into your sp ## Examples -Example usage can be seen in the `/example` directory [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/rspec/example) +Example usage can be seen in the [`/example` directory](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/rspec/example) ## How can I get involved? diff --git a/instrumentation/ruby_kafka/README.md b/instrumentation/ruby_kafka/README.md index 65c38b8ea7..4ec4656816 100644 --- a/instrumentation/ruby_kafka/README.md +++ b/instrumentation/ruby_kafka/README.md @@ -32,7 +32,7 @@ end ## Examples -Example usage can be seen in the `./example/ruby_kafka.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/ruby_kafka/example/ruby_kafka.rb) +Example usage can be seen in the [`./example/ruby_kafka.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/ruby_kafka/example/ruby_kafka.rb) ## How can I get involved? diff --git a/instrumentation/sidekiq/README.md b/instrumentation/sidekiq/README.md index 5e435acfce..985cd25be5 100644 --- a/instrumentation/sidekiq/README.md +++ b/instrumentation/sidekiq/README.md @@ -32,7 +32,7 @@ end ## Examples -Example usage can be seen in the `./example/sidekiq.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/sidekiq/example/sidekiq.rb) +Example usage can be seen in the [`./example/sidekiq.rb` file](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/sidekiq/example/sidekiq.rb) ## Development