diff --git a/.github/workflows/ci-instrumentation.yml b/.github/workflows/ci-instrumentation.yml index 82f8f1e6a0..734d2433be 100644 --- a/.github/workflows/ci-instrumentation.yml +++ b/.github/workflows/ci-instrumentation.yml @@ -12,8 +12,8 @@ on: - cron: "0 0 * * *" concurrency: - group: ${{ github.workflow }}-${{ github.event.pull_request.number }} # Ensure that only one instance of this workflow is running per Pull Request - cancel-in-progress: true # Cancel any previous runs of this workflow + group: ${{ github.workflow }}-${{ github.event.pull_request.number }} # Ensure that only one instance of this workflow is running per Pull Request + cancel-in-progress: true # Cancel any previous runs of this workflow jobs: instrumentation: @@ -48,6 +48,7 @@ jobs: - koala - lmdb - net_http + - net_ldap - rack - rails - restclient diff --git a/.toys/.data/releases.yml b/.toys/.data/releases.yml index c54fe963d0..26b10be659 100644 --- a/.toys/.data/releases.yml +++ b/.toys/.data/releases.yml @@ -181,6 +181,11 @@ gems: version_rb_path: lib/opentelemetry/instrumentation/net/http/version.rb version_constant: [OpenTelemetry, Instrumentation, Net, HTTP, VERSION] + - name: opentelemetry-instrumentation-net_ldap + directory: instrumentation/net_ldap + version_rb_path: lib/opentelemetry/instrumentation/net/ldap/version.rb + version_constant: [OpenTelemetry, Instrumentation, Net, LDAP, VERSION] + - name: opentelemetry-instrumentation-pg directory: instrumentation/pg version_constant: [OpenTelemetry, Instrumentation, PG, VERSION] diff --git a/docker-compose.yml b/docker-compose.yml index 5b3a01ee7f..6b47e94800 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -127,6 +127,10 @@ services: <<: *base working_dir: /app/instrumentation/net_http/example + ex-instrumentation-net-ldap: + <<: *base + working_dir: /app/instrumentation/net_ldap/example + ex-instrumentation-que: <<: *base environment: diff --git a/instrumentation/net_ldap/.rubocop.yml b/instrumentation/net_ldap/.rubocop.yml new file mode 100644 index 0000000000..1248a2f825 --- /dev/null +++ b/instrumentation/net_ldap/.rubocop.yml @@ -0,0 +1 @@ +inherit_from: ../../.rubocop.yml diff --git a/instrumentation/net_ldap/.yardopts b/instrumentation/net_ldap/.yardopts new file mode 100644 index 0000000000..a182b62a06 --- /dev/null +++ b/instrumentation/net_ldap/.yardopts @@ -0,0 +1,9 @@ +--no-private +--title=OpenTelemetry Net::LDAP Instrumentation +--markup=markdown +--main=README.md +./lib/opentelemetry/instrumentation/**/*.rb +./lib/opentelemetry/instrumentation.rb +- +README.md +CHANGELOG.md diff --git a/instrumentation/net_ldap/Appraisals b/instrumentation/net_ldap/Appraisals new file mode 100644 index 0000000000..315ec50bb1 --- /dev/null +++ b/instrumentation/net_ldap/Appraisals @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +%w[0.17.1 0.18.0 0.19.0].each do |version| + appraise "net-ldap-#{version}" do + gem 'net-ldap', "~> #{version}" + end +end + +appraise 'net-ldap-latest' do + gem 'net-ldap' +end diff --git a/instrumentation/net_ldap/CHANGELOG.md b/instrumentation/net_ldap/CHANGELOG.md new file mode 100644 index 0000000000..c94288d3a6 --- /dev/null +++ b/instrumentation/net_ldap/CHANGELOG.md @@ -0,0 +1 @@ +# Release History: opentelemetry-instrumentation-net_ldap diff --git a/instrumentation/net_ldap/Gemfile b/instrumentation/net_ldap/Gemfile new file mode 100644 index 0000000000..d3415936a0 --- /dev/null +++ b/instrumentation/net_ldap/Gemfile @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +source 'https://rubygems.org' + +gemspec + +group :test do + gem 'appraisal', '~> 2.5' + gem 'bundler', '~> 2.4' + gem 'minitest', '~> 5.0' + gem 'opentelemetry-sdk', '~> 1.1' + gem 'opentelemetry-test-helpers', '~> 0.3' + gem 'rake', '~> 13.0.1' + gem 'rubocop', '~> 1.76.2' + gem 'rubocop-performance', '~> 1.24.0' + gem 'simplecov', '~> 0.22.0' + gem 'webmock', '~> 3.24' + gem 'yard', '~> 0.9' + gem 'opentelemetry-instrumentation-base', path: '../base' + if RUBY_VERSION >= '3.4' + gem 'base64' + gem 'mutex_m' + end +end diff --git a/instrumentation/net_ldap/LICENSE b/instrumentation/net_ldap/LICENSE new file mode 100644 index 0000000000..1ef7dad2c5 --- /dev/null +++ b/instrumentation/net_ldap/LICENSE @@ -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. diff --git a/instrumentation/net_ldap/README.md b/instrumentation/net_ldap/README.md new file mode 100644 index 0000000000..376ca7a6de --- /dev/null +++ b/instrumentation/net_ldap/README.md @@ -0,0 +1,49 @@ +# OpenTelemetry Net::LDAP Instrumentation + +The OpenTelemetry Net::LDAP Ruby gem is a community maintained instrumentation for [Net::LDAP][net-ldap-home]. + +## How do I get started? + +Install the gem using: + +```console +gem install opentelemetry-instrumentation-net_ldap +``` + +Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-net_ldap` in your `Gemfile`. + +## Usage + +To install the instrumentation, call `use` with the name of the instrumentation. + +```ruby +OpenTelemetry::SDK.configure do |c| + c.use 'OpenTelemetry::Instrumentation::Net::LDAP' +end +``` + +Alternatively, you can also call `use_all` to install all the available instrumentation. + +```ruby +OpenTelemetry::SDK.configure do |c| + c.use_all +end +``` + +## How can I get involved? + +The `opentelemetry-instrumentation-net_ldap` 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]. + +## License + +Apache 2.0 license. See [LICENSE][license-github] for more information. + +[net-ldap-home]: https://github.com/ruby-ldap/ruby-net-ldap +[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 +[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions diff --git a/instrumentation/net_ldap/Rakefile b/instrumentation/net_ldap/Rakefile new file mode 100644 index 0000000000..1a64ba842e --- /dev/null +++ b/instrumentation/net_ldap/Rakefile @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'bundler/gem_tasks' +require 'rake/testtask' +require 'yard' +require 'rubocop/rake_task' + +RuboCop::RakeTask.new + +Rake::TestTask.new :test do |t| + t.libs << 'test' + t.libs << 'lib' + t.test_files = FileList['test/**/*_test.rb'] +end + +YARD::Rake::YardocTask.new do |t| + t.stats_options = ['--list-undoc'] +end + +if RUBY_ENGINE == 'truffleruby' + task default: %i[test] +else + task default: %i[test rubocop yard] +end diff --git a/instrumentation/net_ldap/example/Gemfile b/instrumentation/net_ldap/example/Gemfile new file mode 100644 index 0000000000..55be0ae221 --- /dev/null +++ b/instrumentation/net_ldap/example/Gemfile @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +source 'https://rubygems.org' + +gem 'net-ldap' +gem 'opentelemetry-api' +gem 'opentelemetry-common' +gem 'opentelemetry-instrumentation-base' +gem 'opentelemetry-instrumentation-net_ldap', path: '../' +gem 'opentelemetry-sdk' diff --git a/instrumentation/net_ldap/example/net_ldap.rb b/instrumentation/net_ldap/example/net_ldap.rb new file mode 100644 index 0000000000..b9263bb0ca --- /dev/null +++ b/instrumentation/net_ldap/example/net_ldap.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +require 'rubygems' +require 'bundler/setup' +require 'net/ldap' + +Bundler.require + +ENV['OTEL_TRACES_EXPORTER'] = 'console' +OpenTelemetry::SDK.configure do |c| + c.use 'OpenTelemetry::Instrumentation::Net::LDAP' +end + +ldap = Net::LDAP.new host: 'your_ldap_host', + port: 'your_ldap_port', + encryption: :simple_tls, + base: 'base', + auth: { + method: :simple, + username: 'username', + password: 'password' + } +ldap.open do |ldap| + ldap.search(args) + ldap.add(args) + ldap.modify(args) +end diff --git a/instrumentation/net_ldap/lib/opentelemetry-instrumentation-net_ldap.rb b/instrumentation/net_ldap/lib/opentelemetry-instrumentation-net_ldap.rb new file mode 100644 index 0000000000..c034f140f8 --- /dev/null +++ b/instrumentation/net_ldap/lib/opentelemetry-instrumentation-net_ldap.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require_relative 'opentelemetry/instrumentation' diff --git a/instrumentation/net_ldap/lib/opentelemetry/instrumentation.rb b/instrumentation/net_ldap/lib/opentelemetry/instrumentation.rb new file mode 100644 index 0000000000..a0f85a42ab --- /dev/null +++ b/instrumentation/net_ldap/lib/opentelemetry/instrumentation.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +# OpenTelemetry is an open source observability framework, providing a +# general-purpose API, SDK, and related tools required for the instrumentation +# of cloud-native software, frameworks, and libraries. +# +# The OpenTelemetry module provides global accessors for telemetry objects. +# See the documentation for the `opentelemetry-api` gem for details. +module OpenTelemetry + # "Instrumentation" are specified by + # https://github.com/open-telemetry/opentelemetry-specification/blob/784635d01d8690c8f5fcd1f55bdbc8a13cf2f4f2/specification/glossary.md#instrumentation-library + # + # Instrumentation should be able to handle the case when the library is not installed on a user's system. + module Instrumentation + end +end + +require_relative 'instrumentation/net/ldap' diff --git a/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap.rb b/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap.rb new file mode 100644 index 0000000000..baa0784d90 --- /dev/null +++ b/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'opentelemetry' +require 'opentelemetry/common' +require 'opentelemetry-instrumentation-base' + +module OpenTelemetry + module Instrumentation + module Net + # Contains the OpenTelemetry instrumentation for the Net::LDAP gem + module LDAP + end + end + end +end + +require_relative 'ldap/instrumentation' +require_relative 'ldap/version' diff --git a/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap/instrumentation.rb b/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap/instrumentation.rb new file mode 100644 index 0000000000..e989d18f1a --- /dev/null +++ b/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap/instrumentation.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module Net + module LDAP + # The Instrumentation class contains logic to detect and install the Net::LDAP + # instrumentation + class Instrumentation < OpenTelemetry::Instrumentation::Base + compatible do + gem_version = Gem::Version.new(::Net::LDAP::VERSION) + Gem::Requirement.new('>= 0.17.1').satisfied_by?(gem_version) + end + + install do |_config| + require_dependencies + patch + end + + present do + defined?(::Net::LDAP) + end + + option :peer_service, default: nil, validate: :string + + private + + def require_dependencies + require_relative 'instrumentation_service' + require_relative 'patches/instrumentation' + end + + def patch + ::Net::LDAP.prepend(Patches::Instrumentation) + end + end + end + end + end +end diff --git a/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap/instrumentation_service.rb b/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap/instrumentation_service.rb new file mode 100644 index 0000000000..dc14cf631a --- /dev/null +++ b/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap/instrumentation_service.rb @@ -0,0 +1,86 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module Net + module LDAP + # instrumentation service for ldap + class InstrumentationService + def initialize(args = {}) + @host = args[:host] + @port = args[:port] + @hosts = args[:hosts] + @auth = args[:auth] + @base = args[:base] + @encryption = args[:encryption] + end + + def instrument(event, payload) + attributes = { + 'ldap.auth' => auth.except(:password).to_json, + 'ldap.base' => base, + 'ldap.encryption' => encryption.to_json, + 'ldap.payload' => payload.to_json, + OpenTelemetry::SemanticConventions::Trace::NET_PEER_NAME => host || hosts, + OpenTelemetry::SemanticConventions::Trace::NET_PEER_PORT => port, + OpenTelemetry::SemanticConventions::Trace::PEER_SERVICE => instrumentation_config[:peer_service] + } + attributes.delete_if { |_key, value| value.nil? } + + tracer.in_span( + event, + attributes: attributes, + kind: :client + ) do |span| + yield(payload).tap do |response| + annotate_span_with_response(span, response) if response + end + rescue ::Net::LDAP::Error => e + span.set_attribute('ldap.error_message', "#{e.class}: #{e.message}") + span.status = OpenTelemetry::Trace::Status.error + raise e + end + end + + private + + attr_reader :host, :port, :hosts, :auth, :base, :encryption + + def tracer + LDAP::Instrumentation.instance.tracer + end + + def instrumentation_config + LDAP::Instrumentation.instance.config + end + + def annotate_span_with_response(span, response) + status_code = ::Net::LDAP::ResultCodeSuccess + message = '' + error_message = '' + + if response.is_a?(::Net::LDAP::PDU) + status_code ||= response.result_code + error_message = response.error_message.to_s + message = ::Net::LDAP.result2string(status_code) + end + attributes = { + 'ldap.status_code' => status_code + } + attributes['ldap.message'] = message unless message.empty? + attributes['ldap.error_message'] = error_message unless error_message.empty? + span.add_attributes(attributes) + + return if ::Net::LDAP::ResultCodesNonError.include?(status_code) + + span.status = OpenTelemetry::Trace::Status.error + end + end + end + end + end +end diff --git a/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap/patches/instrumentation.rb b/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap/patches/instrumentation.rb new file mode 100644 index 0000000000..df10183081 --- /dev/null +++ b/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap/patches/instrumentation.rb @@ -0,0 +1,31 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module Net + module LDAP + module Patches + # Module to prepend to Net::LDAP for instrumentation + module Instrumentation + def initialize(args = {}) + super + + @instrumentation_service = args[:instrumentation_service] || OpenTelemetry::Instrumentation::Net::LDAP::InstrumentationService.new({ + host: @host, + port: @port, + hosts: @hosts, + auth: @auth, + base: @base, + encryption: @encryption + }) + end + end + end + end + end + end +end diff --git a/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap/version.rb b/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap/version.rb new file mode 100644 index 0000000000..9611adbe35 --- /dev/null +++ b/instrumentation/net_ldap/lib/opentelemetry/instrumentation/net/ldap/version.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + module Instrumentation + module Net + module LDAP + VERSION = '0.0.0' + end + end + end +end diff --git a/instrumentation/net_ldap/opentelemetry-instrumentation-net_ldap.gemspec b/instrumentation/net_ldap/opentelemetry-instrumentation-net_ldap.gemspec new file mode 100644 index 0000000000..9a3bda71f1 --- /dev/null +++ b/instrumentation/net_ldap/opentelemetry-instrumentation-net_ldap.gemspec @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +lib = File.expand_path('lib', __dir__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require 'opentelemetry/instrumentation/net/ldap/version' + +Gem::Specification.new do |spec| + spec.name = 'opentelemetry-instrumentation-net_ldap' + spec.version = OpenTelemetry::Instrumentation::Net::LDAP::VERSION + spec.authors = ['OpenTelemetry Authors'] + spec.email = ['cncf-opentelemetry-contributors@lists.cncf.io'] + + spec.summary = 'Net::LDAP instrumentation for the OpenTelemetry framework' + spec.description = 'Net::LDAP instrumentation for the OpenTelemetry framework' + spec.homepage = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib' + spec.license = 'Apache-2.0' + + spec.files = Dir.glob('lib/**/*.rb') + + Dir.glob('*.md') + + ['LICENSE', '.yardopts'] + spec.require_paths = ['lib'] + spec.required_ruby_version = ">= #{File.read(File.expand_path('../../gemspecs/RUBY_REQUIREMENT', __dir__))}" + + spec.add_dependency 'opentelemetry-api', '~> 1.0' + spec.add_dependency 'opentelemetry-instrumentation-base', '~> 0.23.0' + + if spec.respond_to?(:metadata) + spec.metadata['changelog_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}/file/CHANGELOG.md" + spec.metadata['source_code_uri'] = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/net_ldap' + spec.metadata['bug_tracker_uri'] = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues' + spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}" + end +end diff --git a/instrumentation/net_ldap/test/opentelemetry/instrumentation/net/ldap/instrumentation_test.rb b/instrumentation/net_ldap/test/opentelemetry/instrumentation/net/ldap/instrumentation_test.rb new file mode 100644 index 0000000000..083e16cac1 --- /dev/null +++ b/instrumentation/net_ldap/test/opentelemetry/instrumentation/net/ldap/instrumentation_test.rb @@ -0,0 +1,119 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' + +require_relative '../../../../../lib/opentelemetry/instrumentation/net/ldap' +require_relative '../../../../../lib/opentelemetry/instrumentation/net/ldap/patches/instrumentation' + +describe OpenTelemetry::Instrumentation::Net::LDAP::Instrumentation do + let(:instrumentation) { OpenTelemetry::Instrumentation::Net::LDAP::Instrumentation.instance } + let(:exporter) { EXPORTER } + let(:span) { exporter.finished_spans.first } + let(:ldap) do + Net::LDAP.new \ + host: 'test.mocked.com', port: 636, + encryption: { + method: :simple_tls, + tls_options: { foo: :bar } + }, + force_no_page: true + end + + # Fake Net::LDAP::Connection for testing + class FakeConnection + Result = Struct.new(:success?, :result_code) + + def initialize + @bind_success = Result.new(true, Net::LDAP::ResultCodeSuccess) + @search_success = Result.new(true, Net::LDAP::ResultCodeSizeLimitExceeded) + end + + def bind(args = {}) + @bind_success + end + + def search(*args) + yield @search_success if block_given? + @search_success + end + + # for testing failure case + def add(args) + raise Net::LDAP::Error, 'Connection timed out - user specified timeout' + end + end + + before do + exporter.reset + instrumentation.install + end + + after do + # Force re-install of instrumentation + instrumentation.instance_variable_set(:@installed, false) + end + + describe '#instrument' do + it 'before request' do + _(exporter.finished_spans.size).must_equal 0 + end + + describe 'when making bind' do + it 'tracks the attributes with correct name' do + ldap.connection = FakeConnection.new + assert ldap.bind + + _(exporter.finished_spans.size).must_equal 1 + _(span.name).must_equal 'bind.net_ldap' + _(span.attributes['ldap.auth']).must_equal '{"method":"anonymous"}' + _(span.attributes['ldap.base']).must_equal 'dc=com' + _(span.attributes['ldap.encryption']).must_equal '{"method":"simple_tls","tls_options":{"foo":"bar"}}' + _(span.attributes['ldap.payload']).must_equal '{}' + _(span.attributes['ldap.status_code']).must_equal 0 + _(span.attributes['net.peer.name']).must_equal 'test.mocked.com' + _(span.attributes['net.peer.port']).must_equal 636 + end + end + + describe 'when making search' do + it 'tracks the attributes with correct name' do + ldap.connection = FakeConnection.new + assert ldap.search(filter: '(uid=user1)') + + _(exporter.finished_spans.size).must_equal 1 + _(span.name).must_equal 'search.net_ldap' + _(span.attributes['ldap.auth']).must_equal '{"method":"anonymous"}' + _(span.attributes['ldap.base']).must_equal 'dc=com' + _(span.attributes['ldap.encryption']).must_equal '{"method":"simple_tls","tls_options":{"foo":"bar"}}' + _(span.attributes['ldap.payload']).must_equal '{"filter":"(uid=user1)","paged_searches_supported":false,"base":"dc=com"}' + _(span.attributes['ldap.status_code']).must_equal 0 + _(span.attributes['net.peer.name']).must_equal 'test.mocked.com' + _(span.attributes['net.peer.port']).must_equal 636 + end + end + + describe 'when error happens' do + it 'tracks the attributes with correct name & error message' do + ldap.connection = FakeConnection.new + + assert_raises Net::LDAP::Error do + ldap.add({}) + end + + _(exporter.finished_spans.size).must_equal 1 + _(span.name).must_equal 'add.net_ldap' + _(span.attributes['ldap.auth']).must_equal '{"method":"anonymous"}' + _(span.attributes['ldap.base']).must_equal 'dc=com' + _(span.attributes['ldap.encryption']).must_equal '{"method":"simple_tls","tls_options":{"foo":"bar"}}' + _(span.attributes['ldap.payload']).must_equal '{}' + _(span.attributes['ldap.error_message']).must_equal 'Net::LDAP::Error: Connection timed out - user specified timeout' + _(span.attributes['net.peer.name']).must_equal 'test.mocked.com' + _(span.attributes['net.peer.port']).must_equal 636 + end + end + end +end diff --git a/instrumentation/net_ldap/test/test_helper.rb b/instrumentation/net_ldap/test/test_helper.rb new file mode 100644 index 0000000000..ff647cd5a4 --- /dev/null +++ b/instrumentation/net_ldap/test/test_helper.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'net/ldap' +require 'bundler/setup' +Bundler.require(:default, :development, :test) + +require 'minitest/autorun' +require 'webmock/minitest' + +# global opentelemetry-sdk setup: +EXPORTER = OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new +span_processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(EXPORTER) + +OpenTelemetry::SDK.configure do |c| + c.error_handler = ->(exception:, message:) { raise(exception || message) } + c.logger = Logger.new($stderr, level: ENV.fetch('OTEL_LOG_LEVEL', 'fatal').to_sym) + c.add_span_processor span_processor +end diff --git a/release-please-config.json b/release-please-config.json index db4312a82d..9781c81f6e 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -154,6 +154,10 @@ "package-name": "opentelemetry-instrumentation-net_http", "version-file": "lib/opentelemetry/instrumentation/net/http/version.rb" }, + "instrumentation/net_ldap": { + "package-name": "opentelemetry-instrumentation-net_ldap", + "version-file": "lib/opentelemetry/instrumentation/net/ldap/version.rb" + }, "instrumentation/pg": { "package-name": "opentelemetry-instrumentation-pg", "version-file": "lib/opentelemetry/instrumentation/pg/version.rb"