spectrum-python is a Python Logging Handler for Spectrum (devspectrum.com)
Project description
Overview
Spectrum is a application that helps developers filter and sift through logs while developing or debugging locally. It accepts logging information via a REST API, syslog, or can be set to tail local files. All of these logging sources are then easily shown or hidden depending on the current needs of the developer.
This Python package makes it trivially easy to push logs from Python and/or Django into Spectrum.
Python
Installing Python support for Spectrum is as easy as:
$ pip install spectrum-python
Setting up a logging handler is also equally easy:
import logging from spectrum.handlers import Spectrum logger = logging.getLogger(__name__) logger.setLevel(logging.DEBUG) spectrum = Spectrum('my-logging-sublevel') logger.addHandler(spectrum) for i in range(5): logger.info("This would be sent as INFO.my-logging-sublevel") logger.warn("This would be sent as WARNING.my-logging-sublevel") logger.debug("This would be sent as DEBUG.my-logging-sublevel")
Options
url
IP and PORT of the REST API to use. Defaults to ‘http://0.0.0.0:9000’. You must override this to the proper Spectrum port associated to your stream if using more than one REST API Stream
sublevel
Optional sub-level to use for this handler. Defaults to ‘<untitled>’ in the Spectrum UI if not given.
Django
To direct all logging from your Django project to Spectrum, you can use the predefined FIRE_HOSE logging configuration in your settings:
# settings.py from spectrum.django import FIRE_HOSE LOGGING = FIRE_HOSE
If you use celery, you’ll have one more setting to add:
CELERYD_HIJACK_ROOT_LOGGER = False
You can also use the fire_hose convenience method to quickly modify any of the pre-built logging configuration dict:
from spectrum.django import fire_hose LOGGING = fire_hose() LOGGING = fire_hose(log_db=False) LOGGING = fire_hose(levels=( ('my.overly.verbose.module', 'WARNING'), ('some.other.module', 'CRITICAL'), ) LOGGING = fire_hose(handler_kwargs={'url': '127.0.0.1:12345'})
If you prefer a more granular approach, you can configure specific handlers:
# settings.py LOGGING = { ... 'filters': { 'request_id': { '()': 'spectrum.filters.RequestIdFilter' } }, 'handlers': { 'myloggername': { 'level': 'DEBUG', 'class': 'spectrum.handlers.RestSpectrum', 'sublevel': 'myloggername', 'filters': ['request_id'] } } }
Make sure you include the request_id filter to filter out spectrum’s own requests from the other. Otherwise, Spectrum’s requests will be logged by Python, and those logs will in turn generate their own Spectrum request, causing and infinite recursion.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file spectrum-python-0.9.8.tar.gz
.
File metadata
- Download URL: spectrum-python-0.9.8.tar.gz
- Upload date:
- Size: 7.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6858ac46b2a11533e247d3636435779fbb0bf69bcb1c3f88cb524101548ac2dd |
|
MD5 | 458029d7a8461d15badf6f14ad8b754e |
|
BLAKE2b-256 | b2eb4d32e1e06fc76f40606533a4397076fa329b229b63d157ae5a5e7619a800 |