sentry-raven 2.5.1 → 2.5.2

data/docs/Makefile

@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = ./_build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+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 "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of 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)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+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."
+
+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.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Sentry"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Sentry"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+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."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

data/docs/breadcrumbs.rst

@@ -0,0 +1,40 @@
+Breadcrumbs
+===========
+
+Breadcrumbs are a trail of events which happened prior to an issue. Often, these events are very similar to traditional logs, but Breadcrumbs also can record rich, structured data.
+
+.. sourcecode:: ruby
+
+    Raven.breadcrumbs.record do |crumb|
+      crumb.data = data
+      crumb.category = name
+      # ...
+    end
+
+The following attributes are available:
+
+* ``category``: A String to label the event under. This will usually be the same as a logger name, and will let you more easily understand the area an event took place, such as "auth".
+* ``data``: A Hash of metadata around the event. This is often used instead of message, but may also be used in addition.
+* ``level``: The level may be any of ``error``, ``warn``, ``info``, or ``debug``.
+* ``message``: A string describing the event. The most common vector, often used as a drop-in for a traditional log message.
+* ``timestamp``: A Unix timestamp (seconds past epoch)
+
+Appropriate places to inject Breadcrumbs may be places like your HTTP library:
+
+.. sourcecode:: ruby
+
+    # Instrumenting Faraday with a middleware:
+
+    class RavenFaradayMiddleware
+      def call
+        # Add a breadcrumb every time we complete an HTTP request
+        @app.call(request_env).on_complete do |response_env|
+          Raven.breadcrumbs.record do |crumb|
+            crumb.data = { response_env: response_env }
+            crumb.category = "faraday"
+            crumb.timestamp = Time.now.to_i
+            crumb.message = "Completed request to #{request_env[:url]}"
+          end
+        end
+      end
+    end

data/docs/conf.py

@@ -0,0 +1,228 @@
+# -*- coding: utf-8 -*-
+#
+# Sentry documentation build configuration file, created by
+# sphinx-quickstart on Wed Oct 20 16:21:42 2010.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import os
+import sys
+import datetime
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+#extensions = ['sphinxtogithub']
+extensions = ['sphinx.ext.intersphinx']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Raven'
+copyright = u'%s, Functional Software Inc.' % datetime.datetime.today().year
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+
+version = __import__('pkg_resources').get_distribution('raven').version
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+intersphinx_mapping = {
+}
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'nature'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ['_themes']
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = "_static/logo.png"
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Ravendoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+    ('index', 'Raven.tex', u'Raven Ruby Documentation',
+     u'David Cramer', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'raven', u'Raven Ruby Documentation',
+     [u'Functional Software Inc.'], 1)
+]
+
+if os.environ.get('SENTRY_FEDERATED_DOCS') != '1':
+    sys.path.insert(0, os.path.abspath('_sentryext'))
+    import sentryext
+    sentryext.activate()

data/docs/config.rst

@@ -0,0 +1,240 @@
+Configuration
+=============
+
+Configuration is passed as part of the client initialization:
+
+.. code-block:: javascript
+
+    Raven.configure do |config|
+      config.dsn = '___DSN___'
+      config.attr = 'value'
+    end
+
+Optional settings
+-----------------
+
+.. describe:: async
+
+    When an error or message occurs, the notification is immediately sent to Sentry. Raven can be configured to send asynchronously:
+
+    .. code-block:: ruby
+
+        config.async = lambda { |event|
+          Thread.new { Raven.send_event(event) }
+        }
+
+    Using a thread to send events will be adequate for truly parallel Ruby platforms such as JRuby, though the benefit on MRI/CRuby will be limited. Threads also won't report any exceptions raised inside of them, so be careful!
+
+    If the async callback raises an exception, Raven will attempt to send synchronously.
+
+    We recommend creating a background job, using your background job processor, that will send Sentry notifications in the background. Rather than enqueuing an entire Raven::Event object, we recommend providing the Hash representation of an event as a job argument. Here's an example for ActiveJob:
+
+    .. code-block:: ruby
+
+        config.async = lambda { |event|
+          SentryJob.perform_later(event.to_hash)
+        }
+
+    .. code-block:: ruby
+
+        class SentryJob < ActiveJob::Base
+          queue_as :default
+          
+          # Important! Otherwise, we can get caught in an infinite loop.
+          rescue_from(ActiveJob::DeserializationError) { |e| Rails.logger.error e }
+
+          def perform(event)
+            Raven.send_event(event)
+          end
+        end
+
+.. describe:: encoding
+
+    While unlikely that you'll need to change it, by default Raven compresses outgoing messages with gzip. This has a slight impact on performance, but due to the size of many Ruby stacktrace it's required for the serve to accept the content.
+
+    To disable gzip, set the encoding to 'json':
+
+    .. code-block:: ruby
+
+        config.encoding = 'json'
+
+.. describe:: environments
+
+    As of v0.10.0, events will be sent to Sentry in all environments. If you do not wish to send events in an environment, we suggest you unset the SENTRY_DSN variable in that environment.
+
+    Alternately, you can configure Raven to run only in certain environments by configuring the environments whitelist. For example, to only run Sentry in production:
+
+    .. code-block:: ruby
+
+        config.environments = %w[ production ]
+
+    Sentry automatically sets the current environment to RAILS_ENV, or if it is not present, RACK_ENV. If you are using Sentry outside of Rack or Rails, or wish to override environment detection, you'll need to set the current environment yourself:
+
+    .. code-block:: ruby
+
+        config.current_environment = 'my_cool_environment'
+
+.. describe:: excluded_exceptions
+
+    If you never wish to be notified of certain exceptions, specify 'excluded_exceptions' in your config file.
+
+    In the example below, the exceptions Rails uses to generate 404 responses will be suppressed.
+
+    .. code-block:: ruby
+
+        config.excluded_exceptions = ['ActionController::RoutingError', 'ActiveRecord::RecordNotFound']
+
+    You can find the list of exceptions that are excluded by default in ``Raven::Configuration::IGNORE_DEFAULT``. Remember you'll be overriding those defaults by setting this configuration.
+
+.. describe:: logger
+
+    The name of the logger used by Sentry. Default is an instance of Raven::Logger.
+
+    .. code-block:: ruby
+
+        config.logger = Raven::Logger.new(STDOUT)
+
+    Raven respects logger levels.
+
+.. describe:: processors
+
+    If you need to sanitize or pre-process (before its sent to the server) data, you can do so using the Processors implementation. By default, a few processors are installed. The most important is ``Raven::Processor::SanitizeData``, which will attempt to sanitize keys that match various patterns (e.g. password) and values that resemble credit card numbers.
+
+    In your Sentry UI, data which has been sanitized will appear as "********" (or 0, if the value was an Integer).
+
+    To specify your own (or to remove the defaults), simply pass them with your configuration:
+
+    .. code-block:: ruby
+
+        config.processors = [MyOwnProcessor]
+
+    Check out ``Raven::Processor::SanitizeData`` to see how a Processor is implemented.
+
+    You can also specify values to be sanitized. Any strings matched will be replaced with the string mask (********). One good use for this is to copy Rails' filter_parameters:
+
+    .. code-block:: ruby
+
+        config.sanitize_fields = Rails.application.config.filter_parameters.map(&:to_s)
+
+    The client scrubs the HTTP "Authorization" header of requests before sending them to Sentry, to prevent sensitive credentials from being sent. You can specify additional HTTP headers to ignore:
+
+    .. code-block:: ruby
+
+        config.sanitize_http_headers = ["Via", "Referer", "User-Agent", "Server", "From"]
+
+    For more information about HTTP headers which may contain sensitive information in your application, see `RFC 2616 <https://www.w3.org/Protocols/rfc2616/rfc2616-sec15.html>`_.
+
+    By default, Sentry sends up a stacktrace with an exception. This stacktrace may contain data which you may consider to be sensitive, including lines of source code, line numbers, module names, and source paths. To wipe the stacktrace from all error reports, require and add the RemoveStacktrace processor:
+
+    .. code-block:: ruby
+
+        require 'raven/processor/removestacktrace'
+
+        Raven.configure do |config|
+          config.processors << Raven::Processor::RemoveStacktrace
+        end
+
+    By default, Sentry does not send POST data or cookies if present. To re-enable, remove the respective processor from the chain:
+
+    .. code-block:: ruby
+
+        Raven.configure do |config|
+          config.processors -= [Raven::Processor::PostData] # Do this to send POST data
+          config.processors -= [Raven::Processor::Cookies] # Do this to send cookies by default
+        end
+
+.. describe:: proxy
+
+  A string with the URL of the HTTP proxy to be used.
+
+  .. code-block:: ruby
+
+      config.proxy = 'http://path.to.my.proxy.com'
+
+.. describe:: rails_report_rescued_exceptions
+
+    Rails catches exceptions in the ActionDispatch::ShowExceptions or ActionDispatch::DebugExceptions middlewares, depending on the environment. When `rails_report_rescued_exceptions` is true (it is by default), Raven will report exceptions even when they are rescued by these middlewares.
+
+    If you are using a custom exceptions app, you may wish to disable this behavior:
+
+    .. code-block:: ruby
+
+        config.rails_report_rescued_exceptions = false
+
+.. describe:: release
+
+    Track the version of your application in Sentry.
+
+    We guess the release intelligently in the following order of preference:
+
+    * Commit SHA of the last commit (git)
+    * Reading from the REVISION file in the app root
+    * Heroku's dyno metadata (must have enabled via Heroku Labs)
+
+    .. code-block:: ruby
+
+        config.release = '721e41770371db95eee98ca2707686226b993eda'
+
+.. describe:: should_capture
+
+    By providing a proc or lambda, you can control what events are captured. Events are passed to the Proc or lambda you provide - returning false will stop the event from sending to Sentry:
+
+    .. code-block:: ruby
+
+        config.should_capture = Proc.new { |e| true unless e.contains_sensitive_info? }
+
+.. describe:: silence_ready
+
+    Upon start, Raven will write the following message to the log at the INFO level:
+
+    ``
+    ** [out :: hostname.example.com] I, [2014-07-22T15:32:57.498368 #30897]  INFO -- : ** [Raven] Raven 0.9.4 ready to catch errors"
+    ``
+
+    You can turn off this message:
+
+    .. code-block:: ruby
+
+        config.silence_ready = true
+
+.. describe:: ssl_verification
+
+    By default SSL certificate verification is enabled in the client. It can be disabled.
+
+    .. code-block:: ruby
+
+        config.ssl_verification = false
+
+.. describe:: tags
+
+    Default tags to send with each event.
+
+    .. code-block:: ruby
+
+        config.tags = { foo: :bar }
+
+.. describe:: transport_failure_callback
+
+    If the transport fails to send an event to Sentry for any reason (either the Sentry server has returned a 4XX or 5XX response), this Proc or lambda will be called.
+
+    .. code-block:: ruby
+
+        config.transport_failure_callback = lambda { |event|
+          AdminMailer.email_admins("Oh god, it's on fire!").deliver_later
+        }
+
+Environment Variables
+---------------------
+
+.. describe:: SENTRY_DSN
+
+    After you complete setting up a project, you'll be given a value which we call a DSN, or Data Source Name. It looks a lot like a standard URL, but it's actually just a representation of the configuration required by Raven (the Sentry client). It consists of a few pieces, including the protocol, public and secret keys, the server address, and the project identifier.
+
+    With Raven, you may either set the SENTRY_DSN environment variable (recommended), or set your DSN manually in a config block:
+
+    .. code-block:: ruby
+
+        # in Rails, this might be in config/initializers/sentry.rb
+        Raven.configure do |config|
+          config.dsn = 'http://public:secret@example.com/project-id'
+        end