sentry-lambda 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e61cf6580a8711e896c89807873d6fc321de3daffc3f1e5dfc72347bd3287d78
+  data.tar.gz: fde79717cd1ffea4730d8cd3eac687a35222674b46f64401a3b687ef70f91de0
+SHA512:
+  metadata.gz: 43ec6a0c8600129794fa37558d99512af9b84cf7546c2a565862b11d5b8e0515f1b2fe8c37c8a908ea26c49a203cf7edf8ce6f999915df79eacddc6d389ad6f3
+  data.tar.gz: 03e62de3dbbbba48b674fbf27a368b35339f43f3c513235bb70ed87c224e46119b32b1a4b2734a6f8c470f6980e472ad3708423dd96c21c3b010a08e62dc77ed

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 st0012
+
+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,68 @@
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br>
+</p>
+
+# sentry-lambda, the AWS Lambda integration for Sentry's Ruby client
+
+---
+
+
+
+The official Ruby-language client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
+
+
+## Requirements
+
+Ruby version >= 2.5
+
+## Getting Started
+
+### Install
+
+```ruby
+gem "sentry-lambda"
+```
+
+### Usage
+```ruby
+def lambda_handler(event:, context:)
+  Sentry::Lambda.wrap_handler(event: event, context: context) do
+    # Function logic here....
+  end
+end
+```
+#### Timeout Warnings
+It can be important to know when a function is about to time out and to have sentry-level
+details when this occurs. In order to give a Lambda Function time to do so, a warning message can
+be enabled with `capture_timeout_warning: true` like so:
+```ruby
+def lambda_handler(event:, context:)
+  Sentry::Lambda.wrap_handler(event: event, context: context, capture_timeout_warning: true) do
+    # Function logic here....
+  end
+end
+```
+
+### Integration Specific Configuration
+
+This gem has a few Lambda-specific configuration options.
+
+Using an AWS CloudWatch LogGroup Trigger. This approach requires having a separate Lambda Function
+which is triggered by this log. Simply outputting the `Sentry::Event` data as a log allows for the
+event to be captured synchronously elsewhere and also gives the current Lambda more time to finish.
+```ruby
+Sentry.init do |config|
+  # Put a log which will be caught by Trigger `?"SENTRY Event" ?"Task timed out after"`
+  config.async = lambda do |event, hint|
+    puts "SENTRY Event: #{event.to_json} Hint: #{hint.to_json}"
+  end
+end
+```
+
+Sending to Sentry Synchronously:
+```ruby
+Sentry.init { |config| config.background_worker_threads = 0 } # all events will be sent synchronously
+```

data/lib/sentry/lambda/capture_exceptions.rb

@@ -0,0 +1,114 @@
+module Sentry
+  module Lambda
+    class CaptureExceptions
+      TIMEOUT_WARNING_BUFFER = 1500 # Buffer time required to send timeout warning to Sentry
+
+      def initialize(aws_event:, aws_context:, capture_timeout_warning: false)
+        @aws_event = aws_event
+        @aws_context = aws_context
+        @capture_timeout_warning = capture_timeout_warning
+      end
+
+      def call(&block)
+        return yield unless Sentry.initialized?
+
+        if @capture_timeout_warning && (@aws_context.get_remaining_time_in_millis > TIMEOUT_WARNING_BUFFER)
+          Thread.new do
+            configured_timeout_seconds = @aws_context.get_remaining_time_in_millis / 1000.0
+            sleep_timeout_seconds = ((@aws_context.get_remaining_time_in_millis - TIMEOUT_WARNING_BUFFER) / 1000.0)
+
+            timeout_message = "WARNING : Function is expected to get timed out. "\
+                              "Configured timeout duration = #{configured_timeout_seconds.round} seconds."
+
+            sleep(sleep_timeout_seconds)
+            Sentry.capture_message(timeout_message)
+          end
+        end
+
+        # make sure the current thread has a clean hub
+        Sentry.clone_hub_to_current_thread
+
+        Sentry.with_scope do |scope|
+          start_time = Time.now.utc
+          initial_remaining_time_in_milis = @aws_context.get_remaining_time_in_millis
+          execution_expiration_time = Time.now.utc + ((initial_remaining_time_in_milis || 0)/1000.0)
+
+          scope.clear_breadcrumbs
+          scope.set_transaction_name(@aws_context.function_name)
+
+          scope.add_event_processor do |event, hint|
+            event_time = event.timestamp.is_a?(Float) ? Time.at(event.timestamp) : Time.parse(event.timestamp)
+            remaining_time_in_millis = ((execution_expiration_time - event_time) * 1000).round
+            execution_duration_in_millis = ((event_time - start_time) * 1000).round
+            event.extra = event.extra.merge(
+              lambda: {
+                function_name: @aws_context.function_name,
+                function_version: @aws_context.function_version,
+                invoked_function_arn: @aws_context.invoked_function_arn,
+                aws_request_id: @aws_context.aws_request_id,
+                execution_duration_in_millis: execution_duration_in_millis,
+                remaining_time_in_millis: remaining_time_in_millis
+              }
+            )
+
+            event.extra = event.extra.merge(
+              "cloudwatch logs": {
+                url: _get_cloudwatch_logs_url(@aws_context, start_time),
+                log_group: @aws_context.log_group_name,
+                log_stream: @aws_context.log_stream_name
+              }
+            )
+
+            event
+          end
+
+          transaction = start_transaction(@aws_event, @aws_context, scope.transaction_name)
+          scope.set_span(transaction) if transaction
+
+          begin
+            response = yield
+          rescue Sentry::Error
+            finish_transaction(transaction, 500)
+            raise # Don't capture Sentry errors
+          rescue Exception => e
+            capture_exception(e)
+            finish_transaction(transaction, 500)
+            raise
+          end
+
+          status_code = response&.dig(:statusCode) || response&.dig('statusCode')
+          finish_transaction(transaction, status_code)
+
+          response
+        end
+      end
+
+      def start_transaction(event, context, transaction_name)
+        sentry_trace = event["HTTP_SENTRY_TRACE"]
+        options = { name: transaction_name, op: 'serverless.function' }
+        transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, **options) if sentry_trace
+        Sentry.start_transaction(transaction: transaction, **options)
+      end
+
+      def finish_transaction(transaction, status_code)
+        return unless transaction
+
+        transaction.set_http_status(status_code)
+        transaction.finish
+      end
+
+      def capture_exception(exception)
+        Sentry.capture_exception(exception)
+      end
+
+      def _get_cloudwatch_logs_url(aws_context, start_time)
+        formatstring = "%Y-%m-%dT%H:%M:%SZ"
+        region = ENV['AWS_REGION']
+
+        "https://console.aws.amazon.com/cloudwatch/home?region=#{region}" \
+        "#logEventViewer:group=#{aws_context.log_group_name};stream=#{aws_context.log_stream_name}" \
+        ";start=#{start_time.strftime(formatstring)};end=#{(Time.now.utc + 2).strftime(formatstring)}"
+      end
+    end
+  end
+end

data/lib/sentry/lambda/version.rb

@@ -0,0 +1,5 @@
+module Sentry
+  module Lambda
+    VERSION = "0.1.1"
+  end
+end

data/lib/sentry/lambda.rb

@@ -0,0 +1,20 @@
+require "sentry-ruby"
+require "sentry/integrable"
+require "sentry/lambda/capture_exceptions"
+
+module Sentry
+  module Lambda
+    extend Integrable
+    register_integration name: 'lambda', version: Sentry::Lambda::VERSION
+
+    def self.wrap_handler(event:, context:, capture_timeout_warning: false)
+      CaptureExceptions.new(
+        aws_event: event,
+        aws_context: context,
+        capture_timeout_warning: capture_timeout_warning
+      ).call do
+        yield
+      end
+    end
+  end
+end

data/lib/sentry-lambda.rb

@@ -0,0 +1,2 @@
+require "sentry/lambda/version"
+require "sentry/lambda"

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: sentry-lambda
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sentry Team
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.0.pre.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.0.pre.beta
+description: A gem that provides AWS Lambda integration for the Sentry error logger
+email: accounts@sentry.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.md
+- lib/sentry-lambda.rb
+- lib/sentry/lambda.rb
+- lib/sentry/lambda/capture_exceptions.rb
+- lib/sentry/lambda/version.rb
+homepage: https://github.com/getsentry/sentry-ruby
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/getsentry/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/sentry-lambda/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A gem that provides AWS Lambda integration for the Sentry error logger
+test_files: []