Edit me on GitHub

Pyramid Amon’s documentation


Pyramid Amon is an add-on for the Pyramid Web Framework which allows developers to integrate their application with Amon application and system monitoring toolkit.


Install using setuptools, e.g. (within a virtualenv):

$ easy_install pyramid_amon


Once pyramid_amon is installed, you must use the config.include mechanism to include it into your Pyramid project’s configuration. In your Pyramid project’s __init__.py:

config = Configurator(.....)

Alternately, instead of using the Configurator’s include method, you can activate Pyramid by changing your application’s .ini file, use the following line:

pyramid.includes = pyramid_amon

pyramid_amon obtains Amon settings from the **settings dictionary passed to the Configurator. It assumes that you’ve placed Amon configuration parameters prefixed with amon.config. in your Pyramid application’s .ini file. For example:

.. other settings ..
amon.config.address = http://amon_instance:port
amon.config.protocol = http
amon.config.secret_key = the-secret-key-from-/etc/amon.conf


When this add-on is included into your Pyramid application, whenever a request to your application causes an exception to be raised, the add-on will send the URL that caused the exception, the exception type, and its related traceback information to an Amon monitoring service you have access.

You also can access logging facilities provided by amonpy.log instance in two ways:

request.amon.log(message, tags)


from pyramid_amon import get_amon
amon = get_amon(request)
amon.log({"first_name": "John", "last_name": "Dev", "age": 29}, 'info')

See Amon documentation for more informations abour configuration and usage.

API Documentation


Obtain an amonpy instance previously registered via config.include('pyramid_amon').

Indices and tables

Table Of Contents