Skip to content

feat: add gem for auto-instrumentation in otel-operator #1384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 46 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 38 commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
9d13c5a
feat: init commit for zero-code instrumentation
xuan-cao-swi Jan 29, 2025
444959a
lint
xuan-cao-swi Jan 29, 2025
4c0c97b
rubocop
xuan-cao-swi Jan 29, 2025
8a2fadd
enforce the dependencies version
xuan-cao-swi Jan 30, 2025
f96a637
assume use bundle exec all the time
xuan-cao-swi Feb 14, 2025
ef5f348
merge
xuan-cao-swi Feb 26, 2025
60a3ab2
update readme
xuan-cao-swi Feb 26, 2025
3512225
cspell
xuan-cao-swi Feb 26, 2025
2c880da
update the script
xuan-cao-swi Apr 16, 2025
834855d
merge
xuan-cao-swi Jun 4, 2025
76f6d0e
Update zero-code-instrumentation/lib/version.rb
xuan-cao-swi Jun 4, 2025
90995f7
Update zero-code-instrumentation/CHANGELOG.md
xuan-cao-swi Jun 4, 2025
917cb33
Update zero-code-instrumentation/README.md
xuan-cao-swi Jun 4, 2025
072c44a
Update zero-code-instrumentation/README.md
xuan-cao-swi Jun 4, 2025
dd16883
Update zero-code-instrumentation/README.md
xuan-cao-swi Jun 4, 2025
d4de6d0
Update zero-code-instrumentation/README.md
xuan-cao-swi Jun 4, 2025
342084f
Update zero-code-instrumentation/README.md
xuan-cao-swi Jun 4, 2025
e1e4d20
Update zero-code-instrumentation/lib/zero-code-instrumentation.rb
xuan-cao-swi Jun 4, 2025
2c2b9f8
Update zero-code-instrumentation/lib/zero-code-instrumentation.rb
xuan-cao-swi Jun 4, 2025
01a8779
revision
xuan-cao-swi Jun 4, 2025
f432544
revision
xuan-cao-swi Jun 4, 2025
5104dd8
change gem name
xuan-cao-swi Jun 10, 2025
1e8c2b2
remove zero as reference name
xuan-cao-swi Jun 17, 2025
d0d7534
Merge branch 'main' into auto-instrumentation
xuan-cao-swi Jun 17, 2025
7f285d2
Merge branch 'main' into auto-instrumentation
xuan-cao-swi Jun 24, 2025
1080edc
Update opentelemetry-auto-instrumentation/README.md
xuan-cao-swi Jul 21, 2025
74c73f7
Update opentelemetry-auto-instrumentation/README.md
xuan-cao-swi Jul 21, 2025
f024787
Update .github/workflows/ci-contrib.yml
xuan-cao-swi Jul 21, 2025
395ce32
Update .github/workflows/ci-contrib.yml
xuan-cao-swi Jul 21, 2025
5fe8419
Update opentelemetry-auto-instrumentation/README.md
xuan-cao-swi Jul 21, 2025
56d7ba5
Update opentelemetry-auto-instrumentation/README.md
xuan-cao-swi Jul 21, 2025
5475748
Merge branch 'main' into auto-instrumentation
xuan-cao-swi Jul 21, 2025
cd42f0b
update
xuan-cao-swi Jul 22, 2025
d7f3452
Merge branch 'main' into auto-instrumentation
xuan-cao-swi Jul 22, 2025
c03917f
update workflow file
xuan-cao-swi Jul 22, 2025
c5b0c8e
Merge branch 'auto-instrumentation' of github.com:xuan-cao-swi/opente…
xuan-cao-swi Jul 22, 2025
501918b
update ci
xuan-cao-swi Jul 22, 2025
5bd69ee
use custom ci for auto-instrumentation
xuan-cao-swi Jul 23, 2025
e6cb868
Merge branch 'main' into auto-instrumentation
xuan-cao-swi Jul 29, 2025
e625a80
revision and fix ci
xuan-cao-swi Jul 29, 2025
f2781df
lint
xuan-cao-swi Jul 29, 2025
c478025
reverse ci to original
xuan-cao-swi Jul 29, 2025
a462533
moved to a nested module
xuan-cao-swi Jul 29, 2025
e680d0a
Merge branch 'main' of github.com:xuan-cao-swi/opentelemetry-ruby-con…
xuan-cao-swi Aug 8, 2025
f811cbe
doc: add more test example
xuan-cao-swi Aug 11, 2025
5c032ca
typo
xuan-cao-swi Aug 11, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .cspell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,5 @@ words:
- webmocks
- Xuan
- yardoc
- traceparent
- rackup
- traceparent
77 changes: 77 additions & 0 deletions .github/workflows/ci-contrib.yml
Original file line number Diff line number Diff line change
Expand Up @@ -240,3 +240,80 @@ jobs:
with:
gem: "opentelemetry-sampler-${{ matrix.gem }}"
ruby: "jruby-9.4.12.0"

auto-instrumentation:
name: "auto-instrumentation / ubuntu-latest"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: "Test Ruby 3.4"
uses: ruby/[email protected]
with:
ruby-version: "3.4"
- name: Test Gem
shell: bash
run: |
bundle install --quiet --jobs=3 --retry=4
bundle exec rake test
rm -f Gemfile.lock
working-directory: './opentelemetry-auto-instrumentation'
- name: "Test Ruby 3.3"
uses: ruby/[email protected]
with:
ruby-version: "3.3"
- name: Test Gem
shell: bash
run: |
bundle install --quiet --jobs=3 --retry=4
bundle exec rake test
rm -f Gemfile.lock
working-directory: './opentelemetry-auto-instrumentation'
- name: "Test Ruby 3.2"
uses: ruby/[email protected]
with:
ruby-version: "3.2"
- name: Test Gem
shell: bash
run: |
bundle install --quiet --jobs=3 --retry=4
bundle exec rake test
rm -f Gemfile.lock
working-directory: './opentelemetry-auto-instrumentation'
- name: "Test Ruby 3.1"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ruby 3.1 was EoL 2025-03-31? Want to still support it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed

uses: ruby/[email protected]
with:
ruby-version: "3.1"
- name: Test Gem
shell: bash
run: |
bundle install --quiet --jobs=3 --retry=4
bundle exec rake test
rm -f Gemfile.lock
working-directory: './opentelemetry-auto-instrumentation'

- name: YARD
shell: bash
run: |
# 📄 Yard Docs 📄
bundle exec rake yard
working-directory: './opentelemetry-auto-instrumentation'

- name: Rubocop
shell: bash
run: |
# 🤖 Rubocop 🤖
bundle exec rake rubocop
working-directory: './opentelemetry-auto-instrumentation'

- name: Coverage
shell: bash
run: |
bundle exec ruby -e 'require "simplecov"; SimpleCov.minimum_coverage(85)'
working-directory: './opentelemetry-auto-instrumentation'

- name: Build Gem
shell: bash
run: |
# 📦 Build Gem 📦
gem build opentelemetry-auto-instrumentation.gemspec
working-directory: './opentelemetry-auto-instrumentation'
5 changes: 5 additions & 0 deletions opentelemetry-auto-instrumentation/.rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
inherit_from: ../.rubocop.yml
Naming/FileName:
Enabled: false
Gemspec/DevelopmentDependencies:
Enabled: false
1 change: 1 addition & 0 deletions opentelemetry-auto-instrumentation/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Release History: opentelemetry-auto-instrumentation
23 changes: 23 additions & 0 deletions opentelemetry-auto-instrumentation/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# frozen_string_literal: true

# Copyright The OpenTelemetry Authors
#
# SPDX-License-Identifier: Apache-2.0

source 'https://rubygems.org'

# avoid use gemspec to avoid circular load
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am confused about this. Aren't these already declared in the gemspec?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simplified the Gemfile


gem 'opentelemetry-sdk'
gem 'opentelemetry-instrumentation-all'
gem 'opentelemetry-exporter-otlp'
gem 'opentelemetry-test-helpers'
gem 'opentelemetry-resource-detector-container', path: '../resources/container'

gem 'bundler'
gem 'minitest'
gem 'rake'
gem 'rubocop'
gem 'rubocop-performance'
gem 'simplecov'
gem 'yard'
201 changes: 201 additions & 0 deletions opentelemetry-auto-instrumentation/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright The OpenTelemetry Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading
Loading