Skip to main content

Log handler sending messages to a Matrix room

Project description


.. image::

.. image::

.. image::

.. image::

.. image::

Python log handler that posts to a Matrix room. Posts to the Matrix API using


.. code-block:: bash

pip install matrix-log-handler


base_url (required)

The base URL of the Matrix Homeserver to use. Up to, but *not* including `/_matrix/client`.

room_id (required)

The room ID to use, like !


An access token that can be used to send messages.

username and password

An optional username/password to login with. Note that it advised *not* to use these parameters, but use ``token`` instead.

Defaults to ``False``.

If your access token, username/password, or base URL is invalid, or for some other reason the API
call returns an error, this option will silently ignore the API error.

If you enable this setting, **make sure you have another log handler** that will also handle the
same log events, or they may be lost entirely.

Logging configuration

This example will send log messages with the level of ERROR or above to Matrix.

.. code-block:: python

import logging

'version': 1,
'disable_existing_loggers': False,
'handlers': {
'matrix-error': {
'class': 'matrix_log_handler.MatrixLogHandler',
'level': 'ERROR',
'base_url': '',
'room_id': '!'
'loggers': {
'': {
'handlers': ['matrix-error'],
'level': 'ERROR',
'propagate': True,

logging.error('Hello, Matrix!')


Apache 2.0

Matrix-Python-SDK is also under Apache 2.0.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

matrix_log_handler-0.3.1.tar.gz (7.4 kB view hashes)

Uploaded Source

Built Distribution

matrix_log_handler-0.3.1-py2.py3-none-any.whl (3.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page