opentelemetry-auto-instrumentation 0.0.0 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1b0d45ec6b941e4a75023368f4536e00d22a31447cb303a2c0d3f470ccfb5a3c
4
- data.tar.gz: dae5536d6035f67546136f12ffe1fc52d602bdffc8dd5eeba120fec2313c4cd7
3
+ metadata.gz: fe591f0ac242d6e1572c9bc1bb838577fea6baf079cc1e62bf1ea90807a431cb
4
+ data.tar.gz: f56189e23e4b3749cef8c524a0858d29c9e6c622bbd955aa6d3f5056699c7d57
5
5
  SHA512:
6
- metadata.gz: 822bbd96adc51da5660dea36b84486ac9dd7781369802f43b6e5cd1739bb006bd4dbb4293fe3e7c4534d467a33719fe4f500f5d37526b081a8b8308577abb9ef
7
- data.tar.gz: 8cf8d948c812075b068479e25737a0d43999831f2dea87a018d6d62fe8c1049d96bb27076f88173ed91d4bd4ae1939669d768402ee9e8ce8e5c215c14014d909
6
+ metadata.gz: 01b3209652b97937fd4026289f7acee815dfb90b2c14b9b1faba0ad47e39da32efa544884b5ce246643b39c856da3db166cdefe491094d3dce6461d20aab7d67
7
+ data.tar.gz: 757817de6de3a2f53cb41095f9dabcd13efc3027e419f04a7be68fdc07c0756270056a9b93ad786076cec6f0602ddf0e8404f9d8c1e074652fe6007d02ff5857
data/AGENTS.md ADDED
@@ -0,0 +1,122 @@
1
+ # Agent Instructions for opentelemetry-ruby-instrumentation
2
+
3
+ ## Project Overview
4
+
5
+ This repository contains the `opentelemetry-auto-instrumentation` Ruby gem, which provides automatic zero-code instrumentation for Ruby applications by patching `Bundler::Runtime#require` to inject OpenTelemetry SDK initialization when gems are loaded.
6
+
7
+ **Key exported signals:** traces, metrics, and logs — all exported via OTLP to `http://localhost:4318` by default.
8
+
9
+ Before starting any task, read [CONTRIBUTING.md](CONTRIBUTING.md) and this file.
10
+
11
+ ## Core Expectations
12
+
13
+ - Preserve OpenTelemetry specification compliance and idiomatic Ruby.
14
+ - Prefer minimal, surgical changes over broad refactors or speculative cleanup.
15
+ - Read the file you are editing and match its existing naming, error handling, comments, and test patterns.
16
+ - Keep telemetry resilient and loosely coupled — never introduce behavior that can unexpectedly interfere with the host application.
17
+ - Telemetry must be fail-safe: it should not raise, block indefinitely, or amplify attacker-controlled input.
18
+ - Keep dependencies minimal and justified.
19
+ - Write comments only for intent, invariants, and non-obvious constraints. Do not add comments that restate the code.
20
+
21
+ ## Default Workflow
22
+
23
+ For new features and behavior changes, unless the task says otherwise:
24
+
25
+ 1. Read the relevant file, its tests, and the `README.md`.
26
+ 2. Add or update a failing unit test that captures the required behavior or regression.
27
+ 3. Implement the smallest change that makes the test pass.
28
+ 4. Refactor only after behavior is locked in, and only if it keeps the diff focused.
29
+ 5. Update documentation (`README.md`, `CHANGELOG.md`) while the context is fresh.
30
+ 6. Run `bundle exec rake test` before considering the work complete.
31
+
32
+ ## Repository Structure
33
+
34
+ ```console
35
+ lib/opentelemetry-auto-instrumentation.rb # Main gem entry point; contains OTelBundlerPatch
36
+ lib/opentelemetry/auto_instrumentation/
37
+ version.rb # Gem version
38
+ test/
39
+ opentelemetry-auto-instrumentation_test.rb
40
+ test_helper.rb
41
+ example/
42
+ rails-example/ # Rails usage example
43
+ simple-example/ # Plain Ruby usage example
44
+ .github/
45
+ workflows/ # CI, release, and Renovate automation
46
+ renovate.json5 # Dependency update config
47
+ ```
48
+
49
+ ## Development Environment
50
+
51
+ Always use Docker for development — do **not** install dependencies directly on the host:
52
+
53
+ ```console
54
+ docker compose run app
55
+ ```
56
+
57
+ This mounts the repo at `/app` with all Ruby dependencies pre-installed.
58
+
59
+ ## Running Tests
60
+
61
+ ```console
62
+ bundle exec rake test
63
+ ```
64
+
65
+ All tests must pass before opening a pull request.
66
+
67
+ ## Code Conventions
68
+
69
+ - All Ruby files must include `# frozen_string_literal: true` at the top.
70
+ - License header required: `# Copyright The OpenTelemetry Authors` / `# SPDX-License-Identifier: Apache-2.0`.
71
+ - Module/method names follow the `_otel_` prefix convention for internal OTel helpers (e.g., `_otel_snake_case`, `_otel_registry_aliases_for`).
72
+ - Environment variables use the `OTEL_RUBY_` prefix for gem-specific config; standard OTel env vars (e.g., `OTEL_SERVICE_NAME`) are passed through unchanged.
73
+
74
+ ## Release Process
75
+
76
+ Releases are managed via GitHub Actions workflows (no `toys`/`toys-release`):
77
+
78
+ 1. **`release-request.yml`** (`workflow_dispatch` with optional `version`/`changelog` inputs, or a weekly `schedule`) — bumps `lib/opentelemetry/auto_instrumentation/version.rb`, updates `CHANGELOG.md`, and opens a release PR labeled `release`. On the weekly schedule (and on manual runs without inputs), the version bump and changelog are auto-computed from conventional commit messages since the last release tag; the job is skipped if there are no new commits. Does **not** publish to RubyGems.
79
+ 2. **`release.yml`** (triggered when a PR labeled `release` is merged) — builds the gem, publishes it to RubyGems.org using `GEM_HOST_API_KEY` (`RUBYGEMS_API_KEY` secret), and creates the GitHub release with the matching changelog notes.
80
+
81
+ Do not manually push gems or tag releases — always go through the workflow.
82
+
83
+ ## Dependency Updates (Renovate)
84
+
85
+ Renovate runs on a weekly schedule:
86
+
87
+ - **Patch/digest updates:** before 6am on Monday
88
+ - **Minor updates:** before 7am on Monday
89
+ - **Major updates:** before 8am on Monday
90
+ - **Lock file maintenance:** before 4am on Tuesday
91
+
92
+ Ruby version updates in gemspecs and Dockerfile require dashboard approval (`dependencyDashboardApproval: true`) and a minimum release age of 820 days before a PR is opened.
93
+
94
+ ## Key Environment Variables
95
+
96
+ | Variable | Purpose |
97
+ | --- | --- |
98
+ | `OTEL_RUBY_REQUIRE_BUNDLER` | Set `true` for frameworks that don't auto-call `Bundler.require` (e.g., Sinatra) |
99
+ | `OTEL_RUBY_ENABLED_INSTRUMENTATIONS` | Comma-separated list to load only specific instrumentations |
100
+ | `OTEL_RUBY_RESOURCE_DETECTORS` | Enable resource detectors: `container`, `azure`, `aws` |
101
+ | `OTEL_RUBY_ADDITIONAL_GEM_PATH` | Custom gem path for OpenTelemetry Operator environments |
102
+ | `DISALLOWED_LIB_PATH` | Exclude specific helper gems from `$LOAD_PATH` injection |
103
+ | `OTEL_RUBY_AUTO_INSTRUMENTATION_DEBUG` | Set `true` for debug output during initialization |
104
+
105
+ ## Pull Request Guidelines
106
+
107
+ - One logical change per PR. Do not bundle multiple fixes, refactors, or features — split them so each can be reviewed and reverted independently.
108
+ - Keep AI-assisted PRs tightly scoped to the requested change; never include unrelated cleanup or opportunistic improvements unless strictly necessary for correctness.
109
+ - Add tests for any new functionality.
110
+ - Update documentation (README, CHANGELOG) as needed.
111
+ - Use [conventional commits](https://www.conventionalcommits.org/) — enforced by CI.
112
+
113
+ ## AI Agent Rules
114
+
115
+ - **Never post AI-generated comments on issues or PRs.** Discussions on OpenTelemetry repositories are for humans only. You cannot comment on issue or PR threads on a user's behalf.
116
+ - If significant parts of a commit are produced by an AI tool, disclose it with an `Assisted-by:` commit message trailer (e.g., `Assisted-by: Claude Opus 4.8`).
117
+ - When catching exceptions from an instrumented library to record telemetry, re-raise the original exception unmodified. Do not raise new exceptions from instrumentation/telemetry code.
118
+
119
+ ## Community
120
+
121
+ - Slack: [#otel-ruby](https://cloud-native.slack.com/archives/C01NWKKMKMY)
122
+ - Maintainers: [open-telemetry/ruby-instrumentation-approvers](https://github.com/orgs/open-telemetry/teams/ruby-instrumentation-approvers)
data/CHANGELOG.md ADDED
@@ -0,0 +1,6 @@
1
+ # Release History: opentelemetry-auto-instrumentation
2
+
3
+ ## v0.1.0 / 2026-09-01
4
+
5
+ - Initial release.
6
+
data/CLAUDE.md ADDED
@@ -0,0 +1,3 @@
1
+ # Instructions for Claude Code
2
+
3
+ @AGENTS.md
@@ -0,0 +1,3 @@
1
+ # OpenTelemetry Community Code of Conduct
2
+
3
+ Please refer to our [OpenTelemetry Community Code of Conduct](https://github.com/open-telemetry/community/blob/main/code-of-conduct.md).
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,47 @@
1
+ # Contributing to OpenTelemetry Ruby Instrumentation
2
+
3
+ We'd love your help! Use tags [good first issue](https://github.com/open-telemetry/opentelemetry-ruby-instrumentation/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and [help wanted](https://github.com/open-telemetry/opentelemetry-ruby-instrumentation/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) to get started with the project.
4
+
5
+ ## How to Get Involved
6
+
7
+ The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by:
8
+
9
+ - Joining us on [GitHub Discussions][discussions-url]
10
+ - Joining the [Slack Channel][slack-channel]
11
+ - Attending our weekly meeting — see the [meeting calendar][community-meetings] for dates and times
12
+
13
+ For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
14
+
15
+ ## Development Setup
16
+
17
+ Build and start a development shell using Docker:
18
+
19
+ ```console
20
+ docker compose run app
21
+ ```
22
+
23
+ This mounts the repository at `/app` and provides a fully configured Ruby environment with all dependencies available.
24
+
25
+ ## Running Tests
26
+
27
+ From inside the container (or via `docker compose run`):
28
+
29
+ ```console
30
+ bundle exec rake test
31
+ ```
32
+
33
+ ## Opening Pull Requests
34
+
35
+ - Keep pull requests focused on a single concern.
36
+ - Add tests for any new functionality.
37
+ - Ensure all existing tests pass before submitting.
38
+ - Update documentation as needed.
39
+
40
+ ## Code of Conduct
41
+
42
+ This project follows the [OpenTelemetry Community Code of Conduct](https://github.com/open-telemetry/community/blob/main/code-of-conduct.md).
43
+
44
+ [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
45
+ [community-meetings]: https://github.com/open-telemetry/community#community-meetings
46
+ [slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
47
+ [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby-instrumentation/discussions
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright The OpenTelemetry Authors
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,266 @@
1
+ # OpenTelemetry Ruby Instrumentation
2
+
3
+ [![Slack channel](https://img.shields.io/badge/slack-@cncf/otel--ruby-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C01NWKKMKMY)
4
+ [![Apache License](https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat)](https://github.com/open-telemetry/opentelemetry-ruby-instrumentation/blob/main/LICENSE)
5
+
6
+ The `opentelemetry-auto-instrumentation` gem provides automatic loading and initialization of the OpenTelemetry Ruby SDK for zero-code instrumentation of your applications.
7
+
8
+ - [Getting Started](#getting-started)
9
+ - [Telemetry Signals](#telemetry-signals)
10
+ - [Usage](#usage)
11
+ - [Configuration](#configuration)
12
+ - [Troubleshooting](#troubleshooting)
13
+ - [Example](#example)
14
+ - [Contributing](#contributing)
15
+ - [Versioning](#versioning)
16
+ - [Useful links](#useful-links)
17
+ - [License](#license)
18
+
19
+ ## Getting Started
20
+
21
+ Install the gem:
22
+
23
+ ```console
24
+ gem install opentelemetry-auto-instrumentation
25
+ ```
26
+
27
+ > **Note:** Install via `gem install` rather than adding to your Gemfile, as this gem needs to load before your application starts.
28
+
29
+ Then instrument any Ruby application:
30
+
31
+ ```console
32
+ RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
33
+ ```
34
+
35
+ For Rails (which calls `Bundler.require` automatically):
36
+
37
+ ```console
38
+ RUBYOPT="-r opentelemetry-auto-instrumentation" rails server
39
+ ```
40
+
41
+ For other frameworks (Sinatra, Rackup, etc.) that don't call `Bundler.require` automatically:
42
+
43
+ ```console
44
+ OTEL_RUBY_REQUIRE_BUNDLER=true RUBYOPT="-r opentelemetry-auto-instrumentation" rackup config.ru
45
+ ```
46
+
47
+ ### What gets installed?
48
+
49
+ Installing `opentelemetry-auto-instrumentation` automatically includes:
50
+
51
+ ```text
52
+ opentelemetry-sdk
53
+ opentelemetry-api
54
+ opentelemetry-instrumentation-all
55
+ opentelemetry-exporter-otlp
56
+ opentelemetry-exporter-otlp-metrics
57
+ opentelemetry-exporter-otlp-logs
58
+ opentelemetry-helpers-mysql
59
+ opentelemetry-helpers-sql-processor
60
+ opentelemetry-resource-detector-azure
61
+ opentelemetry-resource-detector-container
62
+ opentelemetry-resource-detector-aws
63
+ ```
64
+
65
+ ## Telemetry Signals
66
+
67
+ By default, this gem sets up **traces, metrics, and logs** and exports all three to an OTLP endpoint (`http://localhost:4318`). Each signal can be configured or disabled independently via standard OpenTelemetry environment variables.
68
+
69
+ ### Traces
70
+
71
+ Traces are enabled by default using the OTLP exporter. See the [opentelemetry-sdk README][otel-sdk-readme] for full configuration options.
72
+
73
+ **Disable traces:**
74
+
75
+ ```console
76
+ OTEL_TRACES_EXPORTER=none RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
77
+ ```
78
+
79
+ **Custom endpoint:**
80
+
81
+ ```console
82
+ OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://my-collector:4318/v1/traces \
83
+ RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
84
+ ```
85
+
86
+ ### Metrics
87
+
88
+ Metrics are enabled by default using the OTLP metrics exporter. See the [opentelemetry-metrics-sdk README][otel-metrics-sdk-readme] for full configuration options.
89
+
90
+ **Disable metrics:**
91
+
92
+ ```console
93
+ OTEL_METRICS_EXPORTER=none RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
94
+ ```
95
+
96
+ **Custom endpoint:**
97
+
98
+ ```console
99
+ OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=http://my-collector:4318/v1/metrics \
100
+ RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
101
+ ```
102
+
103
+ ### Logs
104
+
105
+ Logs are enabled by default using the OTLP logs exporter. See the [opentelemetry-logs-sdk README][otel-logs-sdk-readme] for full configuration options.
106
+
107
+ **Disable logs:**
108
+
109
+ ```console
110
+ OTEL_LOGS_EXPORTER=none RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
111
+ ```
112
+
113
+ **Custom endpoint:**
114
+
115
+ ```console
116
+ OTEL_EXPORTER_OTLP_LOGS_ENDPOINT=http://my-collector:4318/v1/logs \
117
+ RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
118
+ ```
119
+
120
+ ### Disable all signals except traces
121
+
122
+ ```console
123
+ OTEL_METRICS_EXPORTER=none OTEL_LOGS_EXPORTER=none \
124
+ RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
125
+ ```
126
+
127
+ ## Usage
128
+
129
+ **Send all signals to a collector with a service name:**
130
+
131
+ ```console
132
+ export OTEL_EXPORTER_OTLP_ENDPOINT="http://my-collector:4318"
133
+ export OTEL_SERVICE_NAME="my-service"
134
+ RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
135
+ ```
136
+
137
+ **Enable only specific instrumentations:**
138
+
139
+ ```console
140
+ OTEL_RUBY_ENABLED_INSTRUMENTATIONS="mysql2,redis" \
141
+ RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
142
+ ```
143
+
144
+ **Disable a specific instrumentation:**
145
+
146
+ ```console
147
+ OTEL_RUBY_INSTRUMENTATION_SINATRA_ENABLED=false \
148
+ RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
149
+ ```
150
+
151
+ **Preload gems that need to be instrumented but aren't in your Gemfile:**
152
+
153
+ ```console
154
+ RUBYOPT="-r faraday -r opentelemetry-auto-instrumentation" ruby application.rb
155
+ ```
156
+
157
+ **Using with `bundle exec`** (when the gem is installed outside the bundle):
158
+
159
+ ```console
160
+ RUBYOPT="-r $(gem which opentelemetry-auto-instrumentation)" bundle exec rails server
161
+ ```
162
+
163
+ ## Configuration
164
+
165
+ The following environment variables are specific to this gem (not standard OpenTelemetry variables):
166
+
167
+ | Environment Variable | Description | Example |
168
+ | -------------------- | ----------- | ------- |
169
+ | `OTEL_RUBY_REQUIRE_BUNDLER` | Set to `true` to automatically call `Bundler.require` during initialization. Required for frameworks that don't call it automatically (e.g., Sinatra). | `true` |
170
+ | `OTEL_RUBY_RESOURCE_DETECTORS` | Comma-separated list of resource detectors. Supported: `container`, `azure`, `aws`. | `container,azure,aws` |
171
+ | `OTEL_RUBY_ENABLED_INSTRUMENTATIONS` | Only load specific instrumentations (comma-separated). Omit to load all available. | `redis,mysql2,faraday` |
172
+ | `OTEL_RUBY_ADDITIONAL_GEM_PATH` | Custom gem installation path for OpenTelemetry Operator environments. | `/custom/gem/path` |
173
+ | `DISALLOWED_LIB_PATH` | Comma-separated list of non-OpenTelemetry helper gems to exclude from additional load-path injection. Supported values: `googleapis-common-protos-types`, `google-protobuf`. | `google-protobuf` |
174
+ | `OTEL_RUBY_AUTO_INSTRUMENTATION_DEBUG` | Set to `true` for debug output during initialization. | `true` |
175
+
176
+ ### Additional Gem Allowlist
177
+
178
+ The loader always injects OpenTelemetry gems from `OTEL_RUBY_ADDITIONAL_GEM_PATH` into `$LOAD_PATH`. For non-OpenTelemetry helper dependencies, it uses an internal allowlist:
179
+
180
+ - `googleapis-common-protos-types`
181
+ - `google-protobuf`
182
+
183
+ This internal list is implemented as `ADDITIONAL_LIB_GEM_ALLOWLIST` in [lib/opentelemetry-auto-instrumentation.rb](lib/opentelemetry-auto-instrumentation.rb). Use `DISALLOWED_LIB_PATH` if you need to exclude one or more entries for compatibility reasons.
184
+
185
+ ### Standard OpenTelemetry Environment Variables
186
+
187
+ This gem fully supports all standard OpenTelemetry environment variables. Examples:
188
+
189
+ - `OTEL_EXPORTER_OTLP_ENDPOINT` — OTLP receiver endpoint (default: `http://localhost:4318`)
190
+ - `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` — traces-specific endpoint
191
+ - `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT` — metrics-specific endpoint
192
+ - `OTEL_EXPORTER_OTLP_LOGS_ENDPOINT` — logs-specific endpoint
193
+ - `OTEL_SERVICE_NAME` — service name resource attribute
194
+ - `OTEL_RESOURCE_ATTRIBUTES` — comma-separated key=value pairs for resource attributes
195
+ - `OTEL_TRACES_EXPORTER` — trace exporter (default: `otlp`; use `console` or `none`)
196
+ - `OTEL_METRICS_EXPORTER` — metrics exporter (default: `otlp`; use `console` or `none`)
197
+ - `OTEL_LOGS_EXPORTER` — logs exporter (default: `otlp`; use `console` or `none`)
198
+ - `OTEL_TRACES_SAMPLER` — sampling strategy (e.g., `always_on`, `always_off`, `traceidratio`)
199
+
200
+ For a complete list, refer to the SDK READMEs: [opentelemetry-sdk (traces)][otel-sdk-readme], [opentelemetry-metrics-sdk (metrics)][otel-metrics-sdk-readme], [opentelemetry-logs-sdk (logs)][otel-logs-sdk-readme].
201
+
202
+ ## Troubleshooting
203
+
204
+ ### How Auto-Instrumentation Works
205
+
206
+ The gem patches `Bundler::Runtime#require` to inject OpenTelemetry initialization when gems are loaded. Rails calls `Bundler.require` automatically during boot; other frameworks need `OTEL_RUBY_REQUIRE_BUNDLER=true`.
207
+
208
+ ### Instrumentation Timing Issues
209
+
210
+ Instrumentation is only applied to libraries loaded through `Bundler.require`. If you require a library after `Bundler.require` has already been called, it won't be instrumented. Preload it via `RUBYOPT` instead:
211
+
212
+ ```console
213
+ RUBYOPT="-r faraday -r opentelemetry-auto-instrumentation" ruby application.rb
214
+ ```
215
+
216
+ ### Dependency Version Conflicts
217
+
218
+ This gem loads OpenTelemetry components and allowlisted helper dependencies (for example `google-protobuf` and `googleapis-common-protos-types`) directly into `$LOAD_PATH`. If your Gemfile pins different versions of these gems, you may encounter conflicts. Remove them from your Gemfile and let this gem manage them, or use `DISALLOWED_LIB_PATH` to exclude specific helper dependencies.
219
+
220
+ ## Example
221
+
222
+ See [example/README.md](example/README.md)
223
+
224
+ ## Contributing
225
+
226
+ We'd love your help! Use tags [good first issue](https://github.com/open-telemetry/opentelemetry-ruby-instrumentation/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and [help wanted](https://github.com/open-telemetry/opentelemetry-ruby-instrumentation/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) to get started with the project.
227
+
228
+ Please review the [contribution instructions](CONTRIBUTING.md) for important information on setting up your environment, running the tests, and opening pull requests.
229
+
230
+ The Ruby special interest group (SIG) meets regularly. See the OpenTelemetry [community page](https://github.com/open-telemetry/community#ruby-sig) repo for information on this and other language SIGs.
231
+
232
+ ### Maintainers
233
+
234
+ - [Kayla Reopelle](https://github.com/kaylareopelle), New Relic
235
+ - [Xuan Cao](https://github.com/xuan-cao-swi), Solarwinds
236
+
237
+ For more information about the maintainer role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer).
238
+
239
+ ### Approvers
240
+
241
+ For more information about the approver role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#approver).
242
+
243
+ ### Emeritus
244
+
245
+ For more information about the emeritus role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#emeritus-maintainerapprovertriager).
246
+
247
+ ## Versioning
248
+
249
+ OpenTelemetry Ruby follows the [versioning and stability document](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) in the OpenTelemetry specification. Notably, we adhere to the outlined version numbering exception, which states that experimental signals may have a `0.x` version number.
250
+
251
+ ### Compatibility
252
+
253
+ OpenTelemetry Ruby ensures compatibility with the current supported versions of the [Ruby language](https://www.ruby-lang.org/en/downloads/branches/).
254
+
255
+ ## Useful links
256
+
257
+ - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
258
+ - For help or feedback on this project, join us in [GitHub Discussions](https://github.com/open-telemetry/opentelemetry-ruby-instrumentation/discussions)
259
+
260
+ ## License
261
+
262
+ Apache 2.0 - See [LICENSE](LICENSE) for more information.
263
+
264
+ [otel-sdk-readme]: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/sdk
265
+ [otel-metrics-sdk-readme]: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/metrics_sdk
266
+ [otel-logs-sdk-readme]: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/logs_sdk
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module AutoInstrumentation
9
+ VERSION = '0.1.0'
10
+ end
11
+ end
@@ -0,0 +1,219 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ require_relative 'opentelemetry/auto_instrumentation/version'
8
+
9
+ # OTelBundlerPatch
10
+ module OTelBundlerPatch
11
+ # Nested module to handle OpenTelemetry initialization logic
12
+ module OTelInitializer
13
+ @_otel_mutex = Mutex.new
14
+ @_otel_initialized = false
15
+
16
+ # Returns all instrumentation classes registered in the OpenTelemetry instrumentation registry.
17
+ def self._otel_registry_instrumentation_classes
18
+ registry = ::OpenTelemetry::Instrumentation.registry
19
+
20
+ # The registry only exposes lookup/install methods publicly, so enumerate
21
+ # the internal collection to derive supported instrumentation names.
22
+ registry.instance_variable_get(:@instrumentation) || []
23
+ rescue StandardError
24
+ []
25
+ end
26
+
27
+ # Converts a CamelCase or hyphenated string to snake_case.
28
+ def self._otel_snake_case(value)
29
+ value
30
+ .gsub(/([A-Z]+)([A-Z][a-z])/, '\\1_\\2')
31
+ .gsub(/([a-z\\d])([A-Z])/, '\\1_\\2')
32
+ .tr('-', '_')
33
+ .downcase
34
+ end
35
+
36
+ # Returns all snake_case alias strings for a given fully-qualified instrumentation name.
37
+ def self._otel_registry_aliases_for(instrumentation_name)
38
+ suffix = instrumentation_name.delete_prefix('OpenTelemetry::Instrumentation::')
39
+ segment_variants = suffix.split('::').map do |segment|
40
+ snake = _otel_snake_case(segment)
41
+ compact = segment.downcase
42
+ [snake, compact].uniq
43
+ end
44
+
45
+ segment_variants.reduce(['']) do |aliases, variants|
46
+ aliases.flat_map do |alias_prefix|
47
+ variants.map { |variant| alias_prefix.empty? ? variant : "#{alias_prefix}_#{variant}" }
48
+ end
49
+ end
50
+ end
51
+
52
+ # Builds and caches a hash mapping alias names to canonical instrumentation names.
53
+ def self._otel_registry_lookup
54
+ @_otel_registry_lookup ||= _otel_registry_instrumentation_classes.each_with_object({}) do |instrumentation_class, lookup|
55
+ instrumentation_name = instrumentation_class.instance.name
56
+ _otel_registry_aliases_for(instrumentation_name).each do |alias_name|
57
+ lookup[alias_name] ||= instrumentation_name
58
+ end
59
+ rescue StandardError
60
+ next
61
+ end
62
+ end
63
+
64
+ # Detects and merges resource attributes from detectors listed in OTEL_RUBY_RESOURCE_DETECTORS.
65
+ def self._otel_detect_resource_from_env
66
+ resource_map = {
67
+ 'container' => (defined?(::OpenTelemetry::Resource::Detector::Container) ? ::OpenTelemetry::Resource::Detector::Container : nil),
68
+ 'azure' => (defined?(::OpenTelemetry::Resource::Detector::Azure) ? ::OpenTelemetry::Resource::Detector::Azure : nil),
69
+ 'aws' => (defined?(::OpenTelemetry::Resource::Detector::AWS) ? ::OpenTelemetry::Resource::Detector::AWS : nil)
70
+ }
71
+
72
+ ENV['OTEL_RUBY_RESOURCE_DETECTORS'].to_s.split(',').map(&:strip).reject(&:empty?).reduce(::OpenTelemetry::SDK::Resources::Resource.create({})) do |resource, detector|
73
+ detector_class = resource_map[detector]
74
+ detector_class ? resource.merge(detector_class.detect) : resource
75
+ end
76
+ end
77
+
78
+ # Creates a Resource containing distro name and version attributes.
79
+ def self._otel_distro_resource
80
+ ::OpenTelemetry::SDK::Resources::Resource.create(
81
+ {
82
+ 'telemetry.distro.name' => 'opentelemetry-ruby-instrumentation',
83
+ 'telemetry.distro.version' => ::OpenTelemetry::AutoInstrumentation::VERSION
84
+ }
85
+ )
86
+ end
87
+
88
+ # Returns a list of canonical instrumentation names enabled via OTEL_RUBY_ENABLED_INSTRUMENTATIONS.
89
+ def self._otel_determine_enabled_instrumentation
90
+ env = ENV['OTEL_RUBY_ENABLED_INSTRUMENTATIONS'].to_s
91
+
92
+ return [] if env.strip.empty?
93
+
94
+ instrumentation_lookup = _otel_registry_lookup
95
+
96
+ env.split(',').filter_map do |instrumentation|
97
+ normalized = instrumentation.strip.downcase
98
+ value = instrumentation_lookup[normalized]
99
+ warn "[OpenTelemetry] WARNING: Unknown instrumentation '#{instrumentation.strip}'" if value.nil? && ENV['OTEL_RUBY_AUTO_INSTRUMENTATION_DEBUG'] == 'true'
100
+ value
101
+ end
102
+ end
103
+
104
+ # Warns if any opentelemetry- gems are found in the Gemfile, as they may conflict with auto-instrumentation.
105
+ def self._otel_check_for_bundled_otel_gems
106
+ bundled_otel_gems = Bundler.definition.dependencies.select do |dep|
107
+ dep.name.start_with?('opentelemetry-')
108
+ end
109
+
110
+ return if bundled_otel_gems.empty?
111
+
112
+ gem_names = bundled_otel_gems.map(&:name).sort.join(', ')
113
+ warn '[OpenTelemetry] WARNING: Detected OpenTelemetry gems in your Gemfile: ' \
114
+ "#{gem_names}. When using opentelemetry-auto-instrumentation, OpenTelemetry gems are loaded " \
115
+ 'from the opentelemetry-auto-instrumentation gem path, NOT from your bundle. The gem versions ' \
116
+ 'in your Gemfile/Gemfile.lock are not used and may cause version conflicts or ' \
117
+ 'unexpected behavior. Please remove these gems from your Gemfile when using ' \
118
+ 'opentelemetry-auto-instrumentation.'
119
+ rescue StandardError => e
120
+ warn "[OpenTelemetry] WARNING: Unable to check Gemfile for OpenTelemetry gems: #{e.message}" if ENV['OTEL_RUBY_AUTO_INSTRUMENTATION_DEBUG'] == 'true'
121
+ end
122
+
123
+ # Initializes the OpenTelemetry SDK exactly once using a mutex-protected check.
124
+ def self._otel_require_otel
125
+ @_otel_mutex.synchronize do
126
+ return if @_otel_initialized
127
+
128
+ @_otel_initialized = true
129
+
130
+ begin
131
+ _otel_check_for_bundled_otel_gems
132
+
133
+ required_instrumentation = _otel_determine_enabled_instrumentation
134
+
135
+ resource = _otel_detect_resource_from_env
136
+ resource = resource.merge(_otel_distro_resource)
137
+
138
+ OpenTelemetry::SDK.configure do |c|
139
+ c.resource = resource
140
+ if required_instrumentation.empty?
141
+ c.use_all
142
+ else
143
+ required_instrumentation.each do |instrumentation|
144
+ c.use instrumentation
145
+ end
146
+ end
147
+ end
148
+
149
+ OpenTelemetry.logger.info { 'Auto-instrumentation initialized' }
150
+ rescue StandardError => e
151
+ @_otel_initialized = false
152
+ warn "Auto-instrumentation failed to initialize. Error: #{e.message}"
153
+ end
154
+ end
155
+ end
156
+ end
157
+
158
+ # Overrides Kernel#require to trigger OpenTelemetry initialization after each require call.
159
+ def require(...)
160
+ super
161
+ OTelInitializer._otel_require_otel
162
+ end
163
+ end
164
+
165
+ require 'bundler'
166
+
167
+ ADDITIONAL_LIB_GEM_ALLOWLIST = %w[
168
+ googleapis-common-protos-types
169
+ google-protobuf
170
+ ].freeze
171
+
172
+ parse_env_list = lambda do |key|
173
+ ENV[key].to_s.split(',').map(&:strip).reject(&:empty?)
174
+ end
175
+
176
+ # /otel-auto-instrumentation-ruby is default path for otel operator (ruby.go)
177
+ # If requires different gem path to load gem, set env OTEL_RUBY_ADDITIONAL_GEM_PATH
178
+ gem_path = ENV['OTEL_RUBY_ADDITIONAL_GEM_PATH'] || '/otel-auto-instrumentation-ruby'
179
+ gem_path = Gem.dir unless Dir.exist?(gem_path)
180
+
181
+ gem_entries = Dir.glob("#{gem_path}/gems/*")
182
+
183
+ # googleapis-common-protos-types and google-protobuf are dependencies for otlp exporters
184
+ # google-cloud-env are dependencies for gcp resource detectors
185
+ otel_lib_path = gem_entries.select do |file_path|
186
+ File.basename(file_path).start_with?('opentelemetry-')
187
+ end
188
+
189
+ disallowed_lib_paths = parse_env_list.call('DISALLOWED_LIB_PATH')
190
+ allowed_additional_lib_gems = ADDITIONAL_LIB_GEM_ALLOWLIST - disallowed_lib_paths
191
+
192
+ additional_lib_path = gem_entries.select do |file_path|
193
+ gem_dir_name = File.basename(file_path)
194
+ allowed_additional_lib_gems.any? { |gem_name| gem_dir_name.start_with?("#{gem_name}-") }
195
+ end
196
+
197
+ # unshift file_path add opentelemetry component at the top of $LOAD_PATH
198
+ otel_lib_path.each { |file_path| $LOAD_PATH.unshift("#{file_path}/lib") }
199
+ additional_lib_path.each { |file_path| $LOAD_PATH.unshift("#{file_path}/lib") }
200
+
201
+ warn "Loading the gem path from #{gem_path}\n$LOAD_PATH after unshift: #{$LOAD_PATH.join(',')}" if ENV['OTEL_RUBY_AUTO_INSTRUMENTATION_DEBUG'] == 'true'
202
+
203
+ # These are required for the prepend OTelBundlerPatch to fetch OpenTelemetry::SDK.configure
204
+ require 'opentelemetry-sdk'
205
+ require 'opentelemetry-metrics-sdk'
206
+ require 'opentelemetry-logs-sdk'
207
+ require 'opentelemetry-exporter-otlp'
208
+ require 'opentelemetry-exporter-otlp-metrics'
209
+ require 'opentelemetry-exporter-otlp-logs'
210
+ require 'opentelemetry-instrumentation-all'
211
+
212
+ resource_detectors = parse_env_list.call('OTEL_RUBY_RESOURCE_DETECTORS')
213
+ require 'opentelemetry-resource-detector-container' if resource_detectors.include?('container')
214
+ require 'opentelemetry-resource-detector-azure' if resource_detectors.include?('azure')
215
+ require 'opentelemetry-resource-detector-aws' if resource_detectors.include?('aws')
216
+
217
+ Bundler::Runtime.prepend(OTelBundlerPatch)
218
+
219
+ Bundler.require if ENV['OTEL_RUBY_REQUIRE_BUNDLER'] == 'true'
data/release-notes.md ADDED
@@ -0,0 +1,3 @@
1
+
2
+ - Initial release.
3
+
metadata CHANGED
@@ -1,25 +1,263 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: opentelemetry-auto-instrumentation
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.0
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenTelemetry Authors
8
8
  bindir: bin
9
9
  cert_chain: []
10
10
  date: 1980-01-02 00:00:00.000000000 Z
11
- dependencies: []
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: opentelemetry-api
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - "~>"
17
+ - !ruby/object:Gem::Version
18
+ version: 1.9.0
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - "~>"
24
+ - !ruby/object:Gem::Version
25
+ version: 1.9.0
26
+ - !ruby/object:Gem::Dependency
27
+ name: opentelemetry-exporter-otlp
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - "~>"
31
+ - !ruby/object:Gem::Version
32
+ version: 0.33.0
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: 0.33.0
40
+ - !ruby/object:Gem::Dependency
41
+ name: opentelemetry-exporter-otlp-logs
42
+ requirement: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - "~>"
45
+ - !ruby/object:Gem::Version
46
+ version: 0.4.0
47
+ type: :runtime
48
+ prerelease: false
49
+ version_requirements: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - "~>"
52
+ - !ruby/object:Gem::Version
53
+ version: 0.4.0
54
+ - !ruby/object:Gem::Dependency
55
+ name: opentelemetry-exporter-otlp-metrics
56
+ requirement: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - "~>"
59
+ - !ruby/object:Gem::Version
60
+ version: 0.8.0
61
+ type: :runtime
62
+ prerelease: false
63
+ version_requirements: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - "~>"
66
+ - !ruby/object:Gem::Version
67
+ version: 0.8.0
68
+ - !ruby/object:Gem::Dependency
69
+ name: opentelemetry-helpers-mysql
70
+ requirement: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - "~>"
73
+ - !ruby/object:Gem::Version
74
+ version: 0.5.0
75
+ type: :runtime
76
+ prerelease: false
77
+ version_requirements: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - "~>"
80
+ - !ruby/object:Gem::Version
81
+ version: 0.5.0
82
+ - !ruby/object:Gem::Dependency
83
+ name: opentelemetry-helpers-sql
84
+ requirement: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - "~>"
87
+ - !ruby/object:Gem::Version
88
+ version: 0.3.0
89
+ type: :runtime
90
+ prerelease: false
91
+ version_requirements: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - "~>"
94
+ - !ruby/object:Gem::Version
95
+ version: 0.3.0
96
+ - !ruby/object:Gem::Dependency
97
+ name: opentelemetry-helpers-sql-processor
98
+ requirement: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - "~>"
101
+ - !ruby/object:Gem::Version
102
+ version: 0.4.0
103
+ type: :runtime
104
+ prerelease: false
105
+ version_requirements: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - "~>"
108
+ - !ruby/object:Gem::Version
109
+ version: 0.4.0
110
+ - !ruby/object:Gem::Dependency
111
+ name: opentelemetry-instrumentation-all
112
+ requirement: !ruby/object:Gem::Requirement
113
+ requirements:
114
+ - - "~>"
115
+ - !ruby/object:Gem::Version
116
+ version: 0.91.0
117
+ type: :runtime
118
+ prerelease: false
119
+ version_requirements: !ruby/object:Gem::Requirement
120
+ requirements:
121
+ - - "~>"
122
+ - !ruby/object:Gem::Version
123
+ version: 0.91.0
124
+ - !ruby/object:Gem::Dependency
125
+ name: opentelemetry-logs-api
126
+ requirement: !ruby/object:Gem::Requirement
127
+ requirements:
128
+ - - "~>"
129
+ - !ruby/object:Gem::Version
130
+ version: 0.3.0
131
+ type: :runtime
132
+ prerelease: false
133
+ version_requirements: !ruby/object:Gem::Requirement
134
+ requirements:
135
+ - - "~>"
136
+ - !ruby/object:Gem::Version
137
+ version: 0.3.0
138
+ - !ruby/object:Gem::Dependency
139
+ name: opentelemetry-logs-sdk
140
+ requirement: !ruby/object:Gem::Requirement
141
+ requirements:
142
+ - - "~>"
143
+ - !ruby/object:Gem::Version
144
+ version: 0.5.1
145
+ type: :runtime
146
+ prerelease: false
147
+ version_requirements: !ruby/object:Gem::Requirement
148
+ requirements:
149
+ - - "~>"
150
+ - !ruby/object:Gem::Version
151
+ version: 0.5.1
152
+ - !ruby/object:Gem::Dependency
153
+ name: opentelemetry-metrics-api
154
+ requirement: !ruby/object:Gem::Requirement
155
+ requirements:
156
+ - - "~>"
157
+ - !ruby/object:Gem::Version
158
+ version: 0.5.0
159
+ type: :runtime
160
+ prerelease: false
161
+ version_requirements: !ruby/object:Gem::Requirement
162
+ requirements:
163
+ - - "~>"
164
+ - !ruby/object:Gem::Version
165
+ version: 0.5.0
166
+ - !ruby/object:Gem::Dependency
167
+ name: opentelemetry-metrics-sdk
168
+ requirement: !ruby/object:Gem::Requirement
169
+ requirements:
170
+ - - "~>"
171
+ - !ruby/object:Gem::Version
172
+ version: 0.13.1
173
+ type: :runtime
174
+ prerelease: false
175
+ version_requirements: !ruby/object:Gem::Requirement
176
+ requirements:
177
+ - - "~>"
178
+ - !ruby/object:Gem::Version
179
+ version: 0.13.1
180
+ - !ruby/object:Gem::Dependency
181
+ name: opentelemetry-resource-detector-aws
182
+ requirement: !ruby/object:Gem::Requirement
183
+ requirements:
184
+ - - "~>"
185
+ - !ruby/object:Gem::Version
186
+ version: 0.5.0
187
+ type: :runtime
188
+ prerelease: false
189
+ version_requirements: !ruby/object:Gem::Requirement
190
+ requirements:
191
+ - - "~>"
192
+ - !ruby/object:Gem::Version
193
+ version: 0.5.0
194
+ - !ruby/object:Gem::Dependency
195
+ name: opentelemetry-resource-detector-azure
196
+ requirement: !ruby/object:Gem::Requirement
197
+ requirements:
198
+ - - "~>"
199
+ - !ruby/object:Gem::Version
200
+ version: 0.3.0
201
+ type: :runtime
202
+ prerelease: false
203
+ version_requirements: !ruby/object:Gem::Requirement
204
+ requirements:
205
+ - - "~>"
206
+ - !ruby/object:Gem::Version
207
+ version: 0.3.0
208
+ - !ruby/object:Gem::Dependency
209
+ name: opentelemetry-resource-detector-container
210
+ requirement: !ruby/object:Gem::Requirement
211
+ requirements:
212
+ - - "~>"
213
+ - !ruby/object:Gem::Version
214
+ version: 0.3.0
215
+ type: :runtime
216
+ prerelease: false
217
+ version_requirements: !ruby/object:Gem::Requirement
218
+ requirements:
219
+ - - "~>"
220
+ - !ruby/object:Gem::Version
221
+ version: 0.3.0
222
+ - !ruby/object:Gem::Dependency
223
+ name: opentelemetry-sdk
224
+ requirement: !ruby/object:Gem::Requirement
225
+ requirements:
226
+ - - "~>"
227
+ - !ruby/object:Gem::Version
228
+ version: 1.11.0
229
+ type: :runtime
230
+ prerelease: false
231
+ version_requirements: !ruby/object:Gem::Requirement
232
+ requirements:
233
+ - - "~>"
234
+ - !ruby/object:Gem::Version
235
+ version: 1.11.0
12
236
  description: Auto-instrumentation for OpenTelemetry Ruby
13
237
  email:
14
238
  - cncf-opentelemetry-contributors@lists.cncf.io
15
239
  executables: []
16
240
  extensions: []
17
241
  extra_rdoc_files: []
18
- files: []
242
+ files:
243
+ - AGENTS.md
244
+ - CHANGELOG.md
245
+ - CLAUDE.md
246
+ - CODE_OF_CONDUCT.md
247
+ - CONTRIBUTING.md
248
+ - LICENSE
249
+ - README.md
250
+ - lib/opentelemetry-auto-instrumentation.rb
251
+ - lib/opentelemetry/auto_instrumentation/version.rb
252
+ - release-notes.md
19
253
  homepage: https://github.com/open-telemetry/opentelemetry-ruby-instrumentation
20
254
  licenses:
21
255
  - Apache-2.0
22
- metadata: {}
256
+ metadata:
257
+ changelog_uri: https://rubydoc.info/gems/opentelemetry-auto-instrumentation/0.1.0/file/CHANGELOG.md
258
+ source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-instrumentation/tree/opentelemetry-auto-instrumentation/v0.1.0/packages/auto-instrumentation
259
+ bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-instrumentation/issues
260
+ documentation_uri: https://rubydoc.info/gems/opentelemetry-auto-instrumentation/0.1.0
23
261
  rdoc_options: []
24
262
  require_paths:
25
263
  - lib
@@ -27,14 +265,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
27
265
  requirements:
28
266
  - - ">="
29
267
  - !ruby/object:Gem::Version
30
- version: '0'
268
+ version: '3.3'
31
269
  required_rubygems_version: !ruby/object:Gem::Requirement
32
270
  requirements:
33
271
  - - ">="
34
272
  - !ruby/object:Gem::Version
35
273
  version: '0'
36
274
  requirements: []
37
- rubygems_version: 4.0.18
275
+ rubygems_version: 4.0.16
38
276
  specification_version: 4
39
277
  summary: Auto-instrumentation for OpenTelemetry Ruby
40
278
  test_files: []