datadog_notifier 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14ff80cbc6ef96b9c11645c8dcc1b677152a1037324abdac0419986a6fe46101
+  data.tar.gz: 3e7c6ec0b41bd032c2e938cf513315b6c0b196539586d73e67de74e10bfd3521
+SHA512:
+  metadata.gz: 8cf93a28542fd650ec19d3cd7c599c15a476a66311539cd5f3e8e57e972c7e363575538c36ba2afb662c0093960061e9f080c0fbd3e27b3c7288843d81f75c22
+  data.tar.gz: 185a201ed12dea3a78e88ae7bf8680dcd2bd57f2b6a6bad4d703b2eb6740d657b108847e64ab409e98f1d6cca4940a18c1218fc4066802821ce97ce82882439e

data/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish Datadog Notifier Gem
+
+on:
+  push:
+    tags:
+      - 'v*' # Trigger on version tags, e.g., v1.0.0
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+
+      - name: Install dependencies
+        run: gem install bundler && bundle install --jobs 4 --retry 3
+
+      - name: Publish gem
+        if: github.ref == 'refs/tags/v*'
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+        run: |
+          gem build datadog_notifier.gemspec
+          gem push datadog_notifier-*.gem

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Evan McDaniel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Datadog Notifier
+### Send Custom Errors from Rails application to Dadatdog Error Tracking Dashboard
+
+# Steps
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'datadog_notifier'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install datadog_notifier
+
+### Dependency
+* [Datadog](https://github.com/DataDog/dd-trace-rb) must be integrated in the project before we use this gem
+
+# Quick Use
+## Send notification to datadog(Traces to add errors in Datadog)
+```DatadogNotifier.notify(exception, payload_json)```
+
+Here `exception` is the error same as we send for Airbrake i.e `ErrorTracking.notify(exception)` and `payload_json` is an optional parameter where we can pass the payload(json value) to share extra details in datadog error tracking
+
+## Error Tracking Dashboard link
+- [Error Tracking](https://app.datadoghq.com/apm/error-tracking)
+- We can filter out these custom errors using `@custom_dd_notifier:true` as we are passing this custom_dd_notifier while sending custom errors to datadog.
+
+
+## Replace existing custom ErrorTracking with DatadogNotifier
+We have kept DatadogNotifier signature same as other ErrorTracking services. This will help us to just search and replace all occurences.
+Just replace **ErrorTracking.notify** with **DatadogNotifier.notify**
+```
+Before: ErrorTracking.notify("ProductErrorForm: Error while scraping new product", error_params_json)
+After: DatadogNotifier.notify("ProductErrorForm: Error while scraping new product", error_params_json)
+```
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/patterninc/datadog_notifier
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/datadog_notifier.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'datadog_notifier'
+require "datadog_notifier/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'datadog_notifier'
+  spec.version       = DatadogNotifier::VERSION
+  spec.authors       = ['Patterninc']
+  spec.email         = ['amol.udage@pattern.com']
+  spec.summary       = 'Datadog notifier to send custom errors with ddtrace'
+  spec.description   = 'Datadog notifier to send custom errors in Datadog error tracking dashboard'
+  spec.homepage      = 'https://github.com/patterninc/datadog_notifier'
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_development_dependency "bundler", "~> 2.2.3"
+  spec.add_development_dependency "rake", "~> 13.0"
+ 
+  spec.add_dependency 'ddtrace', '>= 1.13.0'
+
+  # If needed, add development dependencies
+  spec.add_development_dependency 'rspec'
+  # ... (other development dependencies)
+end

data/lib/datadog_notifier/version.rb

@@ -0,0 +1,3 @@
+class DatadogNotifier
+  VERSION = "1.0.2"
+end

data/lib/datadog_notifier.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'ddtrace'
+require 'datadog_notifier_exception'
+require "datadog_notifier/version"
+
+# DatadogNotifier for custom error notification to datadog
+class DatadogNotifier
+  def self.notify(exception, payload = {})
+    root_span = find_root_span(Datadog::Tracing.active_span)
+    if exception.is_a?(String)
+      exception = DatadogNotifierException.new exception
+      exception.set_backtrace(payload.inspect)
+    end
+    root_span.set_error(exception)
+    root_span.set_tag('custom_dd_notifier', true)
+    root_span.set_tag('payload', payload.to_json) if payload.present?
+  end
+
+  def self.find_root_span(child_span)
+    current_span = child_span
+    current_span = current_span.send(:parent) while current_span.send(:parent)
+    current_span
+  end
+end

data/lib/datadog_notifier_exception.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class DatadogNotifierException < StandardError
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: datadog_notifier
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Patterninc
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: ddtrace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: Datadog notifier to send custom errors in Datadog error tracking dashboard
+email:
+- amol.udage@pattern.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/publish.yml"
+- LICENSE.txt
+- README.md
+- datadog_notifier.gemspec
+- lib/datadog_notifier.rb
+- lib/datadog_notifier/version.rb
+- lib/datadog_notifier_exception.rb
+homepage: https://github.com/patterninc/datadog_notifier
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Datadog notifier to send custom errors with ddtrace
+test_files: []