sentry-raven 2.7.4 → 3.1.1

data/docs/install.rst

@@ -1,40 +0,0 @@
-Installation
-============
-
-Raven Ruby comes as a gem and is straightforward to install.  If you are
-using Bundler just add this to your ``Gemfile``:
-
-.. sourcecode:: ruby
-
-    gem "sentry-raven"
-
-Development Version
--------------------
-
-If you want to install the development version from github:
-
-.. sourcecode:: ruby
-
-    gem "sentry-raven", :github => "getsentry/raven-ruby"
-
-Without Integrations
---------------------
-
-If you wish to activate integrations manually (or don't want them
-activated by default), require "raven/base" instead of "raven" or
-"sentry-raven".  In that case disable the requiring in the ``Gemfile``:
-
-.. sourcecode:: ruby
-
-    gem "sentry-raven", :require => false
-
-And in your initialization code:
-
-.. sourcecode:: ruby
-
-    require "raven/base"
-    require "raven/integrations/rails"
-    require "raven/integrations/delayed_job"
-
-This stops you from calling ``Raven.inject``, which is where all this
-integration loading occurs.

data/docs/integrations/heroku.rst

@@ -1,11 +0,0 @@
-Heroku
-======
-
-Installation
-------------
-
-Enable the ``runtime-dyno-metadata`` Heroku Labs feature in order to enable automated release detection:
-
-::
-
-   heroku labs:enable runtime-dyno-metadata -a myapp

data/docs/integrations/index.rst

@@ -1,59 +0,0 @@
-Integrations
-============
-
-For common environments and frameworks like Rails, Rake, Rack and others
-Ruby Raven provides automatic integration for reporting.  Most of the time
-you don't need to change anything, although you can configure those
-features if you want.
-
-.. toctree::
-   :maxdepth: 1
-
-   rails
-   rack
-   puma
-   heroku
-
-The following integrations are available:
-
-*   Sidekiq (``:sidekiq``)
-*   ``Delayed::Job`` (``:delayed_job``)
-*   Rake (``:rake``)
-*   Rack (``:rack``)
-*   Rails (``:railties``)
-
-
-Manually using integrations
----------------------------
-
-Integrations are automatically loaded by default. This can be problematic if
-the default integration behavior doesn't suit your projects' needs.
-
-To explicitly include integrations:
-
-.. sourcecode:: ruby
-
-   require 'sentry-raven-without-integrations'
-   Raven.inject_only(:railties, :rack, :rake)
-
-
-To blacklist integrations:
-
-.. sourcecode:: ruby
-
-   require 'sentry-raven-without-integrations'
-   Raven.inject_without(:sidekiq, :delayed_job)
-
-
-If you're using bundler, then in your gemfile:
-
-.. sourcecode:: ruby
-
-   gem 'sentry-raven', require: 'sentry-raven-without-integrations'
-
-
-And in some sort of initializer:
-
-.. sourcecode:: ruby
-
-   Raven.inject_without(:sidekiq)

data/docs/integrations/puma.rst

@@ -1,30 +0,0 @@
-Puma
-====
-
-Installation
-------------
-
-Install the SDK via Rubygems by adding it to your ``Gemfile``:
-
-.. sourcecode:: ruby
-
-    gem "sentry-raven"
-
-Configuration
--------------
-
-Puma provides a config option for handling low level errors.
-
-.. sourcecode:: ruby
-
-    # in your puma.rb config
-    lowlevel_error_handler do |ex, env|
-      Raven.capture_exception(
-        ex,
-        :message => ex.message,
-        :extra => { :puma => env },
-        :transaction => "Puma"
-      )
-      # note the below is just a Rack response
-      [500, {}, ["An error has occurred, and engineers have been informed. Please reload the page. If you continue to have problems, contact support@example.com\n"]]
-    end

data/docs/integrations/rack.rst

@@ -1,27 +0,0 @@
-Rack (Sinatra etc.)
-===================
-
-Installation
-------------
-
-Install the SDK via Rubygems by adding it to your ``Gemfile``:
-
-.. sourcecode:: ruby
-
-    gem "sentry-raven"
-
-Configuration
--------------
-
-Add ``use Raven::Rack`` to your ``config.ru`` or other rackup file (this is
-automatically inserted in Rails):
-
-.. sourcecode:: ruby
-
-    require 'raven'
-
-    Raven.configure do |config|
-      config.dsn = '___DSN___'
-    end
-
-    use Raven::Rack

data/docs/integrations/rails.rst

@@ -1,62 +0,0 @@
-Ruby on Rails
-=============
-
-In Rails, all uncaught exceptions will be automatically reported. 
-
-We support Rails 4 and newer.
-
-Installation
-------------
-
-Install the SDK via Rubygems by adding it to your ``Gemfile``:
-
-.. sourcecode:: ruby
-
-    gem "sentry-raven"
-
-Configuration
--------------
-
-Open up ``config/application.rb`` and configure the DSN, and any other :doc:`settings <../config>`
-you need:
-
-.. sourcecode:: ruby
-
-    Raven.configure do |config|
-      config.dsn = '___DSN___'
-    end
-
-If you have added items to `Rails' log filtering
-<http://guides.rubyonrails.org/action_controller_overview.html#parameters-filtering>`_,
-you can also make sure that those items are not sent to Sentry:
-
-.. sourcecode:: ruby
-
-    # in your application.rb:
-    config.filter_parameters << :password
-
-    # in an initializer, like sentry.rb
-    Raven.configure do |config|
-      config.sanitize_fields = Rails.application.config.filter_parameters.map(&:to_s)
-    end
-
-Params and sessions
--------------------
-
-.. sourcecode:: ruby
-
-  class ApplicationController < ActionController::Base
-    before_action :set_raven_context
-
-    private
-
-    def set_raven_context
-      Raven.user_context(id: session[:current_user_id]) # or anything else in session
-      Raven.extra_context(params: params.to_unsafe_h, url: request.url)
-    end
-  end
-
-Caveats
--------
-
-Currently, custom exception applications (`config.exceptions_app`) are not supported. If you are using a custom exception app, you must manually integrate Raven yourself.

data/docs/make.bat

@@ -1,155 +0,0 @@
-@ECHO OFF
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set BUILDDIR=_build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
-if NOT "%PAPER%" == "" (
-	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
-)
-
-if "%1" == "" goto help
-
-if "%1" == "help" (
-	:help
-	echo.Please use `make ^<target^>` where ^<target^> is one of
-	echo.  html       to make standalone HTML files
-	echo.  dirhtml    to make HTML files named index.html in directories
-	echo.  singlehtml to make a single large HTML file
-	echo.  pickle     to make pickle files
-	echo.  json       to make JSON files
-	echo.  htmlhelp   to make HTML files and a HTML help project
-	echo.  qthelp     to make HTML files and a qthelp project
-	echo.  devhelp    to make HTML files and a Devhelp project
-	echo.  epub       to make an epub
-	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
-	echo.  text       to make text files
-	echo.  man        to make manual pages
-	echo.  changes    to make an overview over all changed/added/deprecated items
-	echo.  linkcheck  to check all external links for integrity
-	echo.  doctest    to run all doctests embedded in the documentation if enabled
-	goto end
-)
-
-if "%1" == "clean" (
-	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
-	del /q /s %BUILDDIR%\*
-	goto end
-)
-
-if "%1" == "html" (
-	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
-	goto end
-)
-
-if "%1" == "dirhtml" (
-	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
-	goto end
-)
-
-if "%1" == "singlehtml" (
-	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
-	goto end
-)
-
-if "%1" == "pickle" (
-	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
-	echo.
-	echo.Build finished; now you can process the pickle files.
-	goto end
-)
-
-if "%1" == "json" (
-	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
-	echo.
-	echo.Build finished; now you can process the JSON files.
-	goto end
-)
-
-if "%1" == "htmlhelp" (
-	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
-	echo.
-	echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in %BUILDDIR%/htmlhelp.
-	goto end
-)
-
-if "%1" == "qthelp" (
-	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
-	echo.
-	echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Sentry.qhcp
-	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Sentry.ghc
-	goto end
-)
-
-if "%1" == "devhelp" (
-	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
-	echo.
-	echo.Build finished.
-	goto end
-)
-
-if "%1" == "epub" (
-	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
-	echo.
-	echo.Build finished. The epub file is in %BUILDDIR%/epub.
-	goto end
-)
-
-if "%1" == "latex" (
-	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
-	echo.
-	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
-	goto end
-)
-
-if "%1" == "text" (
-	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
-	echo.
-	echo.Build finished. The text files are in %BUILDDIR%/text.
-	goto end
-)
-
-if "%1" == "man" (
-	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
-	echo.
-	echo.Build finished. The manual pages are in %BUILDDIR%/man.
-	goto end
-)
-
-if "%1" == "changes" (
-	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
-	echo.
-	echo.The overview file is in %BUILDDIR%/changes.
-	goto end
-)
-
-if "%1" == "linkcheck" (
-	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
-	echo.
-	echo.Link check complete; look for any errors in the above output ^
-or in %BUILDDIR%/linkcheck/output.txt.
-	goto end
-)
-
-if "%1" == "doctest" (
-	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
-	echo.
-	echo.Testing of doctests in the sources finished, look at the ^
-results in %BUILDDIR%/doctest/output.txt.
-	goto end
-)
-
-:end

data/docs/processors.rst

@@ -1,124 +0,0 @@
-Processors
-==========
-
-Raven Ruby contains several "processors", which scrub data before it is sent to Sentry.
-Processors remove invalid or sensitive data. The following are the processors
-which are enabled by default (and are applied to all outgoing data in this order):
-
-RemoveCircularReferences
-   Many Ruby JSON implementations simply throw an exception if they detect a
-   circular reference. This processor removes circular references from hashes
-   and arrays.
-
-UTF8Conversion
-   Many Ruby JSON implementations will throw exceptions if data is not in a
-   consistent UTF-8 format. This processor looks for invalid encodings and fixes
-   them.
-
-SanitizeData
-  Censors any data which looks like a password, social security number or credit
-  card number. Can be configured to scrub other data.
-
-Cookies
-  Removes any HTTP cookies from the Sentry event data.
-
-PostData
-  Removes any HTTP Post request bodies.
-
-HTTPHeaders
-  Removes all HTTP headers which match a regex. By default, this will only remove the
-  "Authorization" header, but can be configured to remove others.
-
-Finally, another processor is included in the source but is not turned on by default,
-RemoveStackTrace.
-
-To remove stacktraces from events:
-
-.. sourcecode:: ruby
-
-    Raven.configure do |config|
-      config.processors += [Raven::Processor::RemoveStacktrace]
-    end
-
-Writing Your Own Processor
---------------------------
-
-Processors are simple to write and understand. As an example, let's say that we
-send user API keys to a background job (using Sidekiq), and if the background job
-raises an exception, we want to make sure that the API key is removed from the
-event data.
-
-This is what a basic processor might look like:
-
-.. sourcecode:: ruby
-
-  class MyJobProcessor < Raven::Processor
-    def process(data)
-      return data unless data["extra"]["arguments"] &&
-        data["extra"]["arguments"].first["sensitive_parameter"]
-
-      data["extra"]["arguments"].first["sensitive_parameter"] = STRING_MASK
-      data
-    end
-  end
-
-Processors should inherit from the ``Raven::Processor`` class. This ensures that the
-processor has access to its client (all processors have a ``client`` instance method,
-which will be populated with the current ``Raven::Client`` when the  processor
-is initialized), and gives you a few convenient constants for masking data.
-
-Processors must have a method called ``process`` defined. It must accept one
-argument, which will be the Raven event data hash. The method must return a hash,
-which represents the data after it has been modified by the processor.
-
-To help you in writing your own processor, here is what the Event data hash looks
-like (slightly modified/concatenated) when it is passed to the processor:
-
-.. sourcecode:: ruby
-
-  {
-    "environment" => "default",
-    "event_id" => "02ea6d3d35c840b1a8f339ba896917e3",
-    "extra" => {
-      "server" => {
-       # server related information
-      }
-     "active_job" => "MyActiveJob",
-     "arguments" => [ {"sensitive_parameter": "sensitive"} ],
-     "job_id" => "cbc2c146-0486-4e98-b81c-1a251d636b34",
-    },
-    "modules" => {
-      "rake"=>"12.0.0",
-       "concurrent-ruby"=>"1.0.5",
-       "i18n"=>"0.8.6",
-       "minitest"=>"5.10.3",
-       # ...
-    },
-    "platform" => "ruby",
-    "release" => "e4d5ced",
-    "sdk" => {"name"=>"raven-ruby", "version"=>"2.6.3"},
-    "server_name" => "myserver.local",
-    "timestamp" => "2017-10-09T19:53:20",
-    "exception" => {
-      # A very large and complex exception object
-    }
-  }
-
-However, it will probably be more helpful if you use a debugger, such as `pry`, to
-inspect the event data hash for yourself.
-
-The example processor given above looks for the ActiveJob arguments hash, looks for
-a particular value, and then replaces it with the string mask. There is a fast return
-if the event does not contain the ActiveJob data we're looking for, using Ruby 2.3+'s
-safe navigation operator.
-
-Once you have your processor written, you simply need to add it to the processor chain:
-
-.. sourcecode:: ruby
-
-  Raven.configure do |config|
-    config.processors += MyJobProcessor
-  end
-
-For more information about writing processors, read the code for the default
-processors, located in ``lib/processor``.