Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
45 changed files
with
1,025 additions
and
2,138 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[submodule "docs/_sentryext"] | ||
path = docs/_sentryext | ||
url = https://github.com/getsentry/sentry-doc-support |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Submodule _sentryext
added at
7a2aab
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,29 @@ | ||
Beacon | ||
====== | ||
|
||
Sentry will periodically communicate with a remote beacon server. This is utilized for a couple of things, primarily: | ||
Sentry will periodically communicate with a remote beacon server. This is | ||
utilized for a couple of things, primarily: | ||
|
||
- Getting information about the current version of Sentry | ||
- Retrieving important system notices | ||
|
||
The remote server is operated by the Sentry team (getsentry.com), and the information reported follows the company's `privacy policy <https://www.getsentry.com/privacy/>`_. | ||
The remote server is operated by the Sentry team (getsentry.com), and the | ||
information reported follows the company's `privacy policy | ||
<https://www.getsentry.com/privacy/>`_. | ||
|
||
The following information is reported: | ||
|
||
- A unique installation ID | ||
- The version of Sentry | ||
- A technical contact email (``SENTRY_ADMIN_EMAIL``) | ||
- General anonymous statistics on the data pattern (such as the number of users) | ||
- General anonymous statistics on the data pattern (such as the number of | ||
users) | ||
|
||
Note: The contact email is utilized for security announcements, and will never be used outside of such. | ||
Note: The contact email is utilized for security announcements, and will | ||
never be used outside of such. | ||
|
||
The data reported is minimal and it greatly helps the development team behind Sentry. With that said, you can disable the beacon with the following setting: | ||
|
||
.. code-block:: python | ||
The data reported is minimal and it greatly helps the development team | ||
behind Sentry. With that said, you can disable the beacon with the | ||
following setting:: | ||
|
||
SENTRY_BEACON = False |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
Updating Buffers | ||
================ | ||
|
||
Sentry provides the ability to buffer certain updates to events, such as | ||
counts and timestamps. This is extremely helpful if you have high | ||
concurrency, especially if they're frequently the same event. | ||
|
||
For example, if you happen to receive 100,000 events/second, and 10% of | ||
those are reporting a connection issue to the database (where they'd get | ||
grouped together), enabling a buffer backend will change things so that | ||
each count update is actually put into a queue, and all updates are | ||
performed at the rate of how fast the queue can keep up. | ||
|
||
Choosing a Backend | ||
------------------ | ||
|
||
To specify a backend, simply modify the ``SENTRY_BUFFER`` and | ||
``SENTRY_BUFFER_OPTIONS`` values in your configuration:: | ||
|
||
SENTRY_BUFFER = 'sentry.buffer.base.Buffer' | ||
SENTRY_BUFFER_OPTIONS = {} | ||
|
||
|
||
The Redis Backend | ||
----------------- | ||
|
||
Configuring the Redis backend **requires the queue** or you won't see any | ||
gains (in fact you'll just negatively impact your performance). | ||
|
||
Configuration is fairly straight forward:: | ||
|
||
SENTRY_BUFFER = 'sentry.buffer.redis.RedisBuffer' | ||
SENTRY_BUFFER_OPTIONS = { | ||
'hosts': { | ||
0: { | ||
'host': 'localhost', | ||
'port': 6379 | ||
} | ||
} | ||
} | ||
|
||
Because the Redis buffer relies on the Nydus package, this gives you the | ||
ability to specify multiple nodes and have keys automatically distributed. | ||
It's unlikely that you'll need this functionality, but if you do, a simple | ||
configuration might look like this:: | ||
|
||
SENTRY_BUFFER_OPTIONS = { | ||
'hosts': { | ||
0: { | ||
'host': '192.168.1.1' | ||
}, | ||
1: { | ||
'host': '192.168.1.2' | ||
} | ||
}, | ||
} | ||
|
||
With the default configuration this will distribute keys using a simple | ||
partition router (relatively even distribution). |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Changelog | ||
========= | ||
|
||
.. include:: ../CHANGES |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.