splunk-otel 1.0.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22ebfcc16e49baa0feef01f353c7c50ce65dc28774bb3ee408c1e996feb5a87b
-  data.tar.gz: '082b71bf0cca5feb45251792308cd7ddf83995a41f3ffab01e2ba94dd75817d6'
+  metadata.gz: dcf4dad70d8a6b71b55f6677d0ce9b159593dca24f132450e8c54e68c07c10b2
+  data.tar.gz: c1e39dd47d8db577649ef2c2512d98ff5ff273737c5c07c018704db6f2682cbd
 SHA512:
-  metadata.gz: fb2e7706f749a7f53866cc7f4d4fd05d2ae6c826b694a490d2bcd79ace5c6f46e9c74c0fa3fc65df53e0b28abdd72e5878d99f8f5f91732465ec24fc423a571b
-  data.tar.gz: 6fc797ae357239f04bb51aba388e2a161df6e6ea949dc27759ed9e037914cf422e6504e8ffc37986bfc2e1425bef20446a62831914a137d7283825808d1868e6
+  metadata.gz: 449588970f19061697f38f64f4d69d53ce1b05fa29c9d0f73aa34d115b42436b98a6470b9107fabe5ad4269344611773466a09fcb41ca122674c6b059df59cd6
+  data.tar.gz: 1b700291e9eb7708a6015915d73b35c38618d64e5cabd89dce20e4ef179a70b646fb08429ee9a70d3ff8095f325912c73929fcbf26d52787cddbe2a473b779a4

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" },
@@ -21,19 +22,23 @@ jobs:
         ]
 
     steps:
-      - uses: actions/checkout@v3.0.2
+      - uses: actions/checkout@v3.5.2
 
       - name: Run Collector
         run: docker-compose up -d
 
       - name: Set up Ruby ${{ matrix.rubygems.ruby }}
-        uses: ruby/setup-ruby@v1.117.0
+        uses: ruby/setup-ruby@v1.149.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
@@ -41,7 +46,7 @@ jobs:
       - name: Run tests
         run: bundle exec appraisal ${{ matrix.rubygems.appraisal }} rake test
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3.1.1
+        uses: codecov/codecov-action@v3.1.3
       - name: Run basic example e2e test
         run: ruby console.rb
         working-directory: ./examples/basic/
@@ -51,7 +56,7 @@ jobs:
   test-e2e-rails-7-barebones:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v3.0.2
+      - uses: actions/checkout@v3.5.2
       - name: Run e2e tests via Docker
         working-directory: ./examples/rails-7-barebones
         run: docker-compose up --build --exit-code-from tester
@@ -59,8 +64,8 @@ jobs:
   linkChecker:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v3.0.2
+      - uses: actions/checkout@v3.5.2
       - name: Link Checker
-        uses: lycheeverse/lychee-action@v1.5.1
+        uses: lycheeverse/lychee-action@v1.7.0
         with:
           fail: true

data/.gitignore

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

data/.gitlab-ci.yml

@@ -18,7 +18,8 @@ build:
       - Gemfile.lock
   script: |
     gem update --system
-    bundle install
+    gem install bundler:2.3.26
+    bundle _2.3.26_ install
     bundle exec rubocop
     bundle exec rake test
 

data/.rubocop.yml

@@ -29,3 +29,9 @@ Metrics/MethodLength:
 
 Metrics/ModuleLength:
   Max: 105
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+  Exclude:
+    - 'examples/rails-7-barebones/Gemfile'
+    - 'examples/smart-agent/Gemfile'

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this repository adheres to [Semantic Versioning](https://semver.org/spec/v2.
 
 ## Unreleased
 
+## v1.1.3 - 2023-05-24
+
+- No changes.
+
+## v1.1.1 - 2023-05-24
+
+- No significant changes.
+
+## v1.1.0 - 2023-01-30
+
+- fix handling of SPLUNK_ACCESS_TOKEN to check for empty string [#114](https://github.com/signalfx/splunk-otel-ruby/pull/114)
+
 ## v1.0.0 - 2022-09-29
 
 ## v0.3.0 - 2022-09-28

data/CONTRIBUTING.md

@@ -33,14 +33,17 @@ See [SECURITY.md](SECURITY.md#reporting-security-issues) for instructions.
 
 ## Documentation
 
-The Splunk Observability documentation is hosted on https://docs.splunk.com/Observability,
-which contains all the prescriptive guidance for Splunk Observability products. 
-Prescriptive guidance consists of step-by-step instructions, conceptual material,
-and decision support for customers. Reference documentation and development 
-documentation is hosted on this repository.
-
-You can send feedback about Splunk Observability docs by clicking the Feedback 
-button on any of our documentation pages.
+The Splunk Observability documentation is hosted on the [Splunk Observability
+Cloud docs site](https://docs.splunk.com/Observability), which contains all the
+prescriptive guidance for Splunk Observability products. Prescriptive guidance
+consists of step-by-step instructions, conceptual material, and decision support
+for customers. Reference documentation and development documentation is still
+hosted on this repository.
+
+To contribute documentation for this project, open a pull request in the
+[public-o11y-docs](https://github.com/splunk/public-o11y-docs) repository. See
+the [CONTRIBUTING.md](https://github.com/splunk/public-o11y-docs/blob/main/CONTRIBUTING.md)
+guide of the Splunk Observability Cloud documentation for more information.
 
 ## Contributing via Pull Requests
 

data/README.md

@@ -11,8 +11,8 @@
 
 The Splunk Distribution of [OpenTelemetry Instrumentation for
 Ruby](https://github.com/open-telemetry/opentelemetry-ruby) provides a gem for
-setup of OpenTelemetry SDK for reporting distributed traces to [Splunk
-APM](https://docs.splunk.com/Observability/apm/intro-to-apm.html).
+setup of OpenTelemetry SDK for reporting distributed traces to Splunk
+APM.
 
 This distribution comes with the following defaults:
 
@@ -24,221 +24,39 @@ This distribution comes with the following defaults:
 - Unlimited default limits for [configuration options](#trace-configuration) to
   support full-fidelity traces.
 
+If you're using the SignalFx Tracing Library for Ruby and want to migrate to the Splunk Distribution of OpenTelemetry Ruby, see [Migrate from the SignalFx Tracing Library for Ruby](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.migrate) in the official documentation.
+
 ## Requirements
 
-- Ruby 2.6+
+This distribution requires Ruby version 2.6 or higher.
 
 ## Get started
 
-This Splunk distribution comes with the following defaults:
-
-- [W3C tracecontext](https://www.w3.org/TR/trace-context/) and [W3C
-  baggage](https://www.w3.org/TR/baggage/) context propagation.
-- OTLP over HTTP exporter configured to send spans to a locally running [Splunk
-  OpenTelemetry Connector](https://github.com/signalfx/splunk-otel-collector)
-  at http://localhost:4318.
-- Unlimited default limits for configuration options to support full-fidelity
-  traces.
-
-Install the gem by adding it to your project's `Gemfile`:
-
-``` ruby
-gem "splunk-otel", "~> 0.1"
-```
-
-or
-
-```shell
-bundle add splunk-otel --version "~> 0.1"
-```
-
-Configure OpenTelemetry using the `Splunk::Otel` module from `splunk/otel`:
-
-``` ruby
-require "splunk/otel"
-...
-Splunk::Otel.configure
-```
-
-## Basic configuration
-
-The `service.name` resource attribute is the only configuration option that
-needs to be specified, using either the environment variable `OTEL_SERVICE_NAME`
-or passing as an argument to `configure`:
-
-``` ruby
-Splunk::Otel.configure(service_name: "my-service")
-```
-
-Other resource attributes are not strictly required, but
-`deployment.environment` and `service.version` are recommended to be set if they
-are available. These can be set through the environment variable
-`OTEL_RESOURCE_ATTRIBUTES`:
-
-```
-OTEL_RESOURCE_ATTRIBUTES="service.version=1.2.3,deployment.environment=production"
-```
-
-alternatively, if needed, more attributes can be added in code using:
-
-```ruby
-Splunk::Otel.configure(service_name: "my-service") do |c|
-  c.resource = OpenTelemetry::SDK::Resources::Resource.create(
-    "key" => "value"
-  )
-end
-```
+For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry Ruby, see [Instrument a Ruby application for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.application) in the official documentation.
 
 ## Advanced configuration
 
-See [advanced-config.md](docs/advanced-config.md) for information on how to
-configure the instrumentation.
+See [Configure the Ruby agent for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.configuration) in the official documentation.
 
 ## Correlate traces and logs
 
 You can add trace metadata to logs using the OpenTelemetry trace API. Trace
 metadata lets you explore logs in Splunk Observability Cloud.
 
-See [Correlating traces and logs](docs/correlating-traces-and-logs.md) for more information.
+See [Connect Ruby trace data with logs for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.trace.logs) in the official documentation.
 
 ## Library instrumentation
 
 Supported libraries are listed
 [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation).
-The corresponding gems for the instrumentation libraries can be found under the
+You can find the corresponding gems for the instrumentation libraries under the
 [opentelemetry-ruby](https://rubygems.org/profiles/opentelemetry-ruby) profile
 on [rubygems.org](https://rubygems.org).
 
-### Automatic instrumentation
-
-You can enable automatic instrumentation of all libraries used in your project
-that have corresponding [OpenTelemetry Ruby
-gems](https://rubygems.org/profiles/opentelemetry-ruby) libraries by installing
-the
-[opentelemetry-instrumentation-all](https://rubygems.org/gems/opentelemetry-instrumentation-all)
-gem in your Gemfile:
-
-``` ruby
-gem "opentelemetry-instrumentation-all", "~> 0.23"
-```
-
-Enable the instrumentations from the gem by passing `auto_instrument:true` to
-the `configure` method of `Splunk::Otel`. For example:
-
-``` ruby
-require "splunk/otel"
-
-Splunk::Otel.configure(auto_instrument: true)
-```
-
-The gem fetches all instrumentation libraries but only enables those that
-instrument a dependency in your project. For example, it will fetch
-`opentelemetry-instrumentation-rack` but only if the `rack` gem is included and
-used in your project will the instrumentation be enabled.
-
-`auto_instrument: true` also works if individual instrumentation libraries are
-installed, like the `opentelemetry-instrumentation-sinatra` gem.
-
-To set configuration of one or more instrumentation libraries a config hash
-can be passed to `use_all`:
-
-``` ruby
-OpenTelemetry::SDK.configure do |c|
-  config = {'OpenTelemetry::Instrumentation::Redis' => { opt: "value" }}
-  c.use_all(config)
-end
-```
-
-The option `enabled` can be used to disable individual instrumentation libraries
-when using `opentelemetry-instrumentation-all`:
-
-``` ruby
-OpenTelemetry::SDK.configure do |c|
-  config = {'OpenTelemetry::Instrumentation::Redis' => { enabled: false }}
-  c.use_all(config)
-end
-```
-
-To enable instrumentation libraries manually, see [Manual library instrumentation](#manual-library-instrumentation).
-
-### Manual instrumentation
-
-Documentation on how to manually instrument a Ruby application is available in the 
-[OpenTelemetry official documentation](https://opentelemetry.io/docs/instrumentation/ruby/manual/).
-
-To extend the instrumentation with the OpenTelemetry Instrumentation for Ruby,
-you have to use a compatible API version.
-
-The Splunk Distribution of OpenTelemetry Ruby is compatible with:
-
-- OpenTelemetry API version 1.0.0
-- OpenTelemetry SDK version 1.0.0
-
-### Manual library instrumentation
-
-Instrumentation gems can also be installed and enabled individually. This may be
-preferred in order to control exactly which gems are fetched when building your project.
-
-Install the instrumentation library by including it in
-the project's `Gemfile`. For example, to install the
-[Sinatra](https://rubygems.org/gems/opentelemetry-instrumentation-sinatra)
-instrumentation:
-
-```
-gem "opentelemetry-instrumentation-sinatra", "~> 0.19"
-```
-
-In a block passed to `Splunk::Otel.configure` configure the SDK to use
-each of the instrumentation libraries. In the case of the Sinatra instrumentation,
-the block would look like the following example:
-
-``` ruby
-require "splunk/otel"
-
-Splunk::Otel.configure do |c|
-  c.use "OpenTelemetry::Instrumentation::Sinatra", { opt: "value" }
-end
-```
-
-### Real User Monitoring
-
-For [Real User Monitoring
-(RUM)](https://www.splunk.com/en_us/products/real-user-monitoring.html) a
-[Rack](https://github.com/rack/rack) middleware is provided which will add trace
-context to the `Server-Timing` header in the response if there is an active
-Span. To use the middleware configure `Splunk::Otel` to use the `Rack`
-instrumentation:
-
-``` ruby
-Splunk::Otel.configure do |c|
-    c.use "OpenTelemetry::Instrumentation::Rack"
-end
-```
-
-And add the middleware in `Rack::Builder`:
-
-``` ruby
-Rack::Builder.app do
-    use OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware
-    use Splunk::Otel::Rack::RumMiddleware
-    run ->(_env) { [200, { "content-type" => "text/plain" }, ["OK"]] }
-end
-```
-
-When using [ActionPack](https://rubygems.org/gems/actionpack/), which Rails
-does, the middleware will be added automatically if the Instrumentation Library
-for ActionPack, "Splunk::Otel::Instrumentation::ActionPack", is used:
 
-``` ruby
-Splunk::Otel.configure do |c|
-    c.use "OpenTelemetry::Instrumentation::ActionPack"
-    c.use "Splunk::Otel::Instrumentation::ActionPack"
-end
-```
+## Manual instrumentation
 
-To disable the response headers being added the environment variable
-`SPLUNK_TRACE_RESPONSE_HEADER_ENABLED` can be set to `false`, or pass
-`trace_response_header_enabled: false` to `Splunk::Otel.configure`.
+See [Manually instrument Ruby applications for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.manual.instrumentation) for instructions on how to manually instrument Ruby applications.
 
 ## Configure for use with Smart Agent
 
@@ -250,11 +68,11 @@ If the `SPLUNK_REALM` or the `OTEL_EXPORTER_JAEGER_ENDPOINT` environmental varia
 
 ## Troubleshooting
 
-For troubleshooting information, see the [Troubleshooting](docs/troubleshooting.md) documentation.
+For troubleshooting information, see the [Troubleshoot Ruby instrumentation for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.troubleshooting) in the official documentation.
 
 # 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).
 
@@ -266,4 +84,3 @@ file](./LICENSE).
 >
 > 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.
 
->ℹ️  SignalFx was acquired by Splunk in October 2019. See [Splunk SignalFx](https://www.splunk.com/en_us/investor-relations/acquisitions/signalfx.html) for more information.

data/RELEASING.md

@@ -0,0 +1,19 @@
+# Release Process
+
+## Requirements
+
+Releases to https://rubygems.org are done through Gitlab CI.
+
+Scripts for performing the release can be found in `scripts/`. The scripts will
+both create a draft Github Release and push a Gem.
+
+## Steps
+
+- Update `CHANGELOG.md`
+- Bump version in `lib/splunk/otel/version.rb`
+- Create PR
+- Once PR is approved and merged created a tag with the same version as
+  `version.rb` prefixed with `v` and push the tag
+- Watch Gitlab CI for the `release` job to complete
+- Update the newly created Github Release notes with the contents of
+  `CHANGELOG.md`

data/docs/README.md

@@ -1,3 +1 @@
-The official documentation for this distribution can be found here:
-
-https://docs.splunk.com/Observability/gdi/get-data-in/application/ruby/get-started.html
+The documentation for this distribution can be found in the [Splunk Observability Cloud official documentation](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.application).

data/docs/advanced-config.md

@@ -1,3 +1,7 @@
+> The official Splunk documentation for this page is [Configure the Splunk Distribution of OTel Ruby](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.configuration). 
+> 
+> For instructions on how to contribute to the docs, see [CONTRIBUTING.md](../CONTRIBUTING.md#documentation).
+
 # Advanced configuration
 
 ## Trace exporters

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~deb10u3" \
     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.3"
   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/scripts/install-release-deps.sh

@@ -15,4 +15,4 @@ curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | gpg -
 echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | tee /etc/apt/sources.list.d/github-cli.list > /dev/null
 
 apt-get update
-apt-get -y install gh="2.16.1"
+apt-get -y install gh

data/scripts/release.sh

@@ -31,8 +31,10 @@ create_gh_release() {
     --title "Release $release_tag"
 }
 
-create_gh_release
-
+# the gem publish for the tag is the most important so do that first
 bundle install
 bundle exec rake build
 bundle exec gem push pkg/splunk-otel-${release_version}.gem
+
+create_gh_release
+

data/splunk-otel.gemspec

@@ -28,22 +28,24 @@ 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", "1.50.2"
   spec.add_development_dependency "rubocop-rake", "0.6.0"
-  spec.add_development_dependency "simplecov", "0.21.2"
+  spec.add_development_dependency "simplecov", "0.22.0"
   spec.add_development_dependency "simplecov-cobertura", "2.1.0"
-  spec.add_development_dependency "test-unit", "3.5.3"
+  spec.add_development_dependency "test-unit", "3.5.8"
+  spec.add_development_dependency "tzinfo-data", "1.2023.3"
 
   # development dependencies for integration testing
-  spec.add_development_dependency "opentelemetry-instrumentation-action_pack", "~> 0.2.0"
-  spec.add_development_dependency "opentelemetry-instrumentation-rack", "~> 0.21.0"
+  spec.add_development_dependency "opentelemetry-instrumentation-action_pack", "~> 0.5.0"
+  spec.add_development_dependency "opentelemetry-instrumentation-rack", "~> 0.22.1"
   spec.add_development_dependency "rack", "~> 2.2"
   spec.add_development_dependency "rack-test", "~> 2.0"
   spec.add_development_dependency "rails"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splunk-otel
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.3
 platform: ruby
 authors:
 - Splunk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-29 00:00:00.000000000 Z
+date: 2023-05-25 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
@@ -146,14 +160,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.50.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.50.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -174,14 +188,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: simplecov-cobertura
   requirement: !ruby/object:Gem::Requirement
@@ -202,42 +216,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.5.3
+        version: 3.5.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.8
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2023.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.5.3
+        version: 1.2023.3
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-action_pack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.1
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -300,17 +328,14 @@ files:
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
-- MIGRATING.md
 - README.md
+- RELEASING.md
 - Rakefile
 - SECURITY.md
 - conf/otel-collector-config.yaml
 - docker-compose.yml
 - docs/README.md
 - docs/advanced-config.md
-- docs/correlating-traces-and-logs.md
-- docs/instrumenting-rails.md
-- docs/troubleshooting.md
 - examples/basic/README.md
 - examples/basic/collector_trace.png
 - examples/basic/console.rb
@@ -326,6 +351,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

data/MIGRATING.md

@@ -1,148 +0,0 @@
-# Migrate from the SignalFx Tracing Library for Ruby
-
-The SignalFx Tracing Library for Ruby is scheduled to be deprecated by the end of 2022.
-Replace it with the Splunk Distribution of OpenTelemetry Ruby.
-
-Splunk Distribution of OpenTelemetry Ruby is based on and compatible with
-the OpenTelemetry Instrumentation for Ruby,
-an open-source project that uses the OpenTelemetry API.
-
-## Compatibility and requirements
-
-The Splunk Distribution of OpenTelemetry Ruby requires Ruby 2.6 and
-higher.
-
-## Known limitations compared to SignalFx Tracing for Ruby
-
-- Different subset of supported Ruby versions, see previous section
-- Currently no auto-instrumentation for:
-    - `elasticsearch` (<https://github.com/elastic/elasticsearch-ruby>)
-    - `grape` (<https://github.com/ruby-grape/grape>)
-    - `sequel` (<https://github.com/jeremyevans/sequel>)
-
-More details in [OTel instrumentation equivalents](#signalfx-instrumentations-equivalents).
-
-## Migrate to the Splunk Distribution of OpenTelemetry Ruby
-
-To migrate from the SignalFx Tracing Library for Ruby to the Splunk
-Distribution of OpenTelemetry Ruby, follow these steps:
-
-1.  Remove the tracing library packages.
-2.  Deploy the Splunk Distribution of OpenTelemetry Ruby.
-3.  Migrate your existing configuration.
-
-> Semantic conventions for span names and attributes change when you
-migrate.
-
-### Remove the SignalFx Tracing Library for Ruby
-
-Follow these steps to remove the tracing library and its dependencies:
-
-1.  Uninstall `signalfx`:
-
-    ``` bash
-    gem uninstall signalfx
-    ```
-
-1.  Remove `signalfx` from your Gemfile.
-
-## Migrate to the Splunk Distribution of OpenTelemetry Ruby
-
-We're currently only testing installation using Bundler with RubyGems as a source.
-[Contact us](mailto:ssg-observability-instrumentals-ruby@splunk.com) if you require a different way of installation.
-
-If you installed
-[Smart Agent](https://github.com/signalfx/signalfx-agent)
-to serve as a gateway (traces/metrics data proxy)
-migrate to
-[OpenTelemetry Collector](https://docs.splunk.com/Observability/gdi/opentelemetry/resources.html)
-first, as soon as (if) possible.
-
-### Deploy the Splunk Distribution of OpenTelemetry Ruby
-
-To install the Splunk Distribution of OpenTelemetry Ruby, see the [README.md](README.md).
-
-### Replace SignalFx / OpenTracing gems with OTel equivalents
-
-1.  Make a list of all `signalfx-*` instrumentation gems from your Gemfile, see
-    [this table](https://github.com/signalfx/signalfx-ruby-tracing#supported-libraries)
-    for a complete list.
-
-1.  Replace them with OpenTelemetry, as per the table below.
-
-1.  Replace any other OpenTracing instrumentation packages you might have installed yourself.
-
-<a name="signalfx-instrumentations-equivalents"></a>
-#### OTel equivalents of SignalFx instrumentation gems
-
-| SignalFx instrumentation name | OTel instrumentation name | notes |
-| ----------------------------- | ------------------------- | ----- |
-| signalfx-activerecord-opentracing | opentelemetry-instrumentation-active_record | |
-| signalfx-elasticsearch-instrumentation | no known equivalents | [open issue in OTel](https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues/8) |
-| signalfx-faraday-instrumentation       | opentelemetry-instrumentation-faraday | |
-| signalfx-grape-instrumentation         | no known equivalents | [open issue in OTel](https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues/9) |
-| signalfgx-mongodb-instrumentation      | opentelemetry-instrumentation-mongo | |
-| signalfx-mysql2-instrumentation        | opentelemetry-instrumentation-mysql2 | |
-| signalfx-nethttp-instrumentation       | opentelemetry-instrumentation-net_http | |
-| signalfx-pg-instrumentation            | opentelemetry-instrumentation-pg | |
-| signalfx-rack-tracer                   | opentelemetry-instrumentation-rack | |
-| signalfx-rails-instrumentation         | opentelemetry-instrumentation-rails | |
-| signalfx-redis-instrumentation         | opentelemetry-instrumentation-redis | |
-| signalfx-restclient-instrumentation    | opentelemetry-instrumentation-restclient | |
-| signalfx-sequel-instrumentation        | no known equivalents | [open issue in OTel](https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues/11) |
-| signalfx-sidekiq-opentracing           | opentelemetry-instrumentation-sidekiq | |
-| signalfx-sinatra-instrumentation       | opentelemetry-instrumentation-sinatra | |
-
-#### OTel equivalents of other Open Tracing instrumentation gems
-
-See the
-[list of all known OTel Ruby instrumentations](https://opentelemetry.io/registry/?language=ruby&component=instrumentation)
-in OpenTelemetry registry.
-
-### Migrate settings for the Splunk Distribution of OpenTelemetry Ruby
-
-1. `SIGNALFX_ENDPOINT_URL` or `ingest_url` configuration parameter
-    - if you installed Smart Agent and can migrate to OpenTelemetry Collector, do that first, then see the point below
-    - if you have OpenTelemetry Collector available up as a sidecar (via `localhost`),
-      and it accepts OTLP on default ports, just remove this setting, we export OTLP to OTel Collector by default
-    - if you need to keep using Smart Agent, you have to set up a jaeger exporter yourself
-    - if you export directly to our backend (without OTel Collector as a proxy),
-      just set `SPLUNK_REALM` to your realm
-      (it's part of the URL, ie. `https://app.<realm>.signalfx.com/`, or `us0` if it's missing)
-
-1. `SIGNALFX_SERVICE_NAME` or `service_name` configuration parameter
-    - to set in environment, use `OTEL_SERVICE_NAME`
-    - to set in code, use `Splunk::Otel.configure(service_name: 'your service name', ...`
-
-1. `SIGNALFX_ACCESS_TOKEN` or `access_token` configuration parameter
-    - to set in environment, use `SPLUNK_ACCESS_TOKEN`
-
-1. `SIGNALFX_SPAN_TAGS` or `span_tags` configuration parameter
-    - to set in environment:
-        - first, you need to rewrite the existing value to the,
-          which has a syntax of comma-separated `<key>=<value>` pairs (e.g. `key1=value1,key2=value2`)
-        - set `OTEL_RESOURCE_ATTRIBUTES` to the new value
-    - to set in code:
-        - call `OpenTelemetry::SDK::Resources::Resource.create` with a `Hash`
-          consisting of your existing key-value pairs
-        - pass the newly created `Resource` to the `resource=` attribute in configuration
-        - for example:
-           ```ruby
-           Splunk::Otel.configure(other_args) do |c|
-             c.resource = OpenTelemetry::SDK::Resources::Resource.create(
-               "key" => "value"
-             )
-             # ...
-           end
-           ```
-
-1. `SIGNALFX_RECORDED_VALUE_MAX_LENGTH`
-    - can be set in environment using `OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT`
-    - see
-      [the list of span limits settings](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#span-limits)
-      to learn more
-
-1. `tracer` configuration parameter
-    - if you need to set its equivalent, open an issue, and tell us about your use case
-
-For more information about Splunk Ruby OTel settings, see [advanced-config.md](docs/advanced-config.md).

data/docs/correlating-traces-and-logs.md

@@ -1,23 +0,0 @@
-# Correlating trace and logs
-
-## Standard Ruby logger
-
-To add trace metadata of the current trace to logs, use the
-`Splunk::Otel::Logging.format_correlation` function of the 
-[Ruby standard logger](https://ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html)
-to set the formatter, as in the following example:
-
-``` ruby
-require "splunk/otel"
-
-logger.formatter = proc do |severity, datetime, progname, msg|  
-  "#{Splunk::Otel::Logging.format_correlation} : #{msg}\n"
-end
-```
-
-This adds `service.name=<ServiceName> trace_id=<TraceId> span_id=<SpanId>` to each log line.
-
-```
-service.name=basic-service trace_id=789b159aaee2b389a8771b2588278bcf
-span_id=6d26eba14a81f3fa : show log correlation
-```

data/docs/instrumenting-rails.md

@@ -1,7 +0,0 @@
-# Instrumenting Rails
-
-TODO
-
-## Example
-
-See the [readme for Rails 7 barebones example](../examples/rails-7-barebones/README.md).

data/docs/troubleshooting.md

@@ -1,14 +0,0 @@
-# Troubleshooting
-
-## Enable debug logging
-
-When things are not working, a good first step is to restart the program with
-debug logging enabled. Do this by setting the `OTEL_LOG_LEVEL` environment
-variable to `debug`.
-
-```sh
-export OTEL_LOG_LEVEL="debug"
-```
-
-Make sure to unset the environment variable after the issue is resolved, as its
-output might overload systems if left on indefinitely.