https://github.com/monokrome/opbeat_pyramid

Module for performance and error tracking in Pyramid projects with opbeat.
https://github.com/monokrome/opbeat_pyramid

Last synced: 12 days ago
JSON representation

Module for performance and error tracking in Pyramid projects with opbeat.

• Host: GitHub
• URL: https://github.com/monokrome/opbeat_pyramid
• Owner: monokrome
• License: mit
• Created: 2016-09-01T18:43:05.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-07-25T20:23:50.000Z (over 7 years ago)
• Last Synced: 2024-10-17T10:14:33.407Z (29 days ago)
• Language: Python
• Homepage:
• Size: 44.9 KB
• Stars: 1
• Watchers: 14
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
opbeat-pyramid

--------------

[![CircleCI](https://circleci.com/gh/monokrome/opbeat_pyramid.svg?style=svg)](https://circleci.com/gh/monokrome/opbeat_pyramid)

[![Coverage Status](https://coveralls.io/repos/github/monokrome/opbeat_pyramid/badge.svg?branch=master)](https://coveralls.io/github/monokrome/opbeat_pyramid?branch=master)

Provides middleware for transaction and error reporting  to opbeat from your

Pyramid applications.

### Installation

Installation can be done with easy_install, pip, or whichever package

management tool you prefer:

```

pip install opbeat_pyramid

```

### Usage

Using the module should be simple. You will need to call

`config.include('opbeat_pyramid')` on the configurator for your Pyramid

project. With the standard Pyramid boilerplates, this will be done in the

`main` function within **\__init__.py**.

#### Options

The following options **must be** in your app configuration in order to use

this module:

| Pyramid Setting                  | Environment Variable           | Description                                                                        |

|----------------------------------|--------------------------------|------------------------------------------------------------------------------------|

| opbeat.enabled                 * | OPBEAT_ENABLED                 | True to enable reporting to OpBeat                                                 |

| opbeat.module_name             * | OPBEAT_MODULE_NAME             | The name of your project's module                                                  |

| opbeat.organization_id         * | OPBEAT_ORGANIZATION_ID         | Your opbeat organization ID                                                        |

| opbeat.app_id                  * | OPBEAT_APP_ID                  | Your opbeat app ID                                                                 |

| opbeat.secret_token            * | OPBEAT_SECRET_TOKEN            | Your opbeat secret token                                                           |

| opbeat.unsafe_settings_phrases   | OPBEAT_UNSAFE_SETTINGS_PHRASES | Comma-separated phrases used in setting names that should never be sent to update. |

*NOTE: Settings marked with \* are required*