sentry_top_errors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 451faf0b74e71cc7d9ab082b35427881ce43d99d1908246fb4d2a111a16fe7bc
+  data.tar.gz: 9684d29db554a2fbd8a660124d1cef85b2500afc6037d1bc8a4234b46a894831
+SHA512:
+  metadata.gz: b3dc5a3f0d23d95570d8f6627cdbec58da0a4213ca5c14085a775be7ba2c55154e6d1581ebf8dc67fb18df141c07b582051d2ff08e8c2952df4a39751f9078f8
+  data.tar.gz: 8f9eb1cf3e1170c894ac8360a30cc0a636865bc5627e51e6e97d79ce4f7ef1ec131203a727b623785130ceea36f9a92528cacd992729bb60297f4f5c5236c039

data/.gitignore

@@ -0,0 +1,4 @@
+sentry_cache
+index.html
+Gemfile.lock
+try_sentry_checker.rb

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,9 @@
+## Sentry Top Errors checker
+
+* Find most frequent errors in sentry
+* Find new erros that happen more than N times
+
+Useful for systems with large number of components
+
+
+TODO: write readme, better design, screenshots

data/bin/sentry_top_errors

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/sentry_top_errors'
+
+SENTRY_KEY = ENV['SENTRY_KEY']
+
+if !SENTRY_KEY || SENTRY_KEY == ''
+  STDERR.puts "Env var SENTRY_KEY is reuired"
+  exit 1
+end
+
+REPORT_TYPE = ENV['SENTRY_REPORT'] ? ENV['SENTRY_REPORT'].to_sym : :text
+
+if REPORT_TYPE != :text && REPORT_TYPE != :tabs && REPORT_TYPE != :table && REPORT_TYPE != :html
+  STDERR.puts "Env var SENTRY_REPORT should be one of those: text, tabs, table, html. Default is text"
+  exit 1
+end
+
+client = SentryTopErrors::SentryClient.new(sentry_key: SENTRY_KEY, enable_cache: !!ENV['SEMTRY_DATA_CACHE'])
+
+if ENV['DROP_CACHE']
+  client.drop_cache
+end
+
+reporter = SentryTopErrors::Reporter.new(client: client, report_type: :html)
+reporter.fetch_data
+puts r.generate_report

data/lib/sentry_top_errors/api_response.rb

@@ -0,0 +1,45 @@
+module SentryTopErrors::ApiResponse
+  def self.new_from_res(http_res)
+    if http_res.status == 429 || http_res.status >= 500
+      raise "Failed response #{http_res.status} - #{http_res.body}"
+    end
+
+    new_obj = begin
+      if http_res.body.start_with?('[') && http_res.body.end_with?(']')
+        SentryTopErrors::ApiResponse::FromArray.new.concat(JSON.parse(http_res.body))
+      else
+        SentryTopErrors::ApiResponse::FromHash.new().merge!(JSON.parse(http_res.body))
+      end
+    rescue JSON::ParserError => error
+      puts "Failed to parse response #{http_res.body}"
+    end
+
+    new_obj.response = http_res
+    new_obj
+  end
+
+  module ExtMethods
+    def http_success?
+      @response.status < 400
+    end
+
+    def status
+      @response.status
+    end
+
+    def headers
+      @response.headers
+    end
+  end
+
+  class FromArray < ::Array
+    attr_accessor :response
+    include SentryTopErrors::ApiResponse::ExtMethods
+  end
+
+  class FromHash < ::Hash
+    attr_accessor :response
+    include SentryTopErrors::ApiResponse::ExtMethods
+  end
+
+end

data/lib/sentry_top_errors/reporter.rb

@@ -0,0 +1,171 @@
+require 'progress_bar'
+
+class SentryTopErrors::Reporter
+  def initialize(client:, prod_regex: /^p-/, threshold_24h: 30, threshold_new: 10, new_days_num: 1, report_type: :html)
+    @client = client
+    @prod_regex = prod_regex
+    @threshold_24h = threshold_24h
+    @threshold_new = threshold_new
+    @new_days_num = new_days_num
+    @report_type = report_type
+  end
+
+  def fetch_data
+    puts "### Fetching sentry data"
+    bar = ProgressBar.new(100)
+    bar.write
+
+    @projects = @client.list_projects
+    bar.increment!
+    bar.max = @projects.size + 1
+
+    @issues = {}
+
+    queue = Thread::Queue.new
+    @projects.each do |project|
+      queue << project
+    end
+    threads = []
+
+    2.times do
+      threads << Thread.new do
+        while !queue.empty? && project = queue.pop
+          begin
+            @issues[project['slug']] = @client.list_issues(project['organization']['slug'], project['slug'], stats_period: '24h')
+            bar.increment!
+          rescue => error
+            bar.puts "ERROR when fetching issues for project #{project['slug']}"
+            bar.puts "#{error.class} #{error.message}\n#{error.backtrace.join("\n")}"
+          end
+        end
+      end
+    end
+
+    threads.each(&:join)
+
+    puts "### Fetching done"
+  end
+
+  def generate_report
+    groups = {}
+
+    issue_counts = []
+    new_issues = []
+
+    @projects.each do |project|
+      issues = @issues[project['slug']]
+      next if issues == nil
+
+      is_production = !!(project['name'] =~ @prod_regex)
+
+      issues.each do |issue|
+        count_in_24h = issue['stats'].values.first.map {|row| row.last }.sum
+        issue_summary = {
+          project_name: project['name'],
+          project_url: project.dig('organization', 'links', 'organizationUrl') + "/projects/#{project['slug']}",
+          issue: issue['title'],
+          culprit: issue['culprit'],
+          issue_link: issue['permalink'],
+          issue_count: count_in_24h,
+          is_production: is_production
+        }
+
+        if count_in_24h > @threshold_24h
+          issue_counts << issue_summary
+        end
+
+        first_seen = Time.parse(issue['firstSeen'])
+        age_in_days = (Time.now - first_seen) / 86400.0
+        if age_in_days < @new_days_num.to_f && count_in_24h > @threshold_new
+          new_issues << issue_summary
+        end
+      end
+    end
+
+    # sort desc, with higher number on top, separate production and staging
+    issue_counts.sort_by! do |issue|
+      [issue[:is_production] ? 1 : 0, issue[:issue_count]]
+    end
+    issue_counts.reverse!
+
+    new_issues.sort_by! do |issue|
+      [issue[:is_production] ? 1 : 0, issue[:issue_count]]
+    end
+    new_issues.reverse!
+
+    render_result(issue_counts, new_issues)
+  end
+
+  def render_result(issue_counts, new_issues)
+    if @report_type == :tabs || @report_type == :text
+      result = "\nRepeating issues\n\n"
+      issue_counts.each do |issue|
+        result << [issue[:issue_count], issue[:project_name], issue[:issue], issue[:culprit], issue[:issue_link]].join("\t") + "\n"
+      end
+
+      result << "\nNew issues\n\n"
+      new_issues.each do |issue|
+        result << [issue[:issue_count], issue[:project_name], issue[:issue], issue[:culprit], issue[:issue_link]].join("\t") + "\n"
+      end
+      return result
+    elsif @report_type == :table
+      require 'terminal-table'
+      require 'colorize'
+
+      all_table = Terminal::Table.new(headings: ["count", "project", "issue", "cause", "link"]) do |t|
+        issue_counts.each do |issue|
+          t << [
+            issue[:is_production] ? issue[:issue_count].to_s.colorize(:yellow) : issue[:issue_count],
+            issue[:project_name], pad_and_justify(issue[:issue], 70),
+            pad_and_justify(issue[:culprit], 40),
+            issue[:issue_link]
+          ]
+        end
+      end
+
+      new_table = Terminal::Table.new(headings: ["count", "project", "issue", "cause", "link"]) do |t|
+        new_issues.each do |issue|
+          t << [
+            issue[:is_production] ? issue[:issue_count].to_s.colorize(:yellow) : issue[:issue_count],
+            issue[:project_name], pad_and_justify(issue[:issue], 70),
+            pad_and_justify(issue[:culprit], 40),
+            issue[:issue_link]
+          ]
+        end
+      end
+
+      return "Repeating issues:\n#{all_table}\n\nNew issues\n#{new_table}"
+
+    elsif @report_type == :html
+      tpl_dir = File.join(File.expand_path(File.dirname(__FILE__) + "/../.."), "templates")
+      html_content = File.read(tpl_dir + "/index.html")
+      html_content.sub!(%{['ALL_ISSUE_COUNTS_PLACEHOLDER']}, JSON.pretty_generate(issue_counts))
+      html_content.sub!(%{['NEW_ISSUE_COUNTS_PLACEHOLDER']}, JSON.pretty_generate(new_issues))
+
+      puts "Saved index.html"
+      File.write("./index.html", html_content)
+
+      :ok
+    else
+      raise "Unknown report_type #{@report_type}"
+    end
+  end
+
+  def pad_and_justify(str, width, justify = :l)
+    new_str = []
+    str.split("\n").each do |s1|
+      s1.split('').each_slice(width).map {|x| x.join}.each do |s2|
+        new_str <<
+          case justify
+          when :l
+            s2.ljust(width)
+          when :r
+            s2.rjust(width)
+          when :c
+            s2.center(width)
+          end
+      end
+    end
+    new_str * "\n"
+  end
+end

data/lib/sentry_top_errors/sentry_client.rb

@@ -0,0 +1,81 @@
+class SentryTopErrors::SentryClient
+  SENTRY_HOST = 'https://sentry.io'
+  HTTP_OPTIONNS = {
+    tcp_nodelay: true,
+    connect_timeout: 10,
+    read_timeout: 40,
+    idempotent: true,
+    retry_limit: 3
+  }
+
+  def initialize(sentry_key: , enable_cache: false)
+    @sentry_key = sentry_key
+    @enable_cache = enable_cache
+  end
+
+  def http(method, path, options = {})
+    @conn ||= Excon.new(SENTRY_HOST, HTTP_OPTIONNS)
+    options[:headers] ||= {}
+    options[:headers]['Authorization'] ||= "Bearer #{@sentry_key}"
+    response = @conn.request({method: method, path: path}.merge(options))
+
+    SentryTopErrors::ApiResponse.new_from_res(response)
+  end
+
+  def get_all_with_cursor(http_method, url_path, http_options = {})
+    objects = http(http_method, url_path, http_options)
+    link_header = objects.headers['link']
+
+    while link_header && link_header =~ /rel="next"/
+      cursor_match = link_header.match(/results="true";\s+cursor="([\d:]+?)"$/)
+      if cursor_match
+        http_options[:query] ||= {}
+        http_options[:query][:cursor] = cursor_match[1]
+        next_objects = http(http_method, url_path, http_options)
+        objects.concat(next_objects)
+        link_header = next_objects.headers['link']
+      else
+        link_header = ""
+        # puts "No next link in response"
+      end
+    end
+
+    objects
+  end
+
+  def list_projects
+    cached(:all_projects) do
+      get_all_with_cursor(:get, 'api/0/projects/')
+    end
+  end
+
+  def list_issues(org_slug, project_slug, stats_period: '24h')
+    cached("list_issues_#{project_slug}") do
+      query = {statsPeriod: stats_period}
+      get_all_with_cursor(:get, "api/0/projects/#{org_slug}/#{project_slug}/issues/", query: query)
+    end
+  end
+
+  def cached(key, &block)
+    if @enable_cache
+      cache_file = "sentry_cache/#{key}.yaml"
+      if File.exist?(cache_file)
+        YAML.load_file(cache_file, aliases: true, permitted_classes: [
+          SentryTopErrors::ApiResponse::FromArray, SentryTopErrors::ApiResponse::FromHash, Symbol, Excon::Response, Excon::Headers
+        ])
+      else
+        result = block.call()
+        File.write(cache_file, YAML.dump(result))
+        result
+      end
+    else
+      block.call()
+    end
+  end
+
+  def drop_cache
+    Dir.glob("sentry_cache/*.yaml").each do |file|
+      File.unlink(file)
+    end
+  end
+end

data/lib/sentry_top_errors.rb

@@ -0,0 +1,11 @@
+require 'excon'
+require 'json'
+require 'yaml'
+require 'time'
+
+module SentryTopErrors
+end
+
+require_relative 'sentry_top_errors/api_response'
+require_relative 'sentry_top_errors/sentry_client'
+require_relative 'sentry_top_errors/reporter'

data/senrty_top_errors.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name              = "sentry_top_errors"
+  s.version           = "0.1.0"
+  s.summary           = "Generate top errors report for sentry"
+  s.description       = ""
+  s.author            = "Pavel Evstigneev"
+  s.email             = "pavel.evst@gmail.com"
+  s.homepage          = "http://github.com/Paxa/sentry_top_errors"
+  s.executables       = ["sentry_top_errors"]
+  s.files             = `git ls-files`.split("\n")
+  s.licenses          = ['MIT', 'GPL-2.0']
+
+  s.add_runtime_dependency 'excon', "~> 0.100.0"
+  s.add_runtime_dependency 'progress_bar', '>= 1.0.5', '< 2.0.0'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: sentry_top_errors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel Evstigneev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.100.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.100.0
+- !ruby/object:Gem::Dependency
+  name: progress_bar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: ''
+email: pavel.evst@gmail.com
+executables:
+- sentry_top_errors
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- bin/sentry_top_errors
+- lib/sentry_top_errors.rb
+- lib/sentry_top_errors/api_response.rb
+- lib/sentry_top_errors/reporter.rb
+- lib/sentry_top_errors/sentry_client.rb
+- senrty_top_errors.gemspec
+homepage: http://github.com/Paxa/sentry_top_errors
+licenses:
+- MIT
+- GPL-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.15
+signing_key:
+specification_version: 4
+summary: Generate top errors report for sentry
+test_files: []