honeycomb-beeline 2.4.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0f7fd0a816bb7817900181d110a0f95d63b3191aeca362bbe0aadbc18609d7a
-  data.tar.gz: '0702890fe4606c12f68ee032578a8b6f896fcc17c454794f23b3f0705a762c5a'
+  metadata.gz: 97016b5bcb57ce01fa980218fac7d8b71b3b145dec5ff30ad5ab9693d070d665
+  data.tar.gz: df32abbd87b653800ec3ebe2693cc3008593e307ee70ef1f5ab9333f139a96ba
 SHA512:
-  metadata.gz: 96266118829b42c517e4a20e5d42b7d6bea65d8d5d65dd750c78d9825517070f7d1c15167c1dd6d5502be585c9621229369fa036e0c84fa8482cf109b91fcad7
-  data.tar.gz: 9a9ced838db3c0b5948555042b80a1876270e36de75c69b490c8bf55c9150b32c59aa7d2db6e61bd845d131aa83e644e8116f12f8d266957b628a3672f79de54
+  metadata.gz: 51757f1553274cda4c354d16f50998745c41b0f89f4d27d763d8e81f2fe9142a1f491ea3208eb73d26211a81d5c2f2f15e282b9555fd4416d3a20f8cb3373f23
+  data.tar.gz: 0ef3666a518f2e965972967af8fb13d7597bd132026bc6ed8580b93458f0f1cf227a6ab05204dbc31f34da520f25e9f97201d3a9347173da4e7cdece0b6875b0

data/.circleci/bundler_version.sh

@@ -3,6 +3,10 @@
 set -ux
 
 if [[ "$BUNDLE_GEMFILE" =~ (rails_41.gemfile|rails_42.gemfile)$ ]]; then
+  echo "Rails 4.1 and 4.2 require an old Bundler"
   gem uninstall -v '>= 2' -ax bundler
   gem install bundler -v '< 2'
+else
+  echo "Get the latest Bundler"
+  gem update bundler
 fi

data/.circleci/config.yml

@@ -6,7 +6,6 @@ commands:
         type: string
       gemfile:
         type: string
-        default: Gemfile
       command:
         type: string
         default: bundle exec rake test
@@ -14,16 +13,19 @@ commands:
       - checkout
       - restore_cache:
           keys:
-            - gems-v1-<< parameters.ruby-version >>-{{ checksum "Gemfile.lock" }}
+            - gems-v1-<< parameters.ruby-version >>-<< parameters.gemfile >>-{{ checksum "Gemfile.lock" }}
+            - gems-v1-<< parameters.ruby-version >>-<< parameters.gemfile >>
             - gems-v1-<< parameters.ruby-version >>
-      - run: gem update bundler
-      - run: BUNDLE_GEMFILE=<< parameters.gemfile >> ./.circleci/bundler_version.sh
-      - run: BUNDLE_GEMFILE=<< parameters.gemfile >> bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - run: .circleci/bundler_version.sh
+      - run: bundle config set --local path $HOME/project/vendor/bundle
+      - run: bundle install --jobs=4 --retry=3
+      - run: bundle clean --force
+      - run: bundle env
       - save_cache:
           paths:
             - ./vendor/bundle
-          key: gems-v1-<< parameters.ruby-version >>-{{ checksum "Gemfile.lock" }}
-      - run: BUNDLE_GEMFILE=<< parameters.gemfile >> << parameters.command >>
+          key: gems-v1-<< parameters.ruby-version >>-<< parameters.gemfile >>-{{ checksum "Gemfile.lock" }}
+      - run: << parameters.command >>
 
 jobs:
   build_artifacts:
@@ -80,9 +82,12 @@ jobs:
         default: "2.6"
     docker:
         - image: circleci/ruby:<< parameters.ruby-version >>
+    environment:
+      BUNDLE_GEMFILE: ./Gemfile
     steps:
       - ruby:
           ruby-version: << parameters.ruby-version >>
+          gemfile: root
           command: bundle exec rake rubocop
   test:
     parameters:
@@ -92,11 +97,15 @@ jobs:
         type: string
     docker:
         - image: circleci/ruby:<< parameters.ruby-version >>
+    environment:
+      BUNDLE_GEMFILE: gemfiles/<< parameters.gemfile >>.gemfile
     steps:
       - ruby:
           ruby-version: << parameters.ruby-version >>
           gemfile: << parameters.gemfile >>
           command: bundle exec rake test
+      - store_test_results:
+          path: test/reports
 
 workflows:
   nightly:
@@ -110,49 +119,57 @@ workflows:
     jobs:
       - lint
       - test: &test
+          name: test-<< matrix.gemfile >>-ruby_<< matrix.ruby-version >>
           requires:
             - lint
           matrix:
             parameters:
               ruby-version: ["2.2", "2.3", "2.4", "2.5", "2.6", "2.7"]
               gemfile:
-                - gemfiles/aws_2.gemfile
-                - gemfiles/aws_3.gemfile
-                - gemfiles/faraday_0.gemfile
-                - gemfiles/faraday_1.gemfile
-                - gemfiles/sequel4.gemfile
-                - gemfiles/sequel5.gemfile
-                - gemfiles/sinatra.gemfile
-                - gemfiles/rack.gemfile
-                - gemfiles/rails_41.gemfile
-                - gemfiles/rails_42.gemfile
-                - gemfiles/rails_5.gemfile
-                - gemfiles/rails_51.gemfile
-                - gemfiles/rails_52.gemfile
-                - gemfiles/rails_6.gemfile
-                - gemfiles/redis_3.gemfile
-                - gemfiles/redis_4.gemfile
+                - aws_2
+                - aws_3
+                - faraday_0
+                - faraday_1
+                - sequel4
+                - sequel5
+                - sinatra
+                - rack
+                - rails_41
+                - rails_42
+                - rails_5
+                - rails_51
+                - rails_52
+                - rails_6
+                - rails_61
+                - redis_3
+                - redis_4
             exclude:
               - ruby-version: "2.2"
-                gemfile: gemfiles/faraday_1.gemfile
+                gemfile: faraday_1
               - ruby-version: "2.2"
-                gemfile: gemfiles/rails_52.gemfile
+                gemfile: rails_52
               - ruby-version: "2.2"
-                gemfile: gemfiles/rails_6.gemfile
+                gemfile: rails_6
               - ruby-version: "2.3"
-                gemfile: gemfiles/rails_6.gemfile
+                gemfile: rails_6
               - ruby-version: "2.4"
-                gemfile: gemfiles/rails_6.gemfile
+                gemfile: rails_6
+              - ruby-version: "2.2"
+                gemfile: rails_61
+              - ruby-version: "2.3"
+                gemfile: rails_61
+              - ruby-version: "2.4"
+                gemfile: rails_61
               - ruby-version: "2.4"
-                gemfile: gemfiles/rails_41.gemfile
+                gemfile: rails_41
               - ruby-version: "2.5"
-                gemfile: gemfiles/rails_41.gemfile
+                gemfile: rails_41
               - ruby-version: "2.6"
-                gemfile: gemfiles/rails_41.gemfile
+                gemfile: rails_41
               - ruby-version: "2.7"
-                gemfile: gemfiles/rails_41.gemfile
+                gemfile: rails_41
               - ruby-version: "2.7"
-                gemfile: gemfiles/rails_42.gemfile
+                gemfile: rails_42
   beeline:
     jobs:
       - lint:

data/.github/CODEOWNERS

@@ -2,4 +2,4 @@
 # This file controls who is tagged for review for any given pull request.
 
 # For anything not explicitly taken by someone else:
-* @honeycombio/integrations-team @martin308
+* @honeycombio/telemetry-team @martin308

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Let us know if something is not working as expected
+title: ''
+labels: 'type: bug'
+assignees: ''
+
+---
+
+<!---
+Thank you for taking the time to report bugs!
+
+We love code snippets and links to repositories that reproduce the issue, but understand if you don't have the time to add them. We'll do our best with the info you provide, and might ask follow-up questions.
+
+Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate.
+--->
+
+**Versions**
+
+- Ruby:
+- Beeline:
+
+**Steps to reproduce**
+
+1.
+
+**Additional context**

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,25 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'type: enhancement'
+assignees: ''
+
+---
+
+<!---
+Thank you for contributing an idea to this project!
+
+Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate.
+--->
+
+**Is your feature request related to a problem? Please describe.**
+
+
+**Describe the solution you'd like**
+
+
+**Describe alternatives you've considered**
+
+
+**Additional context**

data/.github/ISSUE_TEMPLATE/question-discussion.md

@@ -0,0 +1,14 @@
+---
+name: Question/Discussion
+about: General question about how things work or a discussion
+title: ''
+labels: 'type: discussion'
+assignees: ''
+
+---
+
+<!---
+Thank you for taking the time to say hello!
+
+Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate.
+--->

data/.github/ISSUE_TEMPLATE/security-vulnerability-report.md

@@ -0,0 +1,22 @@
+---
+name: Security vulnerability report
+about: Let us know if you discover a security vulnerability
+title: ''
+labels: 'type: security'
+assignees: ''
+
+---
+
+<!---
+Thank you for taking the time to report security vulnerabilities!
+
+Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate.
+--->
+**Versions**
+
+- Ruby:
+- Beeline:
+
+**Description**
+
+(Please include any relevant CVE advisory links)

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+<!--
+Thank you for contributing to the project! 💜
+Please make sure to:
+- Chat with us first if this is a big change
+  - Open a new issue (or comment on an existing one)
+  - We want to make sure you don't spend time implementing something we might have to say No to
+- Add unit tests
+- Mention any relevant issues in the PR description (e.g. "Fixes #123")
+
+Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate.
+-->
+
+## Which problem is this PR solving?
+
+-
+
+## Short description of the changes
+
+-
+

data/.github/dependabot.yml

@@ -9,5 +9,7 @@ updates:
     directory: "/gemfiles/" # Location of package manifests
     schedule:
       interval: "weekly"
+    labels:
+      - "type: dependencies"
     reviewers:
-      - "honeycombio/integrations-team"
+      - "honeycombio/telemetry-team"

data/.github/workflows/add-to-project.yml

@@ -0,0 +1,14 @@
+name: Apply project management flow
+on:
+  issues:
+    types: [opened]
+  pull_request_target:
+    types: [opened]
+jobs:
+  project-management:
+    runs-on: ubuntu-latest
+    name: Apply project management flow
+    steps:
+      - uses: honeycombio/oss-management-actions/projects@v1
+        with:
+          ghprojects-token: ${{ secrets.GHPROJECTS_TOKEN }}

data/.github/workflows/apply-labels.yml

@@ -1,16 +1,10 @@
 name: Apply project labels
-
-on:
-  - issues
-  - label
-  - pull_request_target
-  - pull_request
-
+on: [issues, pull_request, label]
 jobs:
   apply-labels:
     runs-on: ubuntu-latest
     name: Apply common project labels
     steps:
-      - uses: honeycombio/integrations-labels@v1
+      - uses: honeycombio/oss-management-actions/labels@v1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -5,6 +5,7 @@
 /doc/
 /pkg/
 /spec/reports/
+/test/reports/
 /tmp/
 .idea/
 

data/.rspec

@@ -1,3 +1,7 @@
+<% if ENV['CI'] %>
+--format RspecJunitFormatter
+--out test/reports/result.xml
+<% end %>
 --format documentation
 --color
 --require spec_helper

data/.rubocop.yml

@@ -27,6 +27,7 @@ Metrics/MethodLength:
 
 Metrics/LineLength:
   Exclude:
+    - spec/honeycomb/integrations/active_support_spec.rb
     - spec/support/event_data_shared_examples.rb
 
 Metrics/ParameterLists:

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.2

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 # beeline-ruby changelog
 
+## 2.7.0 2021-09-03
+
+### Improvements
+
+- add `error` and `error_detail` fields to spans from `ActiveSupport::Notification` events that contain an exception (#166) | [@leviwilson](https://github.com/leviwilson)
+
+### Maintenance
+
+- Add issue and PR templates (#165) | [@vreynolds](https://github.com/vreynolds)
+- Add OSS lifecycle badge (#164) | [@vreynolds](https://github.com/vreynolds)
+- Add community health files (#163) | [@vreynolds](https://github.com/vreynolds)
+
+## 2.6.0 2021-07-23
+
+### Added
+
+- Allow setting different notification handling logic for specific events (#152) | [@lirossarvet](https://github.com/lirossarvet)
+
+## 2.5.0 2021-07-16
+
+### Added
+
+- Allow backtrace to be sent with errors (#160) | [@lirossarvet](https://github.com/lirossarvet)
+
+### Maintenance
+
+- Updates Github Action Workflows (#159) | [@bdarfler](https://github.com/bdarfler)
+- Adds dependabot label (#158) | [@bdarfler](https://github.com/bdarfler)
+- Switches CODEOWNERS to telemetry-team (#157) | [@bdarfler](https://github.com/bdarfler)
+
+## 2.4.2 2021-06-25
+
+### Fixes
+
+- Update Rails middleware to get status code even on raised error. (#153) [@lirossarvet](https://github.com/lirossarvet)
+- Make Rails spec consistent with Honeycomb Railtie Initialization. (#154) [@robbkidd](https://github.com/robbkidd)
+- CI Improvements (#155) [@robbkidd](https://github.com/robbkidd)
+- Improve performance of Redis command serialization. (#146) [@ajvondrak](https://github.com/ajvondrak)
+
 ## 2.4.1 2021-06-01
 
 ### Fixes

data/CODE_OF_CONDUCT.md

@@ -1,74 +1,5 @@
-# Contributor Covenant Code of Conduct
+# Code of Conduct
 
-## Our Pledge
+This project has adopted the Honeycomb User Community Code of Conduct to clarify expected behavior in our community.
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers 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, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at me@martinholman.co.nz. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+https://www.honeycomb.io/honeycomb-user-community-code-of-conduct/

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing Guide
+
+Please see our [general guide for OSS lifecycle and practices.](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    honeycomb-beeline (2.4.1)
+    honeycomb-beeline (2.7.0)
       libhoney (~> 1.14, >= 1.14.2)
 
 GEM
@@ -40,7 +40,7 @@ GEM
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
       http-parser (~> 1.2.0)
-    http-cookie (1.0.3)
+    http-cookie (1.0.4)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
     http-parser (1.2.3)
@@ -81,6 +81,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (0.68.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -126,6 +128,7 @@ DEPENDENCIES
   pry-byebug (~> 3.6.0)
   rake
   rspec (~> 3.0)
+  rspec_junit_formatter
   rubocop (< 0.69)
   rubocop-performance (< 1.3.0)
   simplecov
@@ -133,4 +136,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.2.21

data/OSSMETADATA

@@ -0,0 +1 @@
+osslifecycle=maintenance

data/README.md

@@ -1,5 +1,6 @@
 # Honeycomb Beeline for Ruby
 
+[![OSS Lifecycle](https://img.shields.io/osslifecycle/honeycombio/beeline-ruby)](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md)
 [![Build Status](https://circleci.com/gh/honeycombio/beeline-ruby.svg?style=svg)](https://circleci.com/gh/honeycombio/beeline-ruby)
 [![Gem Version](https://badge.fury.io/rb/honeycomb-beeline.svg)](https://badge.fury.io/rb/honeycomb-beeline)
 [![codecov](https://codecov.io/gh/honeycombio/beeline-ruby/branch/main/graph/badge.svg)](https://codecov.io/gh/honeycombio/beeline-ruby)

data/RELEASING.md

@@ -0,0 +1,11 @@
+# Releasing
+
+- Update the version number in `lib/honeycomb/beeline/version`.
+- Run `bundle lock`.
+- Confirm the version number update appears in `Gemfile.lock`
+- Update `CHANGELOG.md` with the changes since the last release.
+- Commit changes, push, and open a release preparation pull request for review.
+- Once the pull request is merged, fetch the updated `main` branch.
+- Apply a tag for the new version on the merged commit: vX.Y.Z, for example v1.1.2.
+- Push the new version tag up to the project repository to kick off build and artifact publishing to GitHub and the Gems registry.
+- Publish the draft release in GitHub.

data/SECURITY.md

@@ -0,0 +1,3 @@
+# Reporting Security Issues
+
+If you discover a security vulnerability, please open an issue with label `type: security`.

data/SUPPORT.md

@@ -0,0 +1,3 @@
+# How to Get Help
+
+This project uses GitHub issues to track bugs, feature requests, and questions about using the project. Please search for existing issues before filing a new one.

data/honeycomb-beeline.gemspec

@@ -48,6 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-byebug", "~> 3.6.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter"
   spec.add_development_dependency "rubocop", "< 0.69"
   spec.add_development_dependency "rubocop-performance", "< 1.3.0"
   spec.add_development_dependency "simplecov"

data/lib/honeycomb/beeline/version.rb

@@ -3,7 +3,7 @@
 module Honeycomb
   module Beeline
     NAME = "honeycomb-beeline".freeze
-    VERSION = "2.4.1".freeze
+    VERSION = "2.7.0".freeze
     USER_AGENT_SUFFIX = "#{NAME}/#{VERSION}".freeze
   end
 end

data/lib/honeycomb/client.rb

@@ -38,6 +38,7 @@ module Honeycomb
         parser_hook: configuration.http_trace_parser_hook,
         propagation_hook: configuration.http_trace_propagation_hook,
       }
+      @error_backtrace_limit = configuration.error_backtrace_limit.to_i
 
       configuration.after_initialize(self)
 
@@ -47,16 +48,7 @@ module Honeycomb
     end
 
     def start_span(name:, serialized_trace: nil, **fields)
-      if context.current_trace.nil?
-        Trace.new(serialized_trace: serialized_trace,
-                  builder: libhoney.builder,
-                  context: context,
-                  **@additional_trace_options)
-      else
-        context.current_span.create_child
-      end
-
-      current_span = context.current_span
+      current_span = new_span_for_context(serialized_trace: serialized_trace)
 
       fields.each do |key, value|
         current_span.add_field(key, value)
@@ -69,8 +61,8 @@ module Honeycomb
       begin
         yield current_span
       rescue StandardError => e
-        current_span.add_field("error", e.class.name)
-        current_span.add_field("error_detail", e.message)
+        add_exception_data(current_span, e)
+
         raise e
       ensure
         current_span.send
@@ -99,6 +91,39 @@ module Honeycomb
 
     private
 
-    attr_reader :context
+    attr_reader :context, :error_backtrace_limit
+
+    def new_span_for_context(serialized_trace:)
+      if context.current_trace.nil?
+        Trace.new(
+          serialized_trace: serialized_trace,
+          builder: libhoney.builder,
+          context: context,
+          **@additional_trace_options,
+        )
+      else
+        context.current_span.create_child
+      end
+
+      context.current_span
+    end
+
+    def add_exception_data(span, exception)
+      span.add_field("error", exception.class.name)
+      span.add_field("error_detail", exception.message)
+
+      return if error_backtrace_limit <= 0
+
+      span.add_field(
+        "error_backtrace",
+        exception
+          .backtrace
+          .take(error_backtrace_limit)
+          .join("\n")
+          .encode("UTF-8", invalid: :replace, undef: :replace, replace: "�"),
+      )
+      span.add_field("error_backtrace_limit", error_backtrace_limit)
+      span.add_field("error_backtrace_total_length", exception.backtrace.length)
+    end
   end
 end

data/lib/honeycomb/configuration.rb

@@ -12,12 +12,14 @@ module Honeycomb
                   :debug
 
     attr_writer :service_name, :client, :host_name
+    attr_reader :error_backtrace_limit
 
     def initialize
       @write_key = ENV["HONEYCOMB_WRITEKEY"]
       @dataset = ENV["HONEYCOMB_DATASET"]
       @service_name = ENV["HONEYCOMB_SERVICE"]
       @debug = ENV.key?("HONEYCOMB_DEBUG")
+      @error_backtrace_limit = 0
       @client = nil
     end
 
@@ -25,6 +27,10 @@ module Honeycomb
       @service_name || dataset
     end
 
+    def error_backtrace_limit=(val)
+      @error_backtrace_limit = Integer(val)
+    end
+
     def client
       options = {}.tap do |o|
         o[:writekey] = write_key

data/lib/honeycomb/integrations/active_support.rb

@@ -8,12 +8,13 @@ module Honeycomb
     # Included in the configuration object to specify events that should be
     # subscribed to
     module Configuration
-      attr_accessor :notification_events
+      attr_writer :notification_events
 
       def after_initialize(client)
         super(client) if defined?(super)
 
-        events = notification_events || []
+        events = notification_events | active_support_handlers.keys
+
         ActiveSupport::Subscriber.new(client: client).tap do |sub|
           events.each do |event|
             sub.subscribe(event, &method(:handle_notification_event))
@@ -21,23 +22,44 @@ module Honeycomb
         end
       end
 
-      def on_notification_event(&hook)
-        if block_given?
-          @on_notification_event = hook
+      def on_notification_event(event_name = nil, &hook)
+        if event_name
+          active_support_handlers[event_name] = hook
         else
-          @on_notification_event
+          @default_handler = hook
         end
       end
 
       def handle_notification_event(name, span, payload)
-        if on_notification_event
-          on_notification_event.call(name, span, payload)
-        else
+        handler = active_support_handlers.fetch(name, default_handler)
+
+        handler.call(name, span, payload)
+      end
+
+      def active_support_handlers
+        @active_support_handlers ||= {}
+      end
+
+      def notification_events
+        @notification_events ||= []
+      end
+
+      def default_handler
+        @default_handler ||= lambda do |name, span, payload|
           payload.each do |key, value|
             # Make ActionController::Parameters parseable by libhoney.
             value = value.to_unsafe_hash if value.respond_to?(:to_unsafe_hash)
             span.add_field("#{name}.#{key}", value)
           end
+
+          # If the notification event has recorded an exception, add the
+          # Beeline's usual error fields to the span.
+          # * Uses the 2-element array on :exception in the event payload
+          #   to support Rails 4. If Rails 4 support is dropped, consider
+          #   the :exception_object added in Rails 5.
+          error, error_detail = payload[:exception]
+          span.add_field("error", error) if error
+          span.add_field("error_detail", error_detail) if error_detail
         end
       end
     end

data/lib/honeycomb/integrations/rack.rb

@@ -48,11 +48,12 @@ module Honeycomb
         span.add_field("request.secure", req.ssl?)
         span.add_field("request.xhr", req.xhr?)
 
-        status, headers, body = app.call(env)
-
-        add_package_information(env, &add_field)
-
-        extract_user_information(env, &add_field)
+        begin
+          status, headers, body = call_with_hook(env, span, &add_field)
+        ensure
+          add_package_information(env, &add_field)
+          extract_user_information(env, &add_field)
+        end
 
         span.add_field("response.status_code", status)
         span.add_field("response.content_type", headers["Content-Type"])
@@ -72,6 +73,12 @@ module Honeycomb
       end
     end
 
+    private
+
+    def call_with_hook(env, _span, &_add_field)
+      app.call(env)
+    end
+
     # Rack middleware
     class Middleware
       include Rack

data/lib/honeycomb/integrations/rails.rb

@@ -89,6 +89,16 @@ module Honeycomb
       include Rack
       include Warden
       include Rails
+
+      def call_with_hook(env, span, &_add_field)
+        super
+      rescue StandardError => e
+        wrapped = ActionDispatch::ExceptionWrapper.new(nil, e)
+
+        span.add_field "response.status_code", wrapped.status_code
+
+        raise e
+      end
     end
   end
 end

data/lib/honeycomb/integrations/redis.rb

@@ -187,16 +187,6 @@ module Honeycomb
         args.map! { "[sanitized]" }
       end
 
-      def prettify(arg)
-        quotes = false
-        pretty = "".dup
-        arg.to_s.each_char do |c|
-          quotes ||= needs_quotes?(c)
-          pretty << escape(c)
-        end
-        quotes ? "\"#{pretty}\"" : pretty
-      end
-
       # This aims to replicate the algorithms used by redis-cli.
       #
       # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L940-L1067
@@ -204,54 +194,15 @@ module Honeycomb
       #
       # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L878-L907
       #   The redis-cli printing algorithm
-      def escape(char)
-        return escape_with_backslash(char) if escape_with_backslash?(char)
-        return escape_with_hex_codes(char) if escape_with_hex_codes?(char)
-
-        char
-      end
-
-      # A lookup table for backslash-escaped characters.
-      #
-      # This is used by {#escape_with_backslash?} and {#escape_with_backslash}
-      # to replicate the hard-coded `case` statements in redis-cli. As of this
-      # writing, Redis recognizes a handful of standard C escape sequences,
-      # like "\n" for newlines.
-      #
-      # Because {#prettify} will output double quoted strings if any escaping
-      # is needed, this table must additionally consider the double-quote to be
-      # a backslash-escaped character. For example, instead of generating
-      #
-      #   '"hello"'
-      #
-      # we'll generate
-      #
-      #   "\"hello\""
-      #
-      # even though redis-cli would technically recognize the single-quoted
-      # version.
-      #
-      # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L888-L896
-      #   The redis-cli algorithm for outputting standard escape sequences
-      BACKSLASHES = {
-        "\\" => "\\\\",
-        '"' => '\\"',
-        "\n" => "\\n",
-        "\r" => "\\r",
-        "\t" => "\\t",
-        "\a" => "\\a",
-        "\b" => "\\b",
-      }.freeze
-
-      def escape_with_backslash?(char)
-        BACKSLASHES.key?(char)
-      end
-
-      def escape_with_backslash(char)
-        BACKSLASHES.fetch(char, char)
+      def prettify(arg)
+        pretty = arg.to_s.dup
+        pretty.encode!("UTF-8", "binary", fallback: ->(c) { hex(c) })
+        pretty.gsub!(NEEDS_BACKSLASH, BACKSLASH)
+        pretty.gsub!(NEEDS_HEX) { |c| hex(c) }
+        pretty =~ NEEDS_QUOTES ? "\"#{pretty}\"" : pretty
       end
 
-      # Do we need to hex-encode this character?
+      # A regular expression matching characters that need to be hex-encoded.
       #
       # This replicates the C isprint() function that redis-cli uses to decide
       # whether to escape a character in hexadecimal notation, "\xhh". Any
@@ -287,18 +238,95 @@ module Honeycomb
       # escape it.
       #
       # What's more, Ruby's Regexp#=~ method will blow up if the string does
-      # not have a valid encoding (e.g., in UTF-8). In this case, though,
-      # {#escape_with_hex_codes} can still convert the bytes that make up the
-      # invalid character into a hex code. So we preemptively check for
-      # invalidly-encoded characters before testing the above match.
+      # not have a valid encoding (e.g., in UTF-8). We handle this case
+      # separately, though, using String#encode! with a :fallback option to
+      # hex-encode invalid UTF-8 byte sequences with {#hex}.
       #
       # @see https://ruby-doc.org/core-2.6.5/Regexp.html
       # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L878-L880
       # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L898-L901
       # @see https://www.justinweiss.com/articles/3-steps-to-fix-encoding-problems-in-ruby/
-      def escape_with_hex_codes?(char)
-        !char.valid_encoding? || char =~ /[^[:print:]&&[:ascii:]]/
-      end
+      NEEDS_HEX = /[^[:print:]&&[:ascii:]]/.freeze
+
+      # A regular expression for characters that need to be backslash-escaped.
+      #
+      # Any match of this regexp will be substituted according to the
+      # {BACKSLASH} table. This includes standard C escape sequences (newlines,
+      # tabs, etc) as well as a couple special considerations:
+      #
+      # 1. Because {#prettify} will output double quoted strings if any
+      #    escaping is needed, we must match double quotes (") so they'll be
+      #    replaced by escaped quotes (\").
+      #
+      # 2. Backslashes themselves get backslash-escaped, so \ becomes \\.
+      #    However, strings with invalid UTF-8 encoding will blow up when we
+      #    try to use String#gsub!, so {#prettify} must first use
+      #    String#encode! to scrub out invalid characters. It does this by
+      #    replacing invalid bytes with hex-encoded escape sequences using
+      #    {#hex}. This will insert sequences like \xhh, which contains a
+      #    backslash that we *don't* want to escape.
+      #
+      #    Unfortunately, this regexp can't really distinguish between
+      #    backslashes in the original input vs backslashes resulting from the
+      #    UTF-8 fallback. We make an effort by using a negative lookahead.
+      #    That way, only backslashes that *aren't* followed by x + hex digit +
+      #    hex digit will be escaped.
+      NEEDS_BACKSLASH = /["\n\r\t\a\b]|\\(?!x\h\h)/.freeze
+
+      # A lookup table for backslash-escaped characters.
+      #
+      # This is used by {#prettify} to replicate the hard-coded `case`
+      # statements in redis-cli. As of this writing, Redis recognizes a handful
+      # of standard C escape sequences, like "\n" for newlines.
+      #
+      # Because {#prettify} will output double quoted strings if any escaping
+      # is needed, this table must additionally consider the double-quote to be
+      # a backslash-escaped character. For example, instead of generating
+      #
+      #   '"hello"'
+      #
+      # we'll generate
+      #
+      #   "\"hello\""
+      #
+      # even though redis-cli would technically recognize the single-quoted
+      # version.
+      #
+      # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L888-L896
+      #   The redis-cli algorithm for outputting standard escape sequences
+      BACKSLASH = {
+        "\\" => "\\\\",
+        '"' => '\\"',
+        "\n" => "\\n",
+        "\r" => "\\r",
+        "\t" => "\\t",
+        "\a" => "\\a",
+        "\b" => "\\b",
+      }.freeze
+
+      # If the final escaped string needs quotes, it will match this regexp.
+      #
+      # The overall string returned by {#prettify} should only be quoted if at
+      # least one of the following holds:
+      #
+      # 1. The string contains an escape sequence, broadly demarcated by a
+      #    backslash. This includes standard escape sequences like "\n" and
+      #    "\t" as well as hex-encoded bytes using the "\x" escape sequence.
+      #    Since {#prettify} uses double quotes on its output string, we must
+      #    also force quotes if the string itself contains a literal
+      #    double quote. This double quote behavior is handled tacitly by the
+      #    {NEEDS_BACKSLASH} + {BACKSLASH} replacement.
+      #
+      # 2. The string contains a single quote. Since redis-cli recognizes
+      #    single-quoted strings, we want to wrap the {#prettify} output in
+      #    double quotes so that the literal single quote character isn't
+      #    mistaken as the delimiter of a new string.
+      #
+      # 3. The string contains any whitespace characters. If the {#prettify}
+      #    output weren't wrapped in quotes, whitespace would act as a
+      #    separator between arguments to the Redis command. To group things
+      #    together, we need to quote the string.
+      NEEDS_QUOTES = /[\\'\s]/.freeze
 
       # Hex-encodes a (presumably non-printable or non-ASCII) character.
       #
@@ -326,38 +354,9 @@ module Honeycomb
       # @see https://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap07.html
       # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L878-L880
       # @see https://github.com/antirez/redis/blob/0f026af185e918a9773148f6ceaa1b084662be88/src/sds.c#L898-L901
-      def escape_with_hex_codes(char)
+      def hex(char)
         char.bytes.map { |b| Kernel.format("\\x%02x", b) }.join
       end
-
-      def escape?(char)
-        escape_with_backslash?(char) || escape_with_hex_codes?(char)
-      end
-
-      # Should this character cause {#prettify} to wrap its output in quotes?
-      #
-      # The overall string returned by {#prettify} should only be quoted if at
-      # least one of the following holds:
-      #
-      # 1. The string contains a character that needs to be escaped. This
-      #    includes standard backslash escape sequences (like "\n" and "\t") as
-      #    well as hex-encoded bytes using the "\x" escape sequence. Since
-      #    {#prettify} uses double quotes on its output string, we must also
-      #    force quotes if the string itself contains a literal double quote.
-      #    This double quote behavior is handled tacitly by {BACKSLASHES}.
-      #
-      # 2. The string contains a single quote. Since redis-cli recognizes
-      #    single-quoted strings, we want to wrap the {#prettify} output in
-      #    double quotes so that the literal single quote character isn't
-      #    mistaken as the delimiter of a new string.
-      #
-      # 3. The string contains any whitespace characters. If the {#prettify}
-      #    output weren't wrapped in quotes, whitespace would act as a
-      #    separator between arguments to the Redis command. To group things
-      #    together, we need to quote the string.
-      def needs_quotes?(char)
-        escape?(char) || char == "'" || char =~ /\s/
-      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeycomb-beeline
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Martin Holman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -156,6 +156,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -238,22 +252,34 @@ files:
 - ".circleci/setup-rubygems.sh"
 - ".editorconfig"
 - ".github/CODEOWNERS"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/ISSUE_TEMPLATE/question-discussion.md"
+- ".github/ISSUE_TEMPLATE/security-vulnerability-report.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/dependabot.yml"
+- ".github/workflows/add-to-project.yml"
 - ".github/workflows/apply-labels.yml"
 - ".gitignore"
 - ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".tool-versions"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - CONTRIBUTORS.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- OSSMETADATA
 - README.md
+- RELEASING.md
 - Rakefile
+- SECURITY.md
+- SUPPORT.md
 - UPGRADING.md
 - bin/console
 - bin/setup