From 6dab627424e88238d162dd21af8bf35e8a6174e3 Mon Sep 17 00:00:00 2001 From: Xuan <112967240+xuan-cao-swi@users.noreply.github.com> Date: Thu, 8 Aug 2024 08:35:01 -0400 Subject: [PATCH 1/7] fix: fix the issue of wrong log msg (#1105) --- instrumentation/base/lib/opentelemetry/instrumentation/base.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/base/lib/opentelemetry/instrumentation/base.rb b/instrumentation/base/lib/opentelemetry/instrumentation/base.rb index 8c9ac0e3f..ddf828955 100644 --- a/instrumentation/base/lib/opentelemetry/instrumentation/base.rb +++ b/instrumentation/base/lib/opentelemetry/instrumentation/base.rb @@ -304,7 +304,7 @@ def config_options(user_config) h[option_name] = option[:default] end - dropped_config_keys = user_config.keys - validated_config.keys + dropped_config_keys = user_config.keys - validated_config.keys - [:enabled] OpenTelemetry.logger.warn("Instrumentation #{name} ignored the following unknown configuration options #{dropped_config_keys}") unless dropped_config_keys.empty? validated_config From db0ad4ddbdd4accefdb931d617da211659494483 Mon Sep 17 00:00:00 2001 From: Xuan <112967240+xuan-cao-swi@users.noreply.github.com> Date: Thu, 8 Aug 2024 08:54:07 -0400 Subject: [PATCH 2/7] chore: add markdownlint, markdown link check workflow and with updated markdown file (#1096) * doc: add markdownlint and link workflow and update the md file * separate the name for workflow * Update .github/workflows/ci-markdownlint.yml Co-authored-by: Kayla Reopelle <87386821+kaylareopelle@users.noreply.github.com> * Update .github/workflows/ci-markdown-link.yml Co-authored-by: Kayla Reopelle <87386821+kaylareopelle@users.noreply.github.com> * revision * fix broken links --------- Co-authored-by: Kayla Reopelle <87386821+kaylareopelle@users.noreply.github.com> Co-authored-by: Ariel Valentin --- .github/workflows/ci-markdown-link.yml | 17 ++++++++++++++++ .github/workflows/ci-markdownlint.yml | 20 +++++++++++++++++++ .../templates/Readme.md.tt | 5 +++-- .markdown-link-check.json | 10 ++++++++++ .markdownlint.json | 13 ++++++++++++ CONTRIBUTING.md | 9 +++++---- README.md | 10 ++++------ helpers/mysql/README.md | 6 ++++-- helpers/sql-obfuscation/README.md | 6 ++++-- instrumentation/CONTRIBUTING.md | 4 ++-- instrumentation/README.md | 9 +++------ instrumentation/action_mailer/README.md | 7 +++++-- instrumentation/action_pack/README.md | 7 ++++--- instrumentation/action_view/README.md | 5 +++-- instrumentation/active_job/README.md | 5 +++-- .../active_model_serializers/README.md | 5 +++-- instrumentation/active_record/README.md | 6 ++++-- instrumentation/active_support/README.md | 3 ++- instrumentation/all/README.md | 9 +++------ instrumentation/aws_lambda/README.md | 12 +++++------ instrumentation/aws_sdk/README.md | 5 +++-- instrumentation/base/README.md | 5 +++-- instrumentation/bunny/README.md | 7 ++++--- instrumentation/concurrent_ruby/README.md | 5 +++-- instrumentation/dalli/README.md | 5 +++-- instrumentation/datadog-porting-guide.md | 7 ++++--- instrumentation/delayed_job/README.md | 5 +++-- instrumentation/ethon/README.md | 6 +++--- instrumentation/excon/README.md | 6 +++--- instrumentation/faraday/README.md | 5 +++-- instrumentation/grape/README.md | 8 ++++---- instrumentation/graphql/README.md | 5 +++-- instrumentation/gruf/README.md | 5 +++-- instrumentation/http/README.md | 5 +++-- instrumentation/http_client/README.md | 5 +++-- instrumentation/httpx/README.md | 7 ++++--- instrumentation/koala/README.md | 5 +++-- instrumentation/lmdb/README.md | 5 +++-- instrumentation/mongo/README.md | 5 +++-- instrumentation/mysql2/README.md | 7 ++++--- instrumentation/net_http/README.md | 5 +++-- instrumentation/pg/README.md | 8 +++++--- instrumentation/que/README.md | 11 +++++----- instrumentation/racecar/README.md | 6 +++--- instrumentation/rack/README.md | 7 ++++--- instrumentation/rails/README.md | 4 +++- instrumentation/rake/README.md | 7 ++++--- instrumentation/rdkafka/README.md | 5 +++-- instrumentation/redis/README.md | 7 ++++--- instrumentation/resque/README.md | 5 +++-- instrumentation/restclient/README.md | 5 +++-- instrumentation/rspec/README.md | 5 +++-- instrumentation/ruby_kafka/README.md | 5 +++-- instrumentation/sidekiq/README.md | 8 +++++--- instrumentation/sinatra/README.md | 6 +++--- instrumentation/trilogy/README.md | 6 ++++-- processor/baggage/README.md | 5 +++-- propagator/ottrace/README.md | 9 +++++---- propagator/vitess/README.md | 9 +++++---- propagator/xray/README.md | 12 +++++++---- resources/azure/README.md | 10 ++++++---- resources/container/README.md | 11 ++++++---- resources/google_cloud_platform/README.md | 11 +++++----- 63 files changed, 282 insertions(+), 166 deletions(-) create mode 100644 .github/workflows/ci-markdown-link.yml create mode 100644 .github/workflows/ci-markdownlint.yml create mode 100644 .markdown-link-check.json create mode 100644 .markdownlint.json diff --git a/.github/workflows/ci-markdown-link.yml b/.github/workflows/ci-markdown-link.yml new file mode 100644 index 000000000..7b42be0c1 --- /dev/null +++ b/.github/workflows/ci-markdown-link.yml @@ -0,0 +1,17 @@ +name: Markdown Link Check + +on: + pull_request: + +jobs: + markdown-link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: "Markdown Link Check" + uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + config-file: '.markdown-link-check.json' + use-quiet-mode: 'yes' + use-verbose-mode: 'yes' diff --git a/.github/workflows/ci-markdownlint.yml b/.github/workflows/ci-markdownlint.yml new file mode 100644 index 000000000..f91609fdb --- /dev/null +++ b/.github/workflows/ci-markdownlint.yml @@ -0,0 +1,20 @@ +name: Markdown Lint Check + +on: + pull_request: + +jobs: + markdownlint-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + # equivalent cli: markdownlint-cli2 "**/*.md" "#**/CHANGELOG.md" --config .markdownlint.json + - name: "Markdown Lint Check" + uses: DavidAnson/markdownlint-cli2-action@v16 + with: + fix: false + globs: | + **/*.md + !**/CHANGELOG.md + continue-on-error: true diff --git a/.instrumentation_generator/templates/Readme.md.tt b/.instrumentation_generator/templates/Readme.md.tt index fc1f485d0..68b639977 100644 --- a/.instrumentation_generator/templates/Readme.md.tt +++ b/.instrumentation_generator/templates/Readme.md.tt @@ -6,7 +6,7 @@ Todo: Add a description. Install the gem using: -``` +```console gem install opentelemetry-instrumentation-<%= instrumentation_name %> ``` @@ -38,7 +38,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here]( The `opentelemetry-instrumentation-<%= instrumentation_name %>` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -49,4 +49,5 @@ The `opentelemetry-instrumentation-<%= instrumentation_name %>` gem is distribut [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/.markdown-link-check.json b/.markdown-link-check.json new file mode 100644 index 000000000..12284d673 --- /dev/null +++ b/.markdown-link-check.json @@ -0,0 +1,10 @@ +{ + "ignorePatterns": [ + { + "pattern": "^http://localhost" + } + ], + "timeout": "5s", + "retryOn429": true, + "aliveStatusCodes": [200, 206, 429] +} diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 000000000..10b3203b8 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,13 @@ +{ + "emphasis-style": false, + "line-length": false, + "link-fragments": false, + "list-marker-space": false, + "no-emphasis-as-heading": false, + "no-hard-tabs": false, + "no-inline-html": false, + "no-trailing-punctuation": false, + "no-trailing-spaces": true, + "custom-rules-below-this-point": false, + "trim-code-block-and-unindent": true +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33929acc4..58466f717 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -168,7 +168,7 @@ bundle exec rake yard ## Instrumentation author's guide -Please make sure that you review the [Instrumentation author's guide](.instrumentation/CONTRIBUTING.md) before submitting a new instrumentation. +Please make sure that you review the [Instrumentation author's guide](instrumentation/CONTRIBUTING.md) before submitting a new instrumentation. ## Create a pull request @@ -209,10 +209,11 @@ make the project that much better. Respond to the feedback and work with your reviewer(s) to resolve any issues. The some of the things the code owners are looking for include: + * a signed [CNCF CLA][cncf-cla] * a passing CI build * adherence to the principles and features outlined in the - [instrumentation author's guide](.instrumentation/CONTRIBUTING.md) + [instrumentation author's guide](instrumentation/CONTRIBUTING.md) Reviewers are responsible for ensuring that each merged PR's commit message conforms to [conventional commits](https://conventionalcommits.org). This may @@ -414,7 +415,7 @@ index e29acbfc..85622d25 100644 [cncf-cla]: https://identity.linuxfoundation.org/projects/cncf [github-draft]: https://github.blog/2019-02-14-introducing-draft-pull-requests/ [kube-github-workflow-pr]: https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md#7-create-a-pull-request -[otel-contributor-guide]: https://github.com/open-telemetry/community/blob/master/CONTRIBUTING.md -[otel-github-workflow]: https://github.com/open-telemetry/community/blob/master/CONTRIBUTING.md#github-workflow +[otel-contributor-guide]: https://github.com/open-telemetry/community/blob/main/guides/contributor/README.md +[otel-github-workflow]: https://github.com/open-telemetry/community/blob/main/guides/contributor/processes.md#workflows [otel-lib-guidelines]: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/library-guidelines.md [otel-specification]: https://github.com/open-telemetry/opentelemetry-specification diff --git a/README.md b/README.md index 8be68642e..cf704fe82 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Approvers ([@open-telemetry/ruby-contrib-approvers](https://github.com/orgs/open - [Josef Šimánek](https://github.com/simi) - [Xuan Cao](https://github.com/xuan-cao-swi), Solarwinds -*Find more about the approver role in [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver).* +*Find more about the approver role in [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#approver).* Maintainers ([@open-telemetry/ruby-contrib-maintainers](https://github.com/orgs/open-telemetry/teams/ruby-contrib-maintainers)): @@ -44,7 +44,7 @@ Maintainers ([@open-telemetry/ruby-contrib-maintainers](https://github.com/orgs/ - [Robert Laurin](https://github.com/robertlaurin), Shopify - [Sam Handler](https://github.com/plantfansam), Shopify -*Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer).* +*Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer).* ## Instrumentation Libraries @@ -60,6 +60,7 @@ multiple instrumentation libraries. - [MySQL](helpers/mysql/) - [SQL Obfuscation](helpers/sql-obfuscation/) + ## Additional Libraries This repository also contains libraries to aid with interoperability with vendor specific tracing solutions: @@ -103,17 +104,14 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [otel-ruby]: https://github.com/open-telemetry/opentelemetry-ruby [otel-ruby-releases]: https://github.com/open-telemetry/opentelemetry-ruby/releases [otel-ruby-contrib-releases]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/releases -[ci-image]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/workflows/CI/badge.svg?event=push -[examples-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/examples +[ci-image]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/workflows/CI%20Contrib/badge.svg?event=push [getting-started]: https://opentelemetry.io/docs/languages/ruby/getting-started/ [issues-good-first-issue]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 [issues-help-wanted]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat [license-url]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig -[opentelemetry-instrumentation-all-publishing]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/all#publishing [slack-image]: https://img.shields.io/badge/slack-@cncf/otel/ruby-brightgreen.svg?logo=slack [slack-url]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions [otel-versioning]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md -[otel-specification]: https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification diff --git a/helpers/mysql/README.md b/helpers/mysql/README.md index dcfaab979..71c43df4e 100644 --- a/helpers/mysql/README.md +++ b/helpers/mysql/README.md @@ -22,6 +22,7 @@ end ``` Make sure the `Instrumentation` class for your gem contains configuration options for: + - `:span_name`: The type of span name desired for the trace. Example: `option :span_name, default: :statement_type, validate: %I[statement_type db_name db_operation_and_name]` @@ -43,7 +44,7 @@ end The `opentelemetry-helpers-mysql` gem source is [on github][repo-github], along with related gems including `opentelemetry-instrumentation-mysql2` and `opentelemetry-instrumentation-trilogy`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] 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]. +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]. ## License @@ -53,4 +54,5 @@ The `opentelemetry-helpers-mysql` gem is distributed under the Apache 2.0 licens [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings -[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/helpers/sql-obfuscation/README.md b/helpers/sql-obfuscation/README.md index 7165c1aa6..1e86bacdf 100644 --- a/helpers/sql-obfuscation/README.md +++ b/helpers/sql-obfuscation/README.md @@ -24,6 +24,7 @@ end ``` Make sure the `Instrumentation` class for your gem contains configuration options for: + - `:obfuscation_limit`: the length at which the obfuscated SQL string will be truncated. Example: `option :obfuscation_limit, default: 2000, validate: :integer` @@ -48,7 +49,7 @@ OpenTelemetry::Helpers::SqlObfuscation.obfuscate_sql(sql, obfuscation_limit: con The `opentelemetry-helpers-sql-obfuscation` gem source is [on github][repo-github], along with related gems including `opentelemetry-instrumentation-pg` and `opentelemetry-instrumentation-trilogy`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] 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]. +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]. ## License @@ -59,4 +60,5 @@ The `opentelemetry-helpers-sql-obfuscation` gem is distributed under the Apache [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings -[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/CONTRIBUTING.md b/instrumentation/CONTRIBUTING.md index f61b9f14c..1d680665e 100644 --- a/instrumentation/CONTRIBUTING.md +++ b/instrumentation/CONTRIBUTING.md @@ -12,7 +12,7 @@ We welcome contributions from everyone. We want to make sure that you have a gre We have limited capacity to maintain instrumentation libraries, so we ask that you commit to maintaining the instrumentation library you contribute. -In addition to the requirements to maintain at least [community member status](https://github.com/open-telemetry/community/blob/main/community-membership.md), contributing an instrumentation to this project requires the following: +In addition to the requirements to maintain at least [community member status](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md), contributing an instrumentation to this project requires the following: 1. Responding to issues and pull requests 2. Performing timely code reviews and responding to issues @@ -403,7 +403,7 @@ The `instrumentation_generator` creates a `README.md` file for your instrumentat In addition to that, there should also be redundant `yardoc` comments in the entrypoint of your gem, i.e. the subclass `OpenTelemetry::Instrumentation::Base`. -> :information_source: See the `Sidekiq::Instrumentation` [class description](./sidekiq/lib/opentelemetry/instrumentation/sidekiq/instrumentation.rb) for a comprehensive example. +> :information_source: See the `Sidekiq::Instrumentation` [class description](./sidekiq/lib/opentelemetry/instrumentation/sidekiq/instrumentation.rb) for a comprehensive example. ### Examples diff --git a/instrumentation/README.md b/instrumentation/README.md index 3d0d8b1c1..dec813917 100644 --- a/instrumentation/README.md +++ b/instrumentation/README.md @@ -19,19 +19,15 @@ To get started with a single instrumentation library, for example `opentelemetry ### 1. Install the gem ```console - gem install opentelemetry-instrumentation-rack - ``` ### 2. Configure OpenTelemetry to use the instrumentation -```console - +```ruby OpenTelemetry::SDK.configure do |c| c.use 'OpenTelemetry::Instrumentation::Rack' end - ``` Instrumentation-specific documentation can be found in each subdirectory's `README.md`. @@ -55,7 +51,7 @@ The source for all OpenTelemetry Ruby instrumentation gems is [on github](https: 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). -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -64,4 +60,5 @@ All OpenTelemetry Ruby instrumentation gems are distributed under the Apache 2.0 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/action_mailer/README.md b/instrumentation/action_mailer/README.md index 7744fc202..63c13d810 100644 --- a/instrumentation/action_mailer/README.md +++ b/instrumentation/action_mailer/README.md @@ -50,6 +50,7 @@ See the table below for details of what [Rails Framework Hook Events](https://gu ### Options ActionMailer instrumentation doesn't expose email addresses by default, but if email addresses are needed, simply use `:email_address` option: + ```ruby OpenTelemetry::SDK.configure do |c| c.use 'OpenTelemetry::Instrumentation::ActionMailer', { email_address: :include } @@ -57,6 +58,7 @@ end ``` If only want to hide certain attributes from the notifications payload for email address: + ```ruby OpenTelemetry::SDK.configure do |c| c.use 'OpenTelemetry::Instrumentation::ActionMailer', { email_address: :include, disallowed_notification_payload_keys: ['email.to.address'] } @@ -78,16 +80,16 @@ The following attributes from the notification payload for the `deliver.action_m | `email.from.address` | Array | Sender for mail (omit by default, include when `email_address` set to `:include`) | | `email.cc.address` | Array | mail CC (omit by default, include when `email_address` set to `:include`) | | `email.bcc.address` | Array | mail BCC (omit by default, include when `email_address` set to `:include`) | + ## 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) - ## How can I get involved? The `opentelemetry-instrumentation-action_mailer` gem source is [on GitHub][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -99,4 +101,5 @@ The `opentelemetry-instrumentation-action_mailer` gem is distributed under the A [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/action_pack/README.md b/instrumentation/action_pack/README.md index 8bbcd69bf..4eb0b6c97 100644 --- a/instrumentation/action_pack/README.md +++ b/instrumentation/action_pack/README.md @@ -6,7 +6,7 @@ The Action Pack instrumentation is a community-maintained instrumentation for th Install the gem using: -``` +```console gem install opentelemetry-instrumentation-action_pack ``` @@ -42,7 +42,6 @@ See the table below for details of what [Rails Framework Hook Events](https://gu | - | - | - | - | | `process_action.action_controller` | :white_check_mark: | :x: | It modifies the existing Rack span | - ### Error Handling for Action Controller If an error is triggered by Action Controller (such as a 500 internal server error), Action Pack will typically employ the default `ActionDispatch::PublicExceptions.new(Rails.public_path)` as the `exceptions_app`, as detailed in the [documentation](https://guides.rubyonrails.org/configuring.html#config-exceptions-app). @@ -57,7 +56,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here]( The `opentelemetry-instrumentation-action_pack` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -68,4 +67,6 @@ The `opentelemetry-instrumentation-action_pack` gem is distributed under the Apa [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions +[rails-home]: https://rubyonrails.org/ diff --git a/instrumentation/action_view/README.md b/instrumentation/action_view/README.md index c302ba368..340a285c9 100644 --- a/instrumentation/action_view/README.md +++ b/instrumentation/action_view/README.md @@ -6,7 +6,7 @@ The ActionView instrumentation is a community-maintained instrumentation for the Install the gem using: -``` +```console gem install opentelemetry-instrumentation-action_view gem install opentelemetry-instrumentation-rails ``` @@ -56,7 +56,7 @@ end The `opentelemetry-instrumentation-action_view` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -68,4 +68,5 @@ The `opentelemetry-instrumentation-action_view` gem is distributed under the Apa [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/active_job/README.md b/instrumentation/active_job/README.md index 686247ab9..ee8a01432 100644 --- a/instrumentation/active_job/README.md +++ b/instrumentation/active_job/README.md @@ -6,7 +6,7 @@ The OpenTelemetry Active Job gem is a community maintained instrumentation for [ Install the gem using: -``` +```console gem install opentelemetry-instrumentation-active_job ``` @@ -96,7 +96,7 @@ Example usage can be seen in the `./example/active_job.rb` file [here](https://g The `opentelemetry-instrumentation-active_job` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -108,4 +108,5 @@ The `opentelemetry-instrumentation-active_job` gem is distributed under the Apac [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/active_model_serializers/README.md b/instrumentation/active_model_serializers/README.md index 135aace33..728cdf74b 100644 --- a/instrumentation/active_model_serializers/README.md +++ b/instrumentation/active_model_serializers/README.md @@ -6,7 +6,7 @@ The OpenTelemetry Active Model Serializers gem is a community maintained instrum Install the gem using: -``` +```console gem install opentelemetry-instrumentation-active_model_serializers ``` @@ -38,7 +38,7 @@ Example usage of active_model_serializers can be seen in the `./example/active_m The `opentelemetry-instrumentation-active_model_serializers` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -50,4 +50,5 @@ Apache 2.0 license. See [LICENSE][license-github] for more information. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/active_record/README.md b/instrumentation/active_record/README.md index 6c6b727a9..c64e2da1f 100644 --- a/instrumentation/active_record/README.md +++ b/instrumentation/active_record/README.md @@ -6,7 +6,7 @@ The Active Record instrumentation is a community-maintained instrumentation for Install the gem using: -``` +```console gem install opentelemetry-instrumentation-active_record ``` @@ -38,7 +38,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here]( The `opentelemetry-instrumentation-active_record` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -49,4 +49,6 @@ The `opentelemetry-instrumentation-active_record` gem is distributed under the A [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions +[rails-home]: https://rubyonrails.org/ diff --git a/instrumentation/active_support/README.md b/instrumentation/active_support/README.md index 9cefa2f4f..2a305e163 100644 --- a/instrumentation/active_support/README.md +++ b/instrumentation/active_support/README.md @@ -48,7 +48,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here]( The `opentelemetry-instrumentation-active_support` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -60,4 +60,5 @@ The `opentelemetry-instrumentation-active_support` gem is distributed under the [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/all/README.md b/instrumentation/all/README.md index 76b815bc0..382d8f50b 100644 --- a/instrumentation/all/README.md +++ b/instrumentation/all/README.md @@ -16,21 +16,18 @@ This gem can be used with any OpenTelemetry SDK implementation. This can be the Install the gem using: -``` +```console gem install opentelemetry-instrumentation-all ``` Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-all` in your `Gemfile`. - The `opentelemetry-api` has functionality to discover the instrumentation that an application depends on. It maintains a registry of discovered instrumentation which can be automatically installed by the SDK. These instructions pertain to the official `opentelemetry-sdk` implementation. Consult the documentation for your SDK if you are using an alternative implementation. - ### Use All The `use_all` method will install all instrumentation present for an application, where the underlying, instrumented library is also present. Per library configuration can be passed in using an optional hash argument that has the instrumentation names as keys and configuration hashes as values. - ```ruby require 'opentelemetry/sdk' @@ -71,17 +68,17 @@ Releasing opentelemetry-instrumentation-all requires that all gems it depends on The `opentelemetry-instrumentation-all` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License The `opentelemetry-instrumentation-all` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information. - [opentelemetry-home]: https://opentelemetry.io [bundler-home]: https://bundler.io [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/aws_lambda/README.md b/instrumentation/aws_lambda/README.md index eea0d446a..3dc9bff1b 100644 --- a/instrumentation/aws_lambda/README.md +++ b/instrumentation/aws_lambda/README.md @@ -2,17 +2,18 @@ The OpenTelemetry `aws-lambda` gem is a community-maintained instrumentation for [AWS Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/ruby-handler.html). -## How do I get started? +## How do I get started? -Installation of the `opentelemetry-instrumentation-aws_lambda` gem is handled by the [OpenTelemetry Lambda Layer for Ruby](https://github.com/open-telemetry/opentelemetry-lambda/tree/main/ruby). +Installation of the `opentelemetry-instrumentation-aws_lambda` gem is handled by the [OpenTelemetry Lambda Layer for Ruby](https://github.com/open-telemetry/opentelemetry-lambda/tree/main/ruby). We do not advise installing the `opentelemetry-instrumentation-aws_lambda` gem directly into your Ruby lambda. Instead, clone the [OpenTelemetry Lambda Layer for Ruby](https://github.com/open-telemetry/opentelemetry-lambda/tree/main/ruby) and build the layer locally. Then, save it in your AWS account. ## Usage -From the Lambda Layer side, create the wrapper. More information can be found at https://github.com/open-telemetry/opentelemetry-lambda/tree/main/ruby +From the Lambda Layer side, create the wrapper. More information can be found at Below is an example of `ruby/src/layer/wrapper.rb`, where you can configure the layer to suit your needs before building it: + ```ruby require 'opentelemetry/sdk' require 'opentelemetry/instrumentation/aws_lambda' @@ -44,16 +45,15 @@ This will run SNS publish command, printing OpenTelemetry traces to the console The `opentelemetry-instrumentation-aws_lambda` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License Apache 2.0 license. See [LICENSE][license-github] for more information. -[aws-sdk-home]: https://github.com/aws/aws-sdk-ruby -[bundler-home]: https://bundler.io [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/aws_sdk/README.md b/instrumentation/aws_sdk/README.md index cc728d574..e1885d7a9 100644 --- a/instrumentation/aws_sdk/README.md +++ b/instrumentation/aws_sdk/README.md @@ -6,7 +6,7 @@ The OpenTelemetry `aws-sdk` gem is a community maintained instrumentation for [a Install the gem using: -``` +```console gem install opentelemetry-instrumentation-aws_sdk ``` @@ -49,7 +49,7 @@ This will run SNS publish command, printing OpenTelemetry traces to the console The `opentelemetry-instrumentation-aws_sdk` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -61,4 +61,5 @@ Apache 2.0 license. See [LICENSE][license-github] for more information. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/base/README.md b/instrumentation/base/README.md index 86ab3f73f..f6dfb99d2 100644 --- a/instrumentation/base/README.md +++ b/instrumentation/base/README.md @@ -6,7 +6,7 @@ The `opentelemetry-instrumentation-base` gem contains the instrumentation base c Install the gem using: -``` +```console gem install opentelemetry-instrumentation-base ``` @@ -140,7 +140,7 @@ end The `opentelemetry-instrumentation-base` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -151,4 +151,5 @@ The `opentelemetry-instrumentation-base` gem is distributed under the Apache 2.0 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/bunny/README.md b/instrumentation/bunny/README.md index ea3870836..d3c0d936a 100644 --- a/instrumentation/bunny/README.md +++ b/instrumentation/bunny/README.md @@ -6,7 +6,7 @@ The bunny instrumentation is a community-maintained instrumentation for [bunny][ Install the gem using: -``` +```console gem install opentelemetry-instrumentation-bunny ``` @@ -38,7 +38,7 @@ Example usage can be seen in the `./example/bunny.rb` file [here](https://github The `opentelemetry-instrumentation-bunny` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] 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]. +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]. ## License @@ -50,4 +50,5 @@ The `opentelemetry-instrumentation-bunny` gem is distributed under the Apache 2. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings -[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/concurrent_ruby/README.md b/instrumentation/concurrent_ruby/README.md index aceb4703f..c8cfc9f72 100644 --- a/instrumentation/concurrent_ruby/README.md +++ b/instrumentation/concurrent_ruby/README.md @@ -6,7 +6,7 @@ The OpenTelemetry Concurrent Ruby gem is a community maintained instrumentation Install the gem using: -``` +```console gem install opentelemetry-instrumentation-concurrent_ruby ``` @@ -34,7 +34,7 @@ end The `opentelemetry-instrumentation-concurrent_ruby` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -46,4 +46,5 @@ Apache 2.0 license. See [LICENSE][license-github] for more information. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/dalli/README.md b/instrumentation/dalli/README.md index bf4f988fa..e8ef0f618 100644 --- a/instrumentation/dalli/README.md +++ b/instrumentation/dalli/README.md @@ -6,7 +6,7 @@ The OpenTelemetry Dalli gem is a community maintained instrumentation for the [D Install the gem using: -``` +```console gem install opentelemetry-instrumentation-dalli ``` @@ -50,7 +50,7 @@ end The `opentelemetry-instrumentation-dalli` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -62,4 +62,5 @@ Apache 2.0 license. See [LICENSE][license-github] for more information. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/datadog-porting-guide.md b/instrumentation/datadog-porting-guide.md index 1ccadefd5..ae7868fc8 100644 --- a/instrumentation/datadog-porting-guide.md +++ b/instrumentation/datadog-porting-guide.md @@ -27,7 +27,7 @@ bash-5.0$ ruby trace_demonstration.rb * Rakefile * `tests/test_helper.rb` -* Integrate rubocop (see https://github.com/open-telemetry/opentelemetry-ruby/pull/172#pullrequestreview-349183775) +* Integrate rubocop (see ) ## Examples and template instrumentation @@ -52,14 +52,14 @@ bash-5.0$ ruby trace_demonstration.rb ### otel: span.name (dd-trace-rb: 'resource') -* Prefer "low-cardinality" names (see https://github.com/open-telemetry/opentelemetry-specification/pull/416) +* Prefer "low-cardinality" names (see ) ### otel: span.attributes (dd-trace-rb: 'tags') * `Span` attribute keys should be strings, *not* symbols * `Span` attribute values should be strings, *not* symbols * Prefer to populate span attributes via method arguments (e.g., `tracer.in_span(attributes: ...`) instead of `span.set_attribute` -* Some `Span` attribute naming is based on [semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-semantic-conventions.md), for example [HTTP semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-http.md) +* Some `Span` attribute naming is based on [semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/0.3/specification/data-semantic-conventions.md), for example [HTTP semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/0.3/specification/data-http.md) * When opening a PR, it would be useful to note which attributes come from which semantic conventions, and which ones could not be found * `Span` `:kind` defaults to `:internal` (other available options include `:client` or `:server`) @@ -70,6 +70,7 @@ bash-5.0$ ruby trace_demonstration.rb ### Runtime performance considerations Watch for "low hanging fruit" performance improvements including: + * reduce object allocations - move to a constant, or cache values that would be generated repeatedly * look for "easy wins" vs. "complete redesigns" diff --git a/instrumentation/delayed_job/README.md b/instrumentation/delayed_job/README.md index f5b313361..0a72d2cb0 100644 --- a/instrumentation/delayed_job/README.md +++ b/instrumentation/delayed_job/README.md @@ -6,7 +6,7 @@ The OpenTelemetry Delayed Job Ruby gem is a community maintained instrumentation Install the gem using: -``` +```console gem install opentelemetry-instrumentation-delayed_job ``` @@ -38,7 +38,7 @@ Example usage of delayed_job can be seen in the `./example/delayed_job.rb` file The `opentelemetry-instrumentation-delayed_job` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -50,4 +50,5 @@ Apache 2.0 license. See [LICENSE][license-github] for more information. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/ethon/README.md b/instrumentation/ethon/README.md index ce47c81bc..fcf92dca7 100644 --- a/instrumentation/ethon/README.md +++ b/instrumentation/ethon/README.md @@ -6,7 +6,7 @@ The ethon instrumentation is a community-maintained instrumentation for the [eth Install the gem using: -``` +```console gem install opentelemetry-instrumentation-ethon ``` @@ -38,17 +38,17 @@ Example usage of faraday can be seen in the `./example/ethon.rb` file [here](htt The `opentelemetry-instrumentation-ethon` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License The `opentelemetry-instrumentation-all` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information. -[ethon]:https://github.com/typhoeus/ethon [ethon-home]:https://github.com/typhoeus/ethon [bundler-home]: https://bundler.io [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/excon/README.md b/instrumentation/excon/README.md index 6a7f0a1ca..10851d800 100644 --- a/instrumentation/excon/README.md +++ b/instrumentation/excon/README.md @@ -6,7 +6,7 @@ The excon instrumentation is a community-maintained instrumentation for the [exc Install the gem using: -``` +```console gem install opentelemetry-instrumentation-excon ``` @@ -16,7 +16,6 @@ Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-e To install the instrumentation, call `use` with the name of the instrumentation. - ```ruby OpenTelemetry::SDK.configure do |c| c.use 'OpenTelemetry::Instrumentation::Excon' @@ -35,7 +34,7 @@ end The `opentelemetry-instrumentation-excon` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -47,4 +46,5 @@ The `opentelemetry-instrumentation-all` gem is distributed under the Apache 2.0 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/faraday/README.md b/instrumentation/faraday/README.md index 6e1b7bcfb..f8e23bc45 100644 --- a/instrumentation/faraday/README.md +++ b/instrumentation/faraday/README.md @@ -6,7 +6,7 @@ The OpenTelemetry Faraday Ruby gem is a community maintained instrumentation for Install the gem using: -``` +```console gem install opentelemetry-instrumentation-faraday ``` @@ -38,7 +38,7 @@ Example usage of faraday can be seen in the `./example/faraday.rb` file [here](h The `opentelemetry-instrumentation-faraday` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -50,4 +50,5 @@ Apache 2.0 license. See [LICENSE][license-github] for more information. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/grape/README.md b/instrumentation/grape/README.md index e1d091f15..ca046a235 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](opentelemetry-rack-instrumentation). +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 currently supports the following events: @@ -15,7 +15,7 @@ It currently supports the following events: Install the gem using: -``` +```console gem install opentelemetry-instrumentation-grape ``` @@ -75,7 +75,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here]( The `opentelemetry-instrumentation-grape` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -86,6 +86,6 @@ The `opentelemetry-instrumentation-grape` gem is distributed under the Apache 2. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions [grape]: https://github.com/ruby-grape/grape -[opentelemetry-rack-instrumentation]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/rack diff --git a/instrumentation/graphql/README.md b/instrumentation/graphql/README.md index f2fa7aab3..e0aff335e 100644 --- a/instrumentation/graphql/README.md +++ b/instrumentation/graphql/README.md @@ -6,7 +6,7 @@ The OpenTelemetry GraphQL Ruby gem is a community maintained instrumentation for Install the gem using: -``` +```console gem install opentelemetry-instrumentation-graphql ``` @@ -66,7 +66,7 @@ An example of usage can be seen in [`example/graphql.rb`](https://github.com/ope The `opentelemetry-instrumentation-graphql` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -78,4 +78,5 @@ The `opentelemetry-instrumentation-graphql` gem is distributed under the Apache [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/gruf/README.md b/instrumentation/gruf/README.md index 829317afa..fae675ebc 100644 --- a/instrumentation/gruf/README.md +++ b/instrumentation/gruf/README.md @@ -6,7 +6,7 @@ Todo: Add a description. Install the gem using: -``` +```console gem install opentelemetry-instrumentation-gruf ``` @@ -43,7 +43,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here]( The `opentelemetry-instrumentation-gruf` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -54,4 +54,5 @@ The `opentelemetry-instrumentation-gruf` gem is distributed under the Apache 2.0 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/http/README.md b/instrumentation/http/README.md index d8d533900..91d7fe8d9 100644 --- a/instrumentation/http/README.md +++ b/instrumentation/http/README.md @@ -6,7 +6,7 @@ The HTTP instrumentation is a community-maintained instrumentation for the [HTTP Install the gem using: -``` +```console gem install opentelemetry-instrumentation-http ``` @@ -50,7 +50,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here]( The `opentelemetry-instrumentation-http` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -62,4 +62,5 @@ The `opentelemetry-instrumentation-http` gem is distributed under the Apache 2.0 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/http_client/README.md b/instrumentation/http_client/README.md index a9568e360..3f5719d97 100644 --- a/instrumentation/http_client/README.md +++ b/instrumentation/http_client/README.md @@ -6,7 +6,7 @@ The HttpClient instrumentation is a community-maintained instrumentation for the Install the gem using: -``` +```console gem install opentelemetry-instrumentation-http_client ``` @@ -38,7 +38,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here]( The `opentelemetry-instrumentation-http_client` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -50,4 +50,5 @@ The `opentelemetry-instrumentation-http_client` gem is distributed under the Apa [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/httpx/README.md b/instrumentation/httpx/README.md index 2053e8ab1..c84891617 100644 --- a/instrumentation/httpx/README.md +++ b/instrumentation/httpx/README.md @@ -6,7 +6,7 @@ The HTTPX instrumentation is a community-maintained instrumentation for the [HTT Install the gem using: -``` +```console gem install opentelemetry-instrumentation-httpx ``` @@ -34,16 +34,17 @@ end The `opentelemetry-instrumentation-httpx` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License The `opentelemetry-instrumentation-httpx` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information. -[http-home]: https://gitlab.com/os85/httpx [bundler-home]: https://bundler.io [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions +[httpx-home]: https://github.com/HoneyryderChuck/httpx diff --git a/instrumentation/koala/README.md b/instrumentation/koala/README.md index 9d9e25ab1..b304d01b5 100644 --- a/instrumentation/koala/README.md +++ b/instrumentation/koala/README.md @@ -6,7 +6,7 @@ The Koala instrumentation is a community-maintained instrumentation for the [Koa Install the gem using: -``` +```console gem install opentelemetry-instrumentation-koala ``` @@ -39,7 +39,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here]( The `opentelemetry-instrumentation-koala` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -51,4 +51,5 @@ The `opentelemetry-instrumentation-koala` gem is distributed under the Apache 2. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/lmdb/README.md b/instrumentation/lmdb/README.md index d1f9d653c..46be394d0 100644 --- a/instrumentation/lmdb/README.md +++ b/instrumentation/lmdb/README.md @@ -6,7 +6,7 @@ The LMDB instrumentation is a community-maintained instrumentation for the [LMDB Install the gem using: -``` +```console gem install opentelemetry-instrumentation-lmdb ``` @@ -34,7 +34,7 @@ end The `opentelemetry-instrumentation-lmdb` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -46,4 +46,5 @@ The `opentelemetry-instrumentation-lmdb` gem is distributed under the Apache 2.0 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/mongo/README.md b/instrumentation/mongo/README.md index 008ba7102..bc76a6ccb 100644 --- a/instrumentation/mongo/README.md +++ b/instrumentation/mongo/README.md @@ -6,7 +6,7 @@ The OpenTelemetry Mongo Ruby gem is a community maintained instrumentation for [ Install the gem using: -``` +```console gem install opentelemetry-instrumentation-mongo ``` @@ -62,7 +62,7 @@ This will run a few MongoDB commands, printing OpenTelemetry traces to the conso The `opentelemetry-instrumentation-mongo` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -74,4 +74,5 @@ Apache 2.0 license. See [LICENSE][license-github] for more information. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/mysql2/README.md b/instrumentation/mysql2/README.md index 7ba249e74..9c25a103c 100644 --- a/instrumentation/mysql2/README.md +++ b/instrumentation/mysql2/README.md @@ -6,7 +6,7 @@ The OpenTelemetry Mysql2 Ruby gem is a community maintained instrumentation for Install the gem using: -``` +```console gem install opentelemetry-instrumentation-mysql2 ``` @@ -61,7 +61,7 @@ An example of usage can be seen in [`example/mysql2.rb`](https://github.com/open The `opentelemetry-instrumentation-mysql2` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] 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]. +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]. ## License @@ -73,4 +73,5 @@ The `opentelemetry-instrumentation-mysql2` gem is distributed under the Apache 2 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings -[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/net_http/README.md b/instrumentation/net_http/README.md index fed31f157..bc6eacded 100644 --- a/instrumentation/net_http/README.md +++ b/instrumentation/net_http/README.md @@ -6,7 +6,7 @@ The OpenTelemetry Net::HTTP Ruby gem is a community maintained instrumentation f Install the gem using: -``` +```console gem install opentelemetry-instrumentation-net_http ``` @@ -38,7 +38,7 @@ An example of usage can be seen in [`example/net_http.rb`](https://github.com/op The `opentelemetry-instrumentation-net_http` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -50,4 +50,5 @@ Apache 2.0 license. See [LICENSE][license-github] for more information. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/pg/README.md b/instrumentation/pg/README.md index 12c4c167d..fee4b650c 100644 --- a/instrumentation/pg/README.md +++ b/instrumentation/pg/README.md @@ -6,7 +6,7 @@ The OpenTelemetry PG Ruby gem is a community maintained instrumentation for [PG] Install the gem using: -``` +```console gem install opentelemetry-instrumentation-pg ``` @@ -66,7 +66,7 @@ An example of usage can be seen in [`example/pg.rb`](https://github.com/open-tel The `opentelemetry-instrumentation-pg` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] 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]. +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]. ## License @@ -78,4 +78,6 @@ The `opentelemetry-instrumentation-pg` gem is distributed under the Apache 2.0 l [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings -[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions + diff --git a/instrumentation/que/README.md b/instrumentation/que/README.md index 940aa1794..7534a9cb2 100644 --- a/instrumentation/que/README.md +++ b/instrumentation/que/README.md @@ -6,7 +6,7 @@ The Que instrumentation is a community-maintained instrumentation for the [Que][ Install the gem using: -``` +```console gem install opentelemetry-instrumentation-que ``` @@ -63,25 +63,25 @@ end The `opentelemetry-instrumentation-que` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## Testing the gem locally To install test dependencies run: -``` +```console bundle exec appraisal ``` To run tests on all appraised Que versions, run: -``` +```console bundle exec appraisal rake test ``` To run tests with a specific Que version, run: -``` +```console bundle exec appraisal [que-version] rake test ``` @@ -97,5 +97,6 @@ The `opentelemetry-instrumentation-que` gem is distributed under the Apache 2.0 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions [appraisal-file]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/que/Appraisals diff --git a/instrumentation/racecar/README.md b/instrumentation/racecar/README.md index 393f32069..a7f93d5f1 100644 --- a/instrumentation/racecar/README.md +++ b/instrumentation/racecar/README.md @@ -2,12 +2,11 @@ The Racecar instrumentation is a community-maintained instrumentation for [Racecar](https://github.com/zendesk/racecar), a client library for Apache Kafka. - ## How do I get started? Install the gem using: -``` +```console gem install opentelemetry-instrumentation-racecar ``` @@ -43,7 +42,7 @@ Example usage can be seen in the `./example` directory [here](https://github.com The `opentelemetry-instrumentation-racecar` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -54,4 +53,5 @@ The `opentelemetry-instrumentation-racecar` gem is distributed under the Apache [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/rack/README.md b/instrumentation/rack/README.md index 290ad59bc..79c935c08 100644 --- a/instrumentation/rack/README.md +++ b/instrumentation/rack/README.md @@ -6,7 +6,7 @@ The Rack instrumentation is a community-maintained instrumentation for the [Rack Install the gem using: -``` +```console gem install opentelemetry-instrumentation-rack ``` @@ -67,7 +67,7 @@ By default we will set the rack span name to match the format "HTTP #{method}" ( We surface a hook to easily retrieve the rack span within the context of a request so that you can add information to or rename your server span. -This is how the rails controller instrumentation is able to rename the span names to match the controller and action that process the request. See https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/action_pack/lib/opentelemetry/instrumentation/action_pack/patches/action_controller/metal.rb#L15-L16 for an example. +This is how the rails controller instrumentation is able to rename the span names to match the controller and action that process the request. See for an example. ### High cardinality example @@ -87,7 +87,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here]( The `opentelemetry-instrumentation-rack` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -99,4 +99,5 @@ The `opentelemetry-instrumentation-rack` gem is distributed under the Apache 2.0 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/rails/README.md b/instrumentation/rails/README.md index 330db609f..47ada008c 100644 --- a/instrumentation/rails/README.md +++ b/instrumentation/rails/README.md @@ -55,6 +55,7 @@ gem "opentelemetry-instrumentation-rails", require: "opentelemetry/instrumentati The Rails instrumentation attempts to mirror the structure of the Ruby on Rails. It is a collection of instrumentation gems for components of Rails such as Action View, Active Record, Action Pack, etc... You may want to include all of the Rails instrumentation but disable a single instrumentation gem that it includes. Here is an example of how you can disable Active Record when using this instrumentation gem. + ```ruby OpenTelemetry::SDK.configure do |c| c.use_all({ 'OpenTelemetry::Instrumentation::ActiveRecord' => { enabled: false } }) @@ -69,7 +70,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here]( The `opentelemetry-instrumentation-rails` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -81,4 +82,5 @@ The `opentelemetry-instrumentation-rails` gem is distributed under the Apache 2. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/rake/README.md b/instrumentation/rake/README.md index 1b07ccf5e..bcdccaa03 100644 --- a/instrumentation/rake/README.md +++ b/instrumentation/rake/README.md @@ -6,7 +6,7 @@ The Rake instrumentation is a community-maintained instrumentation for the [Rake Install the gem using: -``` +```console gem install opentelemetry-instrumentation-rake ``` @@ -32,13 +32,13 @@ 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/rake/example/rake.rb) +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) ## How can I get involved? The `opentelemetry-instrumentation-rake` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -49,4 +49,5 @@ The `opentelemetry-instrumentation-rake` gem is distributed under the Apache 2.0 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/rdkafka/README.md b/instrumentation/rdkafka/README.md index 9f0c9a0ca..21c57c3d7 100644 --- a/instrumentation/rdkafka/README.md +++ b/instrumentation/rdkafka/README.md @@ -6,7 +6,7 @@ The Rdkafka instrumentation is a community-maintained instrumentation for [Rdkaf Install the gem using: -``` +```console gem install opentelemetry-instrumentation-rdkafka ``` @@ -38,7 +38,7 @@ Example usage can be seen in the `./example/rdkafka_trace_demonstration.rb` file The `opentelemetry-instrumentation-rdkafka` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -49,4 +49,5 @@ The `opentelemetry-instrumentation-rdkafka` gem is distributed under the Apache [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/redis/README.md b/instrumentation/redis/README.md index 6cc44aa5d..d86afacc6 100644 --- a/instrumentation/redis/README.md +++ b/instrumentation/redis/README.md @@ -6,7 +6,7 @@ The OpenTelemetry Redis Ruby gem is a community maintained instrumentation for [ Install the gem using: -``` +```console gem install opentelemetry-instrumentation-redis ``` @@ -41,7 +41,7 @@ OpenTelemetry::Instrumentation::Redis.with_attributes('peer.service' => 'cache') end ``` -### Configuration options +###  Configuration options ```ruby OpenTelemetry::SDK.configure do |c| @@ -68,7 +68,7 @@ installed it, it will start and stop automatically when you run `rake`. The `opentelemetry-instrumentation-redis` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -80,4 +80,5 @@ Apache 2.0 license. See [LICENSE][license-github] for more information. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/resque/README.md b/instrumentation/resque/README.md index fda87d084..fc46ca1ad 100644 --- a/instrumentation/resque/README.md +++ b/instrumentation/resque/README.md @@ -6,7 +6,7 @@ The Resque instrumentation is a community-maintained instrumentation for the [Re Install the gem using: -``` +```console gem install opentelemetry-instrumentation-resque ``` @@ -38,7 +38,7 @@ Example usage can be seen in the `./example/trace_demonstration.rb` file [here]( The `opentelemetry-instrumentation-resque` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -50,4 +50,5 @@ The `opentelemetry-instrumentation-resque` gem is distributed under the Apache 2 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/restclient/README.md b/instrumentation/restclient/README.md index 159c8b295..398aae438 100644 --- a/instrumentation/restclient/README.md +++ b/instrumentation/restclient/README.md @@ -6,7 +6,7 @@ The OpenTelemetry RestClient gem is a community maintained instrumentation for t Install the gem using: -``` +```console gem install opentelemetry-instrumentation-restclient ``` @@ -34,7 +34,7 @@ end The `opentelemetry-instrumentation-restclient` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -46,4 +46,5 @@ Apache 2.0 license. See [LICENSE][license-github] for more information. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/rspec/README.md b/instrumentation/rspec/README.md index 64156459b..c14f7674f 100644 --- a/instrumentation/rspec/README.md +++ b/instrumentation/rspec/README.md @@ -6,7 +6,7 @@ The RSpec instrumentation is a community-maintained instrumentation for the [RSp Install the gem using: -``` +```console gem install opentelemetry-instrumentation-rspec ``` @@ -61,7 +61,7 @@ Example usage can be seen in the `/example` directory [here](https://github.com/ The `opentelemetry-instrumentation-rspec` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -72,5 +72,6 @@ The `opentelemetry-instrumentation-rspec` gem is distributed under the Apache 2. [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions [rspec-home]: https://rspec.info diff --git a/instrumentation/ruby_kafka/README.md b/instrumentation/ruby_kafka/README.md index 92c7dd50c..65c38b8ea 100644 --- a/instrumentation/ruby_kafka/README.md +++ b/instrumentation/ruby_kafka/README.md @@ -6,7 +6,7 @@ The RubyKafka instrumentation is a community-maintained instrumentation for [Rub Install the gem using: -``` +```console gem install opentelemetry-instrumentation-ruby_kafka ``` @@ -38,7 +38,7 @@ Example usage can be seen in the `./example/ruby_kafka.rb` file [here](https://g The `opentelemetry-instrumentation-ruby_kafka` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ### Running Tests @@ -73,4 +73,5 @@ The `opentelemetry-instrumentation-ruby_kafka` gem is distributed under the Apac [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/sidekiq/README.md b/instrumentation/sidekiq/README.md index 461f9e717..5e435acfc 100644 --- a/instrumentation/sidekiq/README.md +++ b/instrumentation/sidekiq/README.md @@ -6,7 +6,7 @@ The Sidekiq instrumentation is a community-maintained instrumentation for the [S Install the gem using: -``` +```console gem install opentelemetry-instrumentation-sidekiq ``` @@ -29,6 +29,7 @@ OpenTelemetry::SDK.configure do |c| c.use_all 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) @@ -38,7 +39,7 @@ Example usage can be seen in the `./example/sidekiq.rb` file [here](https://gith You'll need Redis installed locally to run the test suite. Once you've installed it, it will start and stop automatically when you run `rake`. -``` +```console redis-server test/redis.conf ``` @@ -46,7 +47,7 @@ redis-server test/redis.conf The `opentelemetry-instrumentation-sidekiq` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -58,4 +59,5 @@ The `opentelemetry-instrumentation-sidekiq` gem is distributed under the Apache [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/sinatra/README.md b/instrumentation/sinatra/README.md index ddbad1f95..063efad0a 100644 --- a/instrumentation/sinatra/README.md +++ b/instrumentation/sinatra/README.md @@ -6,11 +6,10 @@ The Sinatra instrumentation is a community-maintained instrumentation for the [S Install the gem using: -``` +```console gem install opentelemetry-instrumentation-sinatra ``` - Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-sinatra` to your `Gemfile`. ### Version Compatibility @@ -59,7 +58,7 @@ end The `opentelemetry-instrumentation-sinatra` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -71,4 +70,5 @@ The `opentelemetry-instrumentation-sinatra` gem is distributed under the Apache [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/trilogy/README.md b/instrumentation/trilogy/README.md index 4bbd0be7a..b931e78b7 100644 --- a/instrumentation/trilogy/README.md +++ b/instrumentation/trilogy/README.md @@ -12,7 +12,7 @@ Some key differences in this instrumentation are: Install the gem using: -``` +```console gem install opentelemetry-instrumentation-trilogy ``` @@ -68,7 +68,7 @@ This instrumentation generally uses [Database semantic conventions](https://open The `opentelemetry-instrumentation-trilogy` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -80,4 +80,6 @@ The `opentelemetry-instrumentation-trilogy` gem is distributed under the Apache [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions +[opentelemetry-mysql]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/mysql2 diff --git a/processor/baggage/README.md b/processor/baggage/README.md index 0c5bc8b93..d88b04a3c 100644 --- a/processor/baggage/README.md +++ b/processor/baggage/README.md @@ -13,7 +13,7 @@ Do not put sensitive information in Baggage. Install the gem using: -```shell +```console gem install opentelemetry-processor-baggage ``` @@ -85,7 +85,7 @@ OpenTelemetry::Processor::Baggage::BaggageSpanProcessor.new( The `opentelemetry-processor-baggage` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -96,4 +96,5 @@ The `opentelemetry-instrumentation-sinatra` gem is distributed under the Apache [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/propagator/ottrace/README.md b/propagator/ottrace/README.md index e6a5dde1e..37e7e69e4 100644 --- a/propagator/ottrace/README.md +++ b/propagator/ottrace/README.md @@ -60,7 +60,7 @@ This gem can be used with any OpenTelemetry SDK implementation. This can be the Install the gem using: -``` +```console gem install opentelemetry-propagator-ottrace ``` @@ -68,7 +68,7 @@ Or, if you use [bundler][bundler-home], include `opentelemetry-propagator-ottrac Configure your application to use this propagator by setting the following [environment variable][envars]: -``` +```console OTEL_PROPAGATORS=ottrace ``` @@ -76,7 +76,7 @@ OTEL_PROPAGATORS=ottrace The `opentelemetry-propagator-ottrace` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -88,8 +88,9 @@ The `opentelemetry-propagator-ottrace` gem is distributed under the Apache 2.0 l [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions [ottrace-spec]: https://github.com/opentracing/specification/blob/master/rfc/trace_identifiers.md [rfc7230-url]: https://tools.ietf.org/html/rfc7230#section-3.2 [fields-spec-url]: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/context/api-propagators.md#fields -[envars]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#general-sdk-configuration +[envars]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/sdk-environment-variables.md#general-sdk-configuration diff --git a/propagator/vitess/README.md b/propagator/vitess/README.md index d95561637..47b88eda3 100644 --- a/propagator/vitess/README.md +++ b/propagator/vitess/README.md @@ -31,7 +31,7 @@ This gem can be used with any OpenTelemetry SDK implementation. This can be the Install the gem using: -``` +```console gem install opentelemetry-propagator-vitess ``` @@ -39,7 +39,7 @@ Or, if you use [bundler][bundler-home], include `opentelemetry-propagator-vitess Configure your application to use this propagator with the Trilogy client instrumentation by setting the following [environment variable][envars]: -``` +```console OTEL_RUBY_INSTRUMENTATION_TRILOGY_PROPAGATOR=vitess ``` @@ -47,7 +47,7 @@ OTEL_RUBY_INSTRUMENTATION_TRILOGY_PROPAGATOR=vitess The `opentelemetry-propagator-vitess` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -61,4 +61,5 @@ The `opentelemetry-propagator-vitess` gem is distributed under the Apache 2.0 li [community-meetings]: https://github.com/open-telemetry/community#community-meetings [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions [vitess-spec]: https://vitess.io/docs/16.0/user-guides/configuration-advanced/tracing/#instrumenting-queries -[envars]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#general-sdk-configuration +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY +[envars]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/sdk-environment-variables.md#general-sdk-configuration diff --git a/propagator/xray/README.md b/propagator/xray/README.md index a94b5c1aa..8b2f6ec6d 100644 --- a/propagator/xray/README.md +++ b/propagator/xray/README.md @@ -17,34 +17,37 @@ This gem can be used with any OpenTelemetry SDK implementation. This can be the Install the gem using: -``` +```console gem install opentelemetry-propagator-xray ``` Or, if you use [bundler][bundler-home], include `opentelemetry-propagator-xray` in your `Gemfile`. In your application: -``` + +```ruby require 'opentelemetry/propagator/xray' # Optional ENV['OTEL_PROPAGATORS'] ||= 'xray' # Or you can set this as an environment variable outside of the application ``` ## To generate AWS XRay compliant IDs use the 'OpenTelemetry::AWSXRayTrace' module: -``` + +```ruby require 'opentelemetry/propagator/xray' OpenTelemetry::SDK.configure do |c| c.id_generator = OpenTelemetry::Propagator::XRay::IDGenerator end ``` + The propagator and ID generation are independent and do not need to be used in conjunction but can be. ## How can I get involved? The `opentelemetry-propagator-xray` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] 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]. +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]. ## License @@ -56,5 +59,6 @@ The `opentelemetry-propagator-xray` gem is distributed under the Apache 2.0 lice [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig [community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions [aws-xray]: https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html diff --git a/resources/azure/README.md b/resources/azure/README.md index 1784ff070..43e37c818 100644 --- a/resources/azure/README.md +++ b/resources/azure/README.md @@ -16,7 +16,7 @@ The `opentelemetry-resource-detector-azure` gem provides a means of retrieving a Install the gem using: -``` +```console gem install opentelemetry-sdk gem install opentelemetry-resource-detector-azure ``` @@ -48,11 +48,13 @@ This will populate the following resource attributes for compute running on Azur The `opentelemetry-resource-detector-azure` gem source is on GitHub, along with related gems. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page. +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]. ## License The `opentelemetry-resource-detector-azure` gem is distributed under the Apache 2.0 license. See LICENSE for more information. -[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/discussions -[k8sattributesprocessor-url]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/k8sattributesprocessor/README.md \ No newline at end of file +[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig +[community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/resources/container/README.md b/resources/container/README.md index 2b013d17e..4a10ffec4 100644 --- a/resources/container/README.md +++ b/resources/container/README.md @@ -16,7 +16,7 @@ The `opentelemetry-resource-detector-container` gem provides a means of retrievi Install the gem using: -``` +```console gem install opentelemetry-sdk gem install opentelemetry-resource-detector-container ``` @@ -38,11 +38,14 @@ This will populate the `container.id` resource attribute for processes running o The `opentelemetry-resource-detector-container` gem source is on GitHub, along with related gems. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page. +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]. ## License The `opentelemetry-resource-detector-container` gem is distributed under the Apache 2.0 license. See LICENSE for more information. -[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/discussions -[k8sattributesprocessor-url]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/k8sattributesprocessor/README.md \ No newline at end of file +[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig +[community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions +[k8sattributesprocessor-url]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/k8sattributesprocessor/README.md diff --git a/resources/google_cloud_platform/README.md b/resources/google_cloud_platform/README.md index fb928269b..a34301807 100644 --- a/resources/google_cloud_platform/README.md +++ b/resources/google_cloud_platform/README.md @@ -16,7 +16,7 @@ The `opentelemetry-resource-detector-google_cloud_platform` gem provides a means Install the gem using: -``` +```console gem install opentelemetry-sdk gem install opentelemetry-resource-detector-google_cloud_platform ``` @@ -32,7 +32,6 @@ OpenTelemetry::SDK.configure do |c| end ``` - This will populate the following resource attributes for compute running on Google Cloud Platform: * Compute Engine: @@ -62,11 +61,13 @@ This will populate the following resource attributes for compute running on Goog The `opentelemetry-resource-detector-google_cloud_platform` gem source is on GitHub, along with related gems. -The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page. +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]. ## License The `opentelemetry-resource-detector-google_cloud_platform` gem is distributed under the Apache 2.0 license. See LICENSE for more information. -[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/discussions -[k8sattributesprocessor-url]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/k8sattributesprocessor/README.md \ No newline at end of file +[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig +[community-meetings]: https://github.com/open-telemetry/community#community-meetings +[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions From d87f1f8d1e3c7a68bf88e30b95a26fd1793a7332 Mon Sep 17 00:00:00 2001 From: Kayla Reopelle <87386821+kaylareopelle@users.noreply.github.com> Date: Thu, 8 Aug 2024 06:14:48 -0700 Subject: [PATCH 3/7] ci: Add Ruby 3.3 tests for helpers-* gems (#1058) Co-authored-by: Xuan <112967240+xuan-cao-swi@users.noreply.github.com> Co-authored-by: Ariel Valentin --- .github/workflows/ci-contrib.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/ci-contrib.yml b/.github/workflows/ci-contrib.yml index 135073333..b74aa6f57 100644 --- a/.github/workflows/ci-contrib.yml +++ b/.github/workflows/ci-contrib.yml @@ -29,6 +29,11 @@ jobs: runs-on: ${{ matrix.os }} steps: - uses: actions/checkout@v4 + - name: "Test Ruby 3.3" + uses: ./.github/actions/test_gem + with: + gem: "opentelemetry-helpers-${{ matrix.gem }}" + ruby: "3.3" - name: "Test Ruby 3.2" uses: ./.github/actions/test_gem with: From e8536cf77f14f2a336033165248facaafdde9b9c Mon Sep 17 00:00:00 2001 From: Alex Burgel Date: Thu, 8 Aug 2024 09:35:17 -0400 Subject: [PATCH 4/7] fix(rails): Rails instrumentation should load ActiveJob instrumentation (#1099) * Rails instrumention should load active job and active support * Update rails.rb --------- Co-authored-by: Ariel Valentin --- instrumentation/rails/lib/opentelemetry/instrumentation/rails.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/instrumentation/rails/lib/opentelemetry/instrumentation/rails.rb b/instrumentation/rails/lib/opentelemetry/instrumentation/rails.rb index f421f3a29..267cae1dd 100644 --- a/instrumentation/rails/lib/opentelemetry/instrumentation/rails.rb +++ b/instrumentation/rails/lib/opentelemetry/instrumentation/rails.rb @@ -20,5 +20,6 @@ module Rails require 'opentelemetry-instrumentation-action_view' require 'opentelemetry-instrumentation-action_mailer' require 'opentelemetry-instrumentation-active_record' +require 'opentelemetry-instrumentation-active_job' require_relative 'rails/instrumentation' require_relative 'rails/version' From 7e5c376cf8e3cfee28416b7854606a9ac3a6f964 Mon Sep 17 00:00:00 2001 From: Ariel Valentin Date: Thu, 8 Aug 2024 10:46:37 -0500 Subject: [PATCH 5/7] revert: "feat: Use Default Span Name Format (#1039)" (#1107) This reverts commit f999e702430a55bc9f0fdf7b4748dc2f9b6341b8. --- .../instrumentation/action_view.rb | 2 +- .../action_view/instrumentation.rb | 38 +------------------ .../instrumentation/action_view/railtie.rb | 11 ++---- ...emetry-instrumentation-action_view.gemspec | 2 +- 4 files changed, 7 insertions(+), 46 deletions(-) diff --git a/instrumentation/action_view/lib/opentelemetry/instrumentation/action_view.rb b/instrumentation/action_view/lib/opentelemetry/instrumentation/action_view.rb index ad42d0dec..ef341c0cd 100644 --- a/instrumentation/action_view/lib/opentelemetry/instrumentation/action_view.rb +++ b/instrumentation/action_view/lib/opentelemetry/instrumentation/action_view.rb @@ -9,7 +9,7 @@ module OpenTelemetry module Instrumentation - # (see OpenTelemetry::Instrumentation::ActionView::Instrumentation) + # Contains the OpenTelemetry instrumentation for the ActionView gem module ActionView end end diff --git a/instrumentation/action_view/lib/opentelemetry/instrumentation/action_view/instrumentation.rb b/instrumentation/action_view/lib/opentelemetry/instrumentation/action_view/instrumentation.rb index bb9b60056..9087d4475 100644 --- a/instrumentation/action_view/lib/opentelemetry/instrumentation/action_view/instrumentation.rb +++ b/instrumentation/action_view/lib/opentelemetry/instrumentation/action_view/instrumentation.rb @@ -7,42 +7,7 @@ module OpenTelemetry module Instrumentation module ActionView - # The {OpenTelemetry::Instrumentation::ActionView::Instrumentation} class contains logic to detect and install the ActionView instrumentation - # - # Installation and configuration of this instrumentation is done within the - # {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry/SDK#configure-instance_method OpenTelemetry::SDK#configure} - # block, calling {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry%2FSDK%2FConfigurator:use use()} - # or {https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry%2FSDK%2FConfigurator:use_all use_all()}. - # - # ## Configuration keys and options - # - # ### `:disallowed_notification_payload_keys` - # - # Specifies an array of keys that should be excluded from the notification payload as span attributes. - # - # ### `:notification_payload_transform` - # - # - `proc` **default** `nil` - # - # Specifies custom proc used to extract span attributes form the notification payload. - # Use this to rename keys, extract nested values, or perform any other custom logic. - # - # ### `:legacy_span_names` - # - # - `boolean` **default** `false` - # - # Specifies whether spans names should use the legacy format where the subscription was reverse ordered and white space separated. (Ex. `action_view render_template`) - # If set to `true`, the span name will match the name of the notification itself. (Ex. `render_template.action_view`) - # - # @example An explicit default configuration - # OpenTelemetry::SDK.configure do |c| - # c.use_all({ - # 'OpenTelemetry::Instrumentation::ActionView' => { - # disallowed_notification_payload_keys: [], - # legacy_span_names: true, - # }, - # }) - # end + # The Instrumentation class contains logic to detect and install the ActionView instrumentation class Instrumentation < OpenTelemetry::Instrumentation::Base MINIMUM_VERSION = Gem::Version.new('6.1.0') install do |_config| @@ -59,7 +24,6 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base option :disallowed_notification_payload_keys, default: [], validate: :array option :notification_payload_transform, default: nil, validate: :callable - option :legacy_span_names, default: false, validate: :boolean private diff --git a/instrumentation/action_view/lib/opentelemetry/instrumentation/action_view/railtie.rb b/instrumentation/action_view/lib/opentelemetry/instrumentation/action_view/railtie.rb index 2c2bf381a..276af1106 100644 --- a/instrumentation/action_view/lib/opentelemetry/instrumentation/action_view/railtie.rb +++ b/instrumentation/action_view/lib/opentelemetry/instrumentation/action_view/railtie.rb @@ -19,16 +19,13 @@ class Railtie < ::Rails::Railtie config.after_initialize do ::OpenTelemetry::Instrumentation::ActiveSupport::Instrumentation.instance.install({}) - instance = ::OpenTelemetry::Instrumentation::ActionView::Instrumentation.instance - span_name_formatter = instance.config[:legacy_span_names] ? ::OpenTelemetry::Instrumentation::ActiveSupport::LEGACY_NAME_FORMATTER : nil - SUBSCRIPTIONS.each do |subscription_name| + config = ActionView::Instrumentation.instance.config ::OpenTelemetry::Instrumentation::ActiveSupport.subscribe( - instance.tracer, + ActionView::Instrumentation.instance.tracer, subscription_name, - instance.config[:notification_payload_transform], - instance.config[:disallowed_notification_payload_keys], - span_name_formatter: span_name_formatter + config[:notification_payload_transform], + config[:disallowed_notification_payload_keys] ) end end diff --git a/instrumentation/action_view/opentelemetry-instrumentation-action_view.gemspec b/instrumentation/action_view/opentelemetry-instrumentation-action_view.gemspec index 825106243..27bd8239f 100644 --- a/instrumentation/action_view/opentelemetry-instrumentation-action_view.gemspec +++ b/instrumentation/action_view/opentelemetry-instrumentation-action_view.gemspec @@ -26,7 +26,7 @@ Gem::Specification.new do |spec| spec.required_ruby_version = '>= 3.0' spec.add_dependency 'opentelemetry-api', '~> 1.0' - spec.add_dependency 'opentelemetry-instrumentation-active_support', '~> 0.6' + spec.add_dependency 'opentelemetry-instrumentation-active_support', '~> 0.1' spec.add_dependency 'opentelemetry-instrumentation-base', '~> 0.22.1' spec.add_development_dependency 'appraisal', '~> 2.5' From 19c86ca72ae338fab29311c8a6fdcdac4410e636 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Thu, 8 Aug 2024 14:35:47 -0400 Subject: [PATCH 6/7] fix(pg): update versions to be tested (includes drop support for pg 1.2) (#1108) * include pg 1.4 in Appraisals * drop pg-1.2 from tests * pg 1.2.x does not work under Ruby >= 3.0. * We currently support and test only Ruby >= 3.0. --- instrumentation/pg/Appraisals | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/instrumentation/pg/Appraisals b/instrumentation/pg/Appraisals index 4dc9af1c2..41840b368 100644 --- a/instrumentation/pg/Appraisals +++ b/instrumentation/pg/Appraisals @@ -1,15 +1,13 @@ # frozen_string_literal: true -# 1.2.3 appears to be the most popular version at RubyGems.org -appraise 'pg-1.2' do - gem 'pg', '~> 1.2.3' -end - -# 1.3.0 significantly changed connecting and the handling of connection strings appraise 'pg-1.3' do gem 'pg', '~> 1.3.5' end +appraise 'pg-1.4' do + gem 'pg', '~> 1.4.5' +end + appraise 'pg-latest' do gem 'pg' end From 3584cfae1c2944c0343abfa67035fe4280ccee07 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Thu, 8 Aug 2024 15:20:07 -0400 Subject: [PATCH 7/7] ci: fix ignored errors within appraisal loop (#1103) The existing loop over appraisals for a gem is swallowing any error exits returned by commands within the loop. Resolves #1097. The specific error mentioned in that issue for failure to bundle install pg 1.2 was fixed in #1108. This change fixes the appraisal loop. Fix appraisal loop swallowing errors: * add an explicit exit to the appraisal loop if any command in the chain fails so that the CI step also fails Fix other errors that were being swallowed: * add a workaround for GEM_HOME file permission problems during bundle install * introduced to GitHub runner images sometime early July 2024 * bound which version of Ruby the gruf gem tests are run against * its gemspec includes upper bounds on Ruby versions which cause bundler install to fail under newer Rubies --- .github/actions/test_gem/action.yml | 9 ++++++++- instrumentation/gruf/Appraisals | 20 ++++++++++++++------ 2 files changed, 22 insertions(+), 7 deletions(-) diff --git a/.github/actions/test_gem/action.yml b/.github/actions/test_gem/action.yml index 401c30102..7b429a72a 100644 --- a/.github/actions/test_gem/action.yml +++ b/.github/actions/test_gem/action.yml @@ -82,6 +82,13 @@ runs: ruby-version: "${{ inputs.ruby }}" bundler: "latest" working-directory: "${{ steps.setup.outputs.gem_dir }}" + # Perms workaround. See https://github.com/actions/runner-images/issues/10215 + - name: Fix GEM_HOME permissions on GitHub Actions Runner + if: "${{ steps.setup.outputs.appraisals == 'true' }}" + shell: bash + run: | + # 🛠️😭 Fix GEM_HOME permissions 😭🛠️ + chmod -R o-w $(gem env home) - name: Install dependencies and generate appraisals if: "${{ steps.setup.outputs.appraisals == 'true' }}" shell: bash @@ -100,7 +107,7 @@ runs: echo "::group::🔎 Appraising ${i}" BUNDLE_GEMFILE=gemfiles/${i}.gemfile bundle install --quiet --jobs=3 --retry=4 && \ BUNDLE_GEMFILE=gemfiles/${i}.gemfile bundle show && \ - BUNDLE_GEMFILE=gemfiles/${i}.gemfile bundle exec rake test + BUNDLE_GEMFILE=gemfiles/${i}.gemfile bundle exec rake test || exit echo "::endgroup::" done else diff --git a/instrumentation/gruf/Appraisals b/instrumentation/gruf/Appraisals index c07e47bb9..1ad02a912 100644 --- a/instrumentation/gruf/Appraisals +++ b/instrumentation/gruf/Appraisals @@ -4,14 +4,22 @@ # # SPDX-License-Identifier: Apache-2.0 -appraise 'gruf-2.17' do - gem 'gruf', '~> 2.17.0' +if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.3') + appraise 'gruf-2.17' do + gem 'gruf', '~> 2.17.0' + end + + appraise 'gruf-2.18' do + gem 'gruf', '~> 2.18.0' + end end -appraise 'gruf-2.18' do - gem 'gruf', '~> 2.18.0' +if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.4') + appraise 'gruf-2.19' do + gem 'gruf', '~> 2.19.0' + end end -appraise 'gruf-2.19' do - gem 'gruf', '~> 2.19.0' +appraise 'gruf-latest' do + gem 'gruf' end