splunk-otel 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22ebfcc16e49baa0feef01f353c7c50ce65dc28774bb3ee408c1e996feb5a87b
-  data.tar.gz: '082b71bf0cca5feb45251792308cd7ddf83995a41f3ffab01e2ba94dd75817d6'
+  metadata.gz: 6549c18607d6e48e41c326820885cdbcf5ed1503ccfa28f10b90b63695608a78
+  data.tar.gz: 6a1a4884c1b09a07cc36348b9d59537972abd9c4024dbc6b1ae13199bb91091c
 SHA512:
-  metadata.gz: fb2e7706f749a7f53866cc7f4d4fd05d2ae6c826b694a490d2bcd79ace5c6f46e9c74c0fa3fc65df53e0b28abdd72e5878d99f8f5f91732465ec24fc423a571b
-  data.tar.gz: 6fc797ae357239f04bb51aba388e2a161df6e6ea949dc27759ed9e037914cf422e6504e8ffc37986bfc2e1425bef20446a62831914a137d7283825808d1868e6
+  metadata.gz: db4051858076eadc6dcb3cdd6e279dbf80a239a22699f8ad5590694ed1b079c0bc70c579fc3a839c346fa00ceda56b58e6263757a1f9bd516cb938836fc511e8
+  data.tar.gz: f483859be56aa11350c2744e256c918396b0de8bd2ad31311918d889c1f0c86eae5afa69bcd5a995e88ee348a117c6a14c654e9afac1d5bba7d387925157bdde

data/.github/workflows/main.yml

@@ -13,6 +13,7 @@ jobs:
     strategy:
       matrix:
         rubygems: [
+          { ruby: "3.2", appraisal: "rails-7.0" },
           { ruby: "3.1", appraisal: "rails-7.0" },
           { ruby: "3.0", appraisal: "rails-7.0" },
           { ruby: "2.7", appraisal: "rails-7.0" },
@@ -27,13 +28,17 @@ jobs:
         run: docker-compose up -d
 
       - name: Set up Ruby ${{ matrix.rubygems.ruby }}
-        uses: ruby/setup-ruby@v1.117.0
+        uses: ruby/setup-ruby@v1.134.0
         with:
           ruby-version: ${{ matrix.rubygems.ruby }}
       - name: Apply RubyGems fixes
         run: gem update --system
+      - name: Ensure we have modern bundler
+        run: gem install bundler -v '~> 2.3.26'
       - name: Install dependencies
-        run: bundle install
+        run: bundle _2.3.26_
+      - name: Verify nokogiri
+        run: bundle exec nokogiri -v
       - name: Install appraisal dependencies
         run: bundle exec appraisal install
       - name: Rubocop

data/.gitignore

@@ -12,5 +12,5 @@ Gemfile.lock
 # allow private binstubs
 bin/
 
-# appraisals
+# appraisal
 /gemfiles/

data/README.md

@@ -43,13 +43,13 @@ This Splunk distribution comes with the following defaults:
 Install the gem by adding it to your project's `Gemfile`:
 
 ``` ruby
-gem "splunk-otel", "~> 0.1"
+gem "splunk-otel", "~> 1.0"
 ```
 
 or
 
 ```shell
-bundle add splunk-otel --version "~> 0.1"
+bundle add splunk-otel --version "~> 1.0"
 ```
 
 Configure OpenTelemetry using the `Splunk::Otel` module from `splunk/otel`:
@@ -119,7 +119,7 @@ the
 gem in your Gemfile:
 
 ``` ruby
-gem "opentelemetry-instrumentation-all", "~> 0.23"
+gem "opentelemetry-instrumentation-all", "~> 0.27"
 ```
 
 Enable the instrumentations from the gem by passing `auto_instrument:true` to
@@ -185,7 +185,7 @@ the project's `Gemfile`. For example, to install the
 instrumentation:
 
 ```
-gem "opentelemetry-instrumentation-sinatra", "~> 0.19"
+gem "opentelemetry-instrumentation-sinatra", "~> 0.21"
 ```
 
 In a block passed to `Splunk::Otel.configure` configure the SDK to use
@@ -254,7 +254,7 @@ For troubleshooting information, see the [Troubleshooting](docs/troubleshooting.
 
 # License
 
-The Splunk OpenTelemetry Ruby distribution is released under the terms of the
+The Splunk OpenTelemetry Ruby distribution is licensed under the terms of the
 Apache Software License version 2.0. For more details, see [the license
 file](./LICENSE).
 

data/docs/instrumenting-rails.md

@@ -1,6 +1,45 @@
 # Instrumenting Rails
 
-TODO
+Install the instrumentation library by adding it to your project's `Gemfile`:
+
+``` ruby
+gem "opentelemetry-instrumentation-rails", "~> 0.24"
+```
+
+or install the gem using `bundle`:
+
+```shell
+bundle add opentelemetry-instrumentation-rails --version "~> 0.24"
+```
+
+Configure OpenTelemetry to use all available instrumentation libraries by adding the
+`Splunk::Otel` module from `splunk/otel` and `use_all()` method to a Rails initializer:
+
+``` ruby
+# config/initializers/opentelemetry.rb
+require "splunk/otel"
+...
+Splunk::Otel.configure do |c|
+  c.use_all()
+end
+```
+
+You can disable individual components' instrumentation as options to
+`use_all`. For example to disable Active Record instrumentation:
+
+``` ruby
+Splunk::Otel.configure do |c|
+  c.use_all({ 'OpenTelemetry::Instrumentation::ActiveRecord' => { enabled: false } })
+end
+```
+
+To enable only Rails, you can use an individual `c.use`:
+
+```ruby
+Splunk::Otel.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Rails'
+end
+```
 
 ## Example
 

data/examples/rails-7-barebones/Dockerfile

@@ -1,7 +1,7 @@
 FROM ruby:3.1.2-buster
 RUN apt-get update -qq
 RUN apt-get install -y \
-    nodejs="10.24.0~dfsg-1~deb10u1" \
+    nodejs="10.24.0~dfsg-1~deb10u2" \
     netcat=1.10-41.1
 
 # ruby comes with older versions of bundler sometimes

data/examples/sinatra_example/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/examples/sinatra_example/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/examples/sinatra_example/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-10-25
+
+- Initial release

data/examples/sinatra_example/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tsloughter+work@splunk.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/examples/sinatra_example/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sinatra_example.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "test-unit", "~> 3.0"
+
+gem "rubocop", "~> 1.7"
+
+gem "opentelemetry-instrumentation-pg"
+gem "opentelemetry-instrumentation-sinatra"
+gem "pg"
+gem "puma"
+gem "sinatra", "~> 3.0"
+gem "splunk-otel"

data/examples/sinatra_example/README.md

@@ -0,0 +1,34 @@
+# Sinatra and PG Example
+
+This example contains a Sinatra webapp that connects to and queries a Postgres
+database (see the `docker-compose.yml` file for running the database).
+
+Sinatra and PG are instrumented through OpenTelemetry libraries enabled in
+`config.ru`:
+
+``` ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Sinatra'
+  c.use 'OpenTelemetry::Instrumentation::PG'
+end
+```
+
+## Usage
+
+By default the spans are output to the console but this can be overriden by
+setting the environment varirable `OTEL_TRACES_EXPORTER`.
+
+``` shell
+$ docker-compose up -d
+
+$ bundle install
+
+$ bundle exec rackup
+```
+
+From a separate shell:
+
+``` shell
+$ curl 0.0.0.0:9292
+query result is [["1", "2", "3"]]
+```

data/examples/sinatra_example/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/examples/sinatra_example/config.ru

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+Bundler.require
+ENV["OTEL_TRACES_EXPORTER"] ||= "console"
+OpenTelemetry::SDK.configure do |c|
+  c.use "OpenTelemetry::Instrumentation::Sinatra"
+  c.use "OpenTelemetry::Instrumentation::PG"
+end
+
+require "./lib/sinatra_example"
+run SinatraExample::App

data/examples/sinatra_example/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3.7'
+
+services:
+  postgres:
+    image: postgres:14.6-alpine
+    environment:
+      - POSTGRES_USER=test
+      - POSTGRES_DB=test
+      - POSTGRES_PASSWORD=password
+    ports:
+      - 5432:5432

data/examples/sinatra_example/lib/sinatra_example/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SinatraExample
+  VERSION = "0.1.0"
+end

data/examples/sinatra_example/lib/sinatra_example.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "sinatra_example/version"
+require "sinatra"
+require "splunk/otel"
+
+module SinatraExample
+  class Error < StandardError; end
+
+  # Sinatra example app with postgres query
+  class App < Sinatra::Base
+    set :bind, "0.0.0.0"
+
+    get "/" do
+      conn = PG::Connection.open(host: "localhost",
+                                 port: "5432",
+                                 user: "test",
+                                 dbname: "test",
+                                 password: "password")
+      r = conn.exec("SELECT 1, 2, 3").values
+
+      "query result is #{r}"
+    end
+  end
+end

data/examples/sinatra_example/sinatra_example.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "lib/sinatra_example/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra_example"
+  spec.version       = SinatraExample::VERSION
+  spec.authors       = ["Tristan Sloughter"]
+  spec.email         = ["tsloughter+work@splunk.com"]
+
+  spec.summary       = "Example instrumented sinatra app"
+  spec.description   = "Example instrumented sinatra app"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/splunk/otel/version.rb

@@ -2,6 +2,6 @@
 
 module Splunk
   module Otel
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

data/lib/splunk/otel.rb

@@ -124,7 +124,7 @@ module Splunk
     # add the access token header if the env variable is set
     def set_access_token_header
       splunk_access_token = ENV.fetch("SPLUNK_ACCESS_TOKEN", nil)
-      return if splunk_access_token.nil?
+      return if splunk_access_token.to_s.empty?
 
       access_header = "x-sf-token=#{splunk_access_token}"
       headers = ENV.fetch("OTEL_EXPORTER_OTLP_HEADERS", nil)

data/splunk-otel.gemspec

@@ -28,18 +28,20 @@ Gem::Specification.new do |spec|
   spec.add_dependency "opentelemetry-api", "~> 1.0"
   spec.add_dependency "opentelemetry-exporter-jaeger", ">= 0.20.1", "< 0.23.0"
   spec.add_dependency "opentelemetry-exporter-otlp", ">= 0.21", "< 0.25"
-  spec.add_dependency "opentelemetry-instrumentation-base", "~> 0.21.0"
+  spec.add_dependency "opentelemetry-instrumentation-base", "~> 0.21"
   spec.add_dependency "opentelemetry-propagator-b3", ">= 0.19.2", "< 0.21.0"
   spec.add_dependency "opentelemetry-sdk", "~> 1.0"
 
   # development tooling
   spec.add_development_dependency "appraisal", "2.4.1"
+  spec.add_development_dependency "bundler", "2.3.26"
   spec.add_development_dependency "rake", "13.0.6"
   spec.add_development_dependency "rubocop", "1.36.0"
   spec.add_development_dependency "rubocop-rake", "0.6.0"
   spec.add_development_dependency "simplecov", "0.21.2"
   spec.add_development_dependency "simplecov-cobertura", "2.1.0"
   spec.add_development_dependency "test-unit", "3.5.3"
+  spec.add_development_dependency "tzinfo-data", "1.2022.7"
 
   # development dependencies for integration testing
   spec.add_development_dependency "opentelemetry-instrumentation-action_pack", "~> 0.2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splunk-otel
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Splunk
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-29 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-propagator-b3
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +126,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.4.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.26
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +224,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.5.3
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2022.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2022.7
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-action_pack
   requirement: !ruby/object:Gem::Requirement
@@ -280,7 +308,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - splunk-oss@splunk.com
 executables: []
@@ -326,6 +354,18 @@ files:
 - examples/rails-7-barebones/docker-compose.yml
 - examples/rails-7-barebones/tests-e2e/rails_7_barebones_test.rb
 - examples/rails-7-barebones/wait-for.sh
+- examples/sinatra_example/.gitignore
+- examples/sinatra_example/.rubocop.yml
+- examples/sinatra_example/CHANGELOG.md
+- examples/sinatra_example/CODE_OF_CONDUCT.md
+- examples/sinatra_example/Gemfile
+- examples/sinatra_example/README.md
+- examples/sinatra_example/Rakefile
+- examples/sinatra_example/config.ru
+- examples/sinatra_example/docker-compose.yml
+- examples/sinatra_example/lib/sinatra_example.rb
+- examples/sinatra_example/lib/sinatra_example/version.rb
+- examples/sinatra_example/sinatra_example.gemspec
 - examples/smart-agent/.gitignore
 - examples/smart-agent/Gemfile
 - examples/smart-agent/docker-compose.yml
@@ -349,7 +389,7 @@ homepage: https://github.com/signalfx/splunk-otel-ruby
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -364,8 +404,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Splunk OpenTelemetry Ruby distribution
 test_files: []