honeycomb-beeline 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ae074f65cd2b6319b74e07b06148e9e2cd446bfd3fc7c2c686c9ab4702550a4
-  data.tar.gz: a7c934d59de13e4099636470fb9660520478bbe56c38c5eb42c69839cb6a6f4a
+  metadata.gz: 97016b5bcb57ce01fa980218fac7d8b71b3b145dec5ff30ad5ab9693d070d665
+  data.tar.gz: df32abbd87b653800ec3ebe2693cc3008593e307ee70ef1f5ab9333f139a96ba
 SHA512:
-  metadata.gz: 12c63d47f117a7fae5771b504ff58191627824618c7127257ca29f9c0e1de9cee3e140184bf3e04935846a2a9cef6768245ce6a89d540a1e48b8ddd1eb923704
-  data.tar.gz: 599d93dc3ca17e34b4828cf557aa98a4b697a26cfffa8957a4b25997c37d7967ab2753bcc01ced943db8e74a52f6dff0f93c0a51ee59d28b0fbc9ad1f144a30b
+  metadata.gz: 51757f1553274cda4c354d16f50998745c41b0f89f4d27d763d8e81f2fe9142a1f491ea3208eb73d26211a81d5c2f2f15e282b9555fd4416d3a20f8cb3373f23
+  data.tar.gz: 0ef3666a518f2e965972967af8fb13d7597bd132026bc6ed8580b93458f0f1cf227a6ab05204dbc31f34da520f25e9f97201d3a9347173da4e7cdece0b6875b0

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/.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/CHANGELOG.md

@@ -1,5 +1,17 @@
 # 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

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.6.0)
+    honeycomb-beeline (2.7.0)
       libhoney (~> 1.14, >= 1.14.2)
 
 GEM

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/lib/honeycomb/beeline/version.rb

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

data/lib/honeycomb/integrations/active_support.rb

@@ -51,6 +51,15 @@ module Honeycomb
             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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeycomb-beeline
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Martin Holman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-23 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -252,6 +252,11 @@ 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"
@@ -264,12 +269,17 @@ files:
 - 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