<commit_before>Configuration
=============

This document describes configuration options available to Sentry.

.. note:: Some integrations allow specifying these in a standard configuration, otherwise they are generally passed upon
          instantiation of the Sentry client.

.. toctree::
   :maxdepth: 2

   celery
   django
   flask
   pylons
   logging
   logbook
   wsgi


Client Settings
---------------

Settings are specified as part of the intialization of the client.

::

    from raven import Client

    client = Client(servers=['http://sentry.local/api/store/'])


name
~~~~

This will override the ``server_name`` value for this installation. Defaults to ``socket.gethostname()``.

::

    name = 'sentry_rocks_' + socket.gethostname()

exclude_paths
~~~~~~~~~~~~~

Extending this allow you to ignore module prefixes when we attempt to discover which function an error comes from (typically a view)

::

    exclude_paths = [
        'django',
        'sentry',
        'raven',
        'lxml.objectify',
    ]

include_paths<commit_msg>Add site and project to docs<commit_after>Configuration
=============

This document describes configuration options available to Sentry.

.. note:: Some integrations allow specifying these in a standard configuration, otherwise they are generally passed upon
          instantiation of the Sentry client.

.. toctree::
   :maxdepth: 2

   celery
   django
   flask
   pylons
   logging
   logbook
   wsgi


Client Settings
---------------

Settings are specified as part of the intialization of the client.

::

    from raven import Client

    client = Client(servers=['http://sentry.local/api/store/'])


project
~~~~~~~

Set this to your Sentry project ID. The default value for installations is ``1``.

::

    project = 1

site
~~~~

An optional, arbitrary string to identify this client installation.

::

    site = 'my site name'


name
~~~~

This will override the ``server_name`` value for this installation. Defaults to ``socket.gethostname()``.

::

    name = 'sentry_rocks_' + socket.gethostname()

exclude_paths
~~~~~~~~~~~~~

Extending this allow you to ignore module prefixes when we attempt to discover which function an error comes from (typically a view)

::

    exclude_paths = [
        'django',
        'sentry',
        'raven',
        'lxml.objectify',
    ]

include_paths
{'fraction_non_alphanumeric': 0.11407972858354538, 'fraction_numerical': 0.0016963528413910093, 'mean_word_length': 3.0883882149046795, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4586581', 'n_tokens_mistral': 670, 'n_tokens_neox': 644, 'n_words': 243}