Skip to content

Commit

Permalink
Update sorely out-of-date docs (#183)
Browse files Browse the repository at this point in the history
  • Loading branch information
benvinegar authored Aug 1, 2016
1 parent 3614d6e commit 47279ef
Showing 1 changed file with 54 additions and 2 deletions.
56 changes: 54 additions & 2 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,36 @@ Optional settings
release: '721e41770371db95eee98ca2707686226b993eda'
}
.. describe:: environment

Track the environment name inside Sentry.

.. code-block:: javascript
{
environment: 'staging'
}
.. describe:: tags

Additional tags to assign to each event.

.. code-block:: javascript
{
tags: {git_commit: 'c0deb10c4'}
}
.. describe:: extra

Arbitrary data to associate with the event.

.. code-block:: javascript
{
extra: {planet: {name: 'Earth'}}
}
.. describe:: dataCallback

A function that allows mutation of the data payload right before being
Expand All @@ -41,12 +71,30 @@ Optional settings
{
dataCallback: function(data) {
// remove references to the environment
delete data.request.env;
// add a user context
data.user = {
id: 1337,
name: 'janedoe',
email: 'janedoe@example.com'
};
return data;
}
}
.. describe:: transport

Override the default HTTP data transport handler.

.. code-block:: javascript
{
transport: function (options) {
// send data
}
}
Please see the raven-node source code to see [how transports are implemented](https://github.com/getsentry/raven-node/blob/master/lib/transports.js).

Environment Variables
---------------------

Expand All @@ -61,3 +109,7 @@ Environment Variables
.. describe:: SENTRY_RELEASE

Optionally set the application release version for the client to use, this is usually a Git SHA hash.

.. describe:: SENTRY_ENVIRONMENT

Optionally set the environment name, e.g. "staging", "production".

0 comments on commit 47279ef

Please sign in to comment.