Welcome to sentry-comments’s documentation!¶

sentry-comments is an extension for Sentry to add comments to events.

Important Notice Sentry (>=6.4) supports adding notes to events out-of-the- box. So there’s no need for this extension anymore.

Comments show up as a new action on the event page:

The comments panel:

Installation¶

To install the comments extension run:

pip install sentry-comments

Then add sentry_comments to the INSTALLED_APPS list in your Sentry configuration:

INSTALLED_APPS += ('sentry_comments',)

Run sentry –config=your.conf.py upgrade to create the new tables required by this plugin.

After restarting Sentry you need to enable the plugin for each project on the project’s setting page. A new comments panel appears on the event page. Click on the panel title to read or add comments.

Configuration¶

There are no configuration options yet.

Resources¶

Bug tracker: https://github.com/andialbrecht/sentry-comments/issues
Source code: https://github.com/andialbrecht/sentry-comments
Documentation: https://sentry-comments.readthedocs.org/

License¶

sentry-comments is licensed under the BSD license.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of the authors nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.