blipit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f949d1c6a29c26aea5036c4cb3298cd599f14f2ca5019946e72003fb9a53e87
+  data.tar.gz: b1e38bd23ac52d4fe74f5ec0b44e3b5c2f0d6b30a5ad6e092af833f49bbc006c
+SHA512:
+  metadata.gz: 601637f0986ab8b4da74b5d6c7b656da8cb9c47193da167510c587185d66fa138610db8273fdf13e39bf886e5392c28ddd55f6fdfe21b32786c13d6ce8d5e7f0
+  data.tar.gz: 4ec6d0bafe9bd2dc3c186b43ee4a9c63becbe4351bf5bd30cd447b8abc5f94224d2cba1fe6812bb188aa32ede4f0e246a99459b39a0e2b4847e0df69514153a9

data/README.md

@@ -0,0 +1,51 @@
+# blipit
+
+Blipit error monitoring for Ruby. Know your app broke before your users tell you.
+
+## Install
+
+```sh
+gem install blipit
+```
+
+or add `gem "blipit"` to your Gemfile.
+
+## Quick start
+
+Call `Blipit.init` once at startup, before the app starts serving requests.
+
+```ruby
+require "blipit"
+
+Blipit.init(key: "<public key>", project: <project id>, environment: "production", release: "myapp@1.4.2")
+```
+
+Both values are on the project's Keys page at app.blipit.io. Unhandled exceptions are reported on their own.
+
+## Rails
+
+Put the `Blipit.init` call in `config/initializers/blipit.rb`. If you want the Rails integration (controller and job context, ActiveRecord breadcrumbs), add `gem "sentry-rails"` instead and set `config.dsn = "https://<public key>@in.blipit.io/<project id>"` in its initializer.
+
+## Manual capture
+
+```ruby
+Blipit.capture_exception(error)
+Blipit.capture_message("cache miss rate above 50%", level: :warning)
+Blipit.set_user(id: "42", email: "ana@example.com")
+Blipit.set_tag("region", "ap-southeast-1")
+Blipit.add_breadcrumb("cache cleared", category: "cache")
+```
+
+## Login attempts
+
+```ruby
+Blipit.capture_security("login_failed", email, outcome: "wrong password", ip: request.remote_ip, user_agent: request.user_agent)
+```
+
+`kind` is one of `login_failed`, `login_blocked`, `login_succeeded`, `password_reset` or any short name you choose. Failed and blocked logins are reported as warnings.
+
+## Performance
+
+Pass `traces_sample_rate: 0.2` to `init` and requests show up on the Performance page.
+
+Docs: https://docs.blipit.io/ruby

data/lib/blipit/version.rb

@@ -0,0 +1,3 @@
+module Blipit
+  VERSION = "0.1.0"
+end

data/lib/blipit.rb

@@ -0,0 +1,80 @@
+require "sentry-ruby"
+require_relative "blipit/version"
+
+module Blipit
+  DEFAULT_ENDPOINT = "https://in.blipit.io"
+  WARNING_KINDS = %w[login_failed login_blocked].freeze
+
+  class << self
+    def dsn(key, project, endpoint = DEFAULT_ENDPOINT)
+      scheme = endpoint.start_with?("http://") ? "http" : "https"
+      host = endpoint.sub(%r{\A[a-z]+://}i, "").chomp("/")
+      "#{scheme}://#{key}@#{host}/#{project}"
+    end
+
+    def init(key:, project:, environment: nil, release: nil, traces_sample_rate: 0.0, endpoint: DEFAULT_ENDPOINT, **options)
+      raise ArgumentError, "Blipit.init needs the project's public key" if key.nil? || key.to_s.empty?
+      raise ArgumentError, "Blipit.init needs the project id" if project.nil? || project.to_s.empty?
+
+      Sentry.init do |config|
+        config.dsn = dsn(key, project, endpoint)
+        config.environment = environment if environment
+        config.release = release if release
+        config.traces_sample_rate = traces_sample_rate
+        config.send_default_pii = false
+        options.each { |name, value| config.public_send("#{name}=", value) }
+        yield config if block_given?
+      end
+    end
+
+    def capture_exception(error, **options)
+      Sentry.capture_exception(error, **options)
+    end
+
+    def capture_message(message, level: :info, **options)
+      Sentry.capture_message(message, level: level, **options)
+    end
+
+    def set_user(user)
+      Sentry.set_user(user)
+    end
+
+    def set_tag(key, value)
+      Sentry.set_tags(key => value)
+    end
+
+    def add_breadcrumb(message, category: nil, level: :info, data: {})
+      Sentry.add_breadcrumb(Sentry::Breadcrumb.new(message: message, category: category, level: level, data: data))
+    end
+
+    def capture_security(kind, actor, outcome: nil, actor_id: nil, ip: nil, user_agent: nil, target: nil)
+      payload = {
+        kind: kind,
+        actor: actor,
+        outcome: outcome,
+        actor_id: actor_id,
+        ip: ip,
+        user_agent: user_agent,
+        target: target
+      }.compact
+      level = WARNING_KINDS.include?(kind.to_s) ? :warning : :info
+      Sentry.with_scope do |scope|
+        scope.set_context("security", payload)
+        scope.set_tag("security.kind", kind)
+        Sentry.capture_message("#{kind} for #{actor}", level: level)
+      end
+    end
+
+    def flush(timeout = 2)
+      client = Sentry.get_current_client
+      return unless client
+
+      executor = Sentry.background_worker&.instance_variable_get(:@executor)
+      if executor.respond_to?(:scheduled_task_count)
+        deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + timeout
+        sleep 0.01 while executor.scheduled_task_count > executor.completed_task_count && Process.clock_gettime(Process::CLOCK_MONOTONIC) < deadline
+      end
+      client.flush
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: blipit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Louward Labs
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 'Blipit error monitoring for Ruby: Rails, Sinatra, Sidekiq and scripts.
+  Know your app broke before your users tell you.'
+email: support@blipit.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/blipit.rb
+- lib/blipit/version.rb
+homepage: https://blipit.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://blipit.io
+  documentation_uri: https://docs.blipit.io/ruby
+  changelog_uri: https://blipit.io/changelog
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Blipit error monitoring for Ruby and Rails
+test_files: []