fluent-plugin-sentry-ruby 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c10659e6a83b7691d81bdf9d252b33962de42dd7f02d6da2bd9955a61fd9da42
-  data.tar.gz: cb745d8e5cccf5727276e31f637bef435389c2e0fadaffc02fb37454e0fcbd92
+  metadata.gz: a476705dd3b8036afc4961481663fffe13a9711229acfc3a559e207dc7f94608
+  data.tar.gz: 691650a62ff27d233442c424dddafbb5148c336b725152038d0a8805ccd3bf0e
 SHA512:
-  metadata.gz: 40f20d188ced7ce12c1ff33935811b16dcdb568962c62feb2a87cd7e7dd49beedc168e214a6bde8bb12e6f1a62f93852e3fb06528c928cfbb41eab1ab4890313
-  data.tar.gz: 647aa7aff7b869ffae8a83bf5eed5f1dc7765848b534220db9bfe0af946ae6ec74f0b1277f2a0157c291f419e14a4fdeb5cbf27d77513755c5d49046df89526c
+  metadata.gz: 84767a4153614507883833972e573e113112b536a32d4dc2251cfc1826c7670b029ae9c69b3b53d2bd4b9941209a0820b4b76dac99d8e21e3fa20f437db6482d
+  data.tar.gz: 4ec9fffa7b595bd4adea296c80650e9ff21211aa6e1432da29a4e3ae6548134256b64706b2eab7501759effc63b7a16c841ea93c294fb2071c443f162bec5e03

data/.devcontainer/Dockerfile

@@ -0,0 +1,17 @@
+# [Choice] Ruby version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.0, 2, 2.7, 2.6, 3-bullseye, 3.0-bullseye, 2-bullseye, 2.7-bullseye, 2.6-bullseye, 3-buster, 3.0-buster, 2-buster, 2.7-buster, 2.6-buster
+ARG VARIANT=2-bullseye
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/base.Dockerfile

@@ -0,0 +1,43 @@
+# [Choice] Ruby version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.0, 2, 2.7, 2.6, 3-bullseye, 3.0-bullseye, 2-bullseye, 2.7-bullseye, 2.6-bullseye, 3-buster, 3.0-buster, 2-buster, 2.7-buster, 2.6-buster
+ARG VARIANT=2-bullseye
+FROM ruby:${VARIANT}
+
+# Copy library scripts to execute
+COPY library-scripts/*.sh library-scripts/*.env /tmp/library-scripts/
+
+# [Option] Install zsh
+ARG INSTALL_ZSH="true"
+# [Option] Upgrade OS packages to their latest versions
+ARG UPGRADE_PACKAGES="true"
+# Install needed packages and setup non-root user. Use a separate RUN statement to add your own dependencies.
+ARG USERNAME=vscode
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    # Remove imagemagick due to https://security-tracker.debian.org/tracker/CVE-2019-10131
+    && apt-get purge -y imagemagick imagemagick-6-common \
+    # Install common packages, non-root user, rvm, core build tools
+    && bash /tmp/library-scripts/common-debian.sh "${INSTALL_ZSH}" "${USERNAME}" "${USER_UID}" "${USER_GID}" "${UPGRADE_PACKAGES}" "true" "true" \
+    && bash /tmp/library-scripts/ruby-debian.sh "none" "${USERNAME}" "true" "true" \
+    && apt-get autoremove -y && apt-get clean -y && rm -rf /var/lib/apt/lists/*
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+ENV NVM_DIR=/usr/local/share/nvm
+ENV NVM_SYMLINK_CURRENT=true \
+    PATH=${NVM_DIR}/current/bin:${PATH}
+RUN bash /tmp/library-scripts/node-debian.sh "${NVM_DIR}" "${NODE_VERSION}" "${USERNAME}" \
+    && apt-get clean -y && rm -rf /var/lib/apt/lists/*
+
+ # Remove library scripts for final image
+RUN rm -rf /tmp/library-scripts
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,34 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.209.6/containers/ruby
+{
+	"name": "Ruby",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"args": { 
+			// Update 'VARIANT' to pick a Ruby version: 3, 3.0, 2, 2.7, 2.6
+			// Append -bullseye or -buster to pin to an OS version.
+			// Use -bullseye variants on local on arm64/Apple Silicon.
+			"VARIANT": "3-bullseye",
+			// Options
+			"NODE_VERSION": "lts/*"
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"rebornix.Ruby"
+	],
+	
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+
+}

data/.gitignore

@@ -0,0 +1,4 @@
+log
+pkg
+tmp
+fluent.conf

data/README.md

@@ -28,24 +28,22 @@ $ bundle
 
 ## Configuration
 
-You can generate configuration template:
-
-```
-$ fluent-plugin-config-format output sentry
-```
-
 ## Fluent::Plugin::SentryOutput
 
 ### dsn (string) (required)
 
+
+
 ### title (string) (optional)
 
 
-Default value: `test log`.
+
+Default value: `test`.
 
 ### level (enum) (optional)
 
 
+
 Available values: fatal, error, warning, info, debug
 
 Default value: `info`.
@@ -53,23 +51,41 @@ Default value: `info`.
 ### environment (string) (optional)
 
 
+
 Default value: `local`.
 
+### type (enum) (optional)
+
+
+
+Available values: event, exception
+
+Default value: `event`.
+
 ### user_keys (array) (optional)
 
 
+
 Default value: `[]`.
 
 ### tag_keys (array) (optional)
 
 
+
 Default value: `[]`.
 
 ### keys (array) (optional)
 
 
+
 Default value: `[]`.
 
+### lang (string) (optional)
+
+
+
+Default value: `php`.
+
 
 ## Copyright
 

data/fluent-plugin-sentry.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-sentry-ruby"
-  spec.version = "0.1.0"
+  spec.version = "0.3.1"
   spec.authors = ["buffalo"]
   spec.email   = ["buffalobigboy@gmail.com"]
 

data/lib/fluent/plugin/out_sentry.rb

@@ -1,23 +1,30 @@
 require "fluent/plugin/output"
+require "sentry-ruby"
 
 module Fluent
   module Plugin
     class SentryOutput < Fluent::Plugin::Output
       Fluent::Plugin.register_output("sentry", self)
 
-      config_param :dsn, :string, :secret => true
-      config_param :title, :string, :default => 'test log'
+      config_param :dsn, :string
+      config_param :title, :string, :default => 'test'
       config_param :level, :enum, list: [:fatal, :error, :warning, :info, :debug], :default => 'info'
       config_param :environment, :string, :default => 'local'
-
+      config_param :type, :enum, list: [:event, :exception], :default => :event
+      # for event
       config_param :user_keys, :array, :default => [], value_type: :string
       config_param :tag_keys, :array, :default => [], value_type: :string
       config_param :keys, :array, :default => [], value_type: :string
+      # for exception
+      config_param :e_message, :string, :default => 'message'
+      config_param :e_describe, :string, :default => 'describe'
+      config_param :e_filename, :string, :default => 'filename'
+      config_param :e_stack, :string, :default => 'stack'
+      config_param :e_line, :string, :default => 'line'
 
 
       def initialize
         require 'time'
-        require "sentry-ruby"
 
         super
       end
@@ -27,7 +34,6 @@ module Fluent
 
         config = Sentry::Configuration.new
         config.dsn = @dsn
-        config.environment = @environment
         config.send_modules = false
         config.transport.timeout = 5
 
@@ -39,15 +45,32 @@ module Fluent
           begin
             event = Sentry::Event.new(configuration: @client.configuration)
 
-            event.message = @title
-            event.level = record['level'] || @level
+            event.level = (record['level'] || @level).downcase
+            event.environment = record['env'] || @environment
 
-            event.user = record.select{ |key| @user_keys.include?(key) }
-            event.extra = @keys.length() > 0 ? record.select{ |key| @keys.include?(key) } : record
-            event.contexts = {'data' => { origin_data: record }}
-            event.tags = event.tags.merge({ :platform => tag })
-              .merge({ :timestamp => Time.at(time).strftime('%Y-%m-%d %H:%M:%S') })
-              .merge(record.select{ |key| (@tag_keys + @user_keys).include?(key) })
+            if @type === :event
+              event.message = record['message'] || @title
+              event.user = record.select{ |key| @user_keys.include?(key) }
+              event.extra = @keys.length() > 0 ? record.select{ |key| @keys.include?(key) } : record
+              event.contexts = {'data' => { origin_data: record }}
+              event.tags = event.tags.merge({ :log_tag => tag })
+                .merge({ :timestamp => Time.at(time).strftime('%Y-%m-%d %H:%M:%S') })
+                .merge(record.select{ |key| (@tag_keys + @user_keys).include?(key) })
+            elsif @type === :exception
+              event = event.to_hash
+              event['exception'] = Sentry::CustomExceptionInterface.new(
+                type: record['message'] || @title,
+                message: (record[@e_describe] + (record[@e_line] ? (' on line:' + record[@e_line]) : '')) || '',
+                stacktrace: Sentry::StacktraceInterface.new(frames: [Sentry::CustomStacktraceFrame.new(
+                  filename: record[@e_filename] || '',
+                  context_line: (record[@e_describe] + (record[@e_line] ? (' on line:' + record[@e_line]) : '')) || '',
+                  post_context: record[@e_stack] || (record[@e_describe] || ''),
+                )])
+              ).to_hash
+              event['tags'] = { :log_tag => tag }
+                .merge({ :timestamp => Time.at(time).strftime('%d-%b-%Y %H:%M:%S %Z') })
+                .merge(record.select{ |key| (@tag_keys + @user_keys).include?(key) })
+            end
 
             @client.send_event(event)
           rescue => e
@@ -66,3 +89,44 @@ module Fluent
     end
   end
 end
+
+module Sentry
+  class CustomExceptionInterface < Sentry::Interface
+    attr_reader :type
+    attr_reader :message
+
+    SKIP_INSPECTION_ATTRIBUTES = [:@stacktrace]
+
+    def initialize(type:, message:, stacktrace: nil)
+      @type = type
+      @value = message
+      @stacktrace = stacktrace
+    end
+
+    def to_hash
+      data = super
+      data[:stacktrace] = data[:stacktrace].to_hash if data[:stacktrace]
+      data
+    end
+  end
+
+  class CustomStacktraceFrame < Sentry::Interface
+    attr_accessor :filename, :pre_context, :context_line, :post_context, :lineno
+
+    def initialize(filename:, context_line:, pre_context: '', post_context: '', lineno: 1)
+      @filename = filename
+      @context_line = context_line
+      @pre_context = pre_context.split("\n")
+      @post_context = post_context.split("\n")
+      @lineno = lineno
+    end
+
+    def to_hash(*args)
+      data = super(*args)
+      data.delete(:pre_context) unless pre_context && !pre_context.empty?
+      data.delete(:post_context) unless post_context && !post_context.empty?
+      data.delete(:context_line) unless context_line && !context_line.empty?
+      data
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - buffalo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,6 +93,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/base.Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md