bugsnag_performance 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9bc8d797c0a3b633e73e88a5d4f399df04bb2fb8063b1a11c42bec974dfec5c
-  data.tar.gz: 4554ce3963bc8b4861d586c539b7186ab4550a871586cbe7ad646af5b3b35cbc
+  metadata.gz: 7209ef5a16d1a1f40cc5100f44f935f4deb13ada6eb5de82c785b823ef7c975a
+  data.tar.gz: 81d7fc68ae82ccca8d7aa1ca34fa15abd59fe72f9f17775a4100e11c4256ac6a
 SHA512:
-  metadata.gz: 1467c6a19cf3766d3e5794714c2ad36f145c00b4a23b66a55c1375f72aafd9168c70495a2b57e053f28d7a9d9029825e2ea35051e615bf5c5fa5fbd11298e6be
-  data.tar.gz: c6fcb31b7d1ac9cba893c8600a0624662a15e64b6e82ba822da113388238c8772d85e0a585ee50683906f99bbb3b596bdcf8501f1b6628c915f9ba2922585a5c
+  metadata.gz: 2348391589b8bbce569efbeaff908dba3112364ef8f76c32197f00a9b095d876b52cba246e6e4c25ffd92e4b9856b2be234c9c17ecd04d54a9f252ac8aec68d5
+  data.tar.gz: 87594a7d40c5249cc60f28db2699df868d1f21adbd67d27647a070fa323957f0c19710fae24af4e6c59390726168a8ca84cdd62358bc3da5568a9498ee80cabb

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+## 1.0.0 (2024-12-09)
+
+### Enhancements
+
+* Consolidate Ruby/Ruby-Perf environment variables.
+[#45](https://github.com/bugsnag/bugsnag-ruby-performance/pull/45)
+
+* Restore Bugsnag-Sent-At header.
+[#46](https://github.com/bugsnag/bugsnag-ruby-performance/pull/46)
+
 ## 0.3.0 (2024-11-13)
 
 ### Enhancements

data/CODEOWNERS

@@ -0,0 +1 @@
+lib/       @imjoehaines @DariaKunoichi

data/README.md

@@ -9,9 +9,9 @@
 </div>
 
 [![Documentation](https://img.shields.io/badge/documentation-latest-blue.svg)](https://docs.bugsnag.com/performance/ruby/)
-[![Build status](https://github.com/bugsnag/bugsnag-ruby-performance/actions/workflows/maze-runner.yml/badge.svg?branch=main)](https://github.com/bugsnag/bugsnag-ruby-performance/actions/workflows/maze-runner.yml)
+[![Build status](https://github.com/bugsnag/bugsnag-ruby-performance/actions/workflows/maze-runner.yml/badge.svg?branch=next)](https://github.com/bugsnag/bugsnag-ruby-performance/actions/workflows/maze-runner.yml)
 
-Convenience SDK for using the [Ruby Otel SDK](https://github.com/open-telemetry/opentelemetry-ruby) with BugSnag.
+Convenience SDK for using the [Ruby OpenTelemetry SDK](https://github.com/open-telemetry/opentelemetry-ruby) with BugSnag.
 
 ## Features
 
@@ -30,4 +30,4 @@ For integration instructions, see our online docs: [docs.bugsnag.com/performance
 
 ## License
 
-The BugSnag Ruby performance SDK is free software released under the MIT License. See [LICENSE.txt](LICENSE.txt) for details.
+The BugSnag Ruby Performance SDK is free software released under the MIT License. See [LICENSE.txt](LICENSE.txt) for details.

data/SECURITY.md

@@ -0,0 +1,11 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x     | Yes                |
+
+## Reporting a Vulnerability
+
+If you find a vulnerability in this SDK, please report it to our [Support team](mailto:support@bugsnag.com) for review.

data/lib/bugsnag_performance/configuration.rb

@@ -49,6 +49,14 @@ module BugsnagPerformance
     # @return [Array<String>, nil]
     attr_accessor :enabled_release_stages
 
+    # The name of the service that is being traced
+    #
+    # If not set, this will default to the Open Telemetry SDK service name
+    # or the value set by the "OTEL_SERVICE_NAME" environment variable
+    #
+    # @return [String]
+    attr_accessor :service_name
+
     attr_writer :endpoint
 
     def initialize(errors_configuration)
@@ -59,6 +67,11 @@ module BugsnagPerformance
       @app_version = fetch(errors_configuration, :app_version, env: "BUGSNAG_PERFORMANCE_APP_VERSION")
       @release_stage = fetch(errors_configuration, :release_stage, env: "BUGSNAG_PERFORMANCE_RELEASE_STAGE", default: "production")
 
+      service_env = ENV["BUGSNAG_PERFORMANCE_SERVICE_NAME"]
+      @service_name = service_env unless service_env.nil?
+      endpoint_env = ENV["BUGSNAG_PERFORMANCE_ENDPOINT"]
+      @endpoint = endpoint_env unless endpoint_env.nil?
+
       @enabled_release_stages = fetch(errors_configuration, :enabled_release_stages, env: "BUGSNAG_PERFORMANCE_ENABLED_RELEASE_STAGES")
 
       # transform enabled release stages into an array if we read its value from

data/lib/bugsnag_performance/internal/configuration_validator.rb

@@ -15,6 +15,7 @@ module BugsnagPerformance
         validate_api_key
         validate_string(:app_version, optional: true)
         validate_string(:release_stage, optional: true)
+        validate_string(:service_name, optional: true)
         validate_array(:enabled_release_stages, "non-empty strings", optional: true, &method(:valid_string?))
         valid_endpoint = validate_endpoint
 

data/lib/bugsnag_performance/internal/delivery.rb

@@ -17,8 +17,7 @@ module BugsnagPerformance
       def deliver(headers, body)
         headers = headers.merge(
           @common_headers,
-        # TODO - can be restored after https://smartbear.atlassian.net/browse/PIPE-7498
-        #  { "Bugsnag-Sent-At" => Time.now.utc.iso8601(3) },
+          { "Bugsnag-Sent-At" => Time.now.utc.iso8601(3) },
         )
 
         raw_response = OpenTelemetry::Common::Utilities.untraced do

data/lib/bugsnag_performance/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module BugsnagPerformance
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
   SDK_NAME = "Ruby Bugsnag Performance SDK"
 end

data/lib/bugsnag_performance.rb

@@ -83,6 +83,11 @@ module BugsnagPerformance
         otel_configurator.service_version = app_version
       end
 
+      # set the service name if explicitly set by the user
+      if configuration.service_name != nil && configuration.service_name != ""
+        otel_configurator.service_name = configuration.service_name
+      end
+
       otel_configurator.resource = OpenTelemetry::SDK::Resources::Resource.create(
         {
           OpenTelemetry::SemanticConventions::Resource::DEPLOYMENT_ENVIRONMENT => configuration.release_stage,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag_performance
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - BugSnag
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -89,9 +89,11 @@ extra_rdoc_files: []
 files:
 - ".yardopts"
 - CHANGELOG.md
+- CODEOWNERS
 - CONTRIBUTING.md
 - LICENSE.txt
 - README.md
+- SECURITY.md
 - TESTING.md
 - bugsnag-performance.gemspec
 - lib/bugsnag_performance.rb
@@ -120,7 +122,7 @@ metadata:
   homepage_uri: https://www.bugsnag.com
   source_code_uri: https://github.com/bugsnag/bugsnag-ruby-performance
   bug_tracker_uri: https://github.com/bugsnag/bugsnag-ruby-performance/issues
-  changelog_uri: https://github.com/bugsnag/bugsnag-ruby-performance/blob/v0.3.0/CHANGELOG.md
+  changelog_uri: https://github.com/bugsnag/bugsnag-ruby-performance/blob/v1.0.0/CHANGELOG.md
   documentation_uri: https://docs.bugsnag.com/performance/integration-guides/ruby/
   rubygems_mfa_required: 'true'
 post_install_message: