Skip to content

index.rst

Latest commit

 

History

History
49 lines (33 loc) · 1.45 KB

index.rst

File metadata and controls

49 lines (33 loc) · 1.45 KB

Interfaces

Sentry implements data interfaces for storing structured data. At its core, an interface describes what it's storing, and optionally how its data should be rendered.

Within the client, interfaces are referenced by their full Python module path. For example, if you were sending data for the sentry.interfaces.Message class, it would look like this in your JSON packet:

{
    // etc.
    "message": "Hello world"
    "sentry.interfaces.Message": {
        "message": "Hello world"
    }
}

Aliases

As of protocol version 4, most built-in interface types are aliases for easier reference. For example, instead of using the key 'sentry.interfaces.Exception', you can send the key 'exception'.

The mapping is as follows:

* 'exception' => 'sentry.interfaces.Exception'
* 'request' => 'sentry.interfaces.Http'
* 'user' => 'sentry.interfaces.User'
* 'stacktrace' => 'sentry.interfaces.Stacktrace'
* 'template' => 'sentry.interfaces.Template'

For the canonical names, please see the get_path method on each individual Interface.

Provided Interfaces

.. autoclass:: sentry.interfaces.message.Message


.. autoclass:: sentry.interfaces.exception.Exception


.. autoclass:: sentry.interfaces.stacktrace.Stacktrace


.. autoclass:: sentry.interfaces.template.Template


.. autoclass:: sentry.interfaces.http.Http


.. autoclass:: sentry.interfaces.user.User


.. autoclass:: sentry.interfaces.query.Query