Skip to main content

Logging handler and CLI for

Project description

# Python Sinklog
Logging handler and CLI for

## Install
$ pip install python-sinklog

## Usage
Obtain a log key from

### CLI
usage: sinklog [-h] --key KEY [--host HOST] [--port PORT] [--format FORMAT]
[--level {WARN,INFO,DEBUG,ERROR}] [--tee]

A simple logger for

positional arguments:
message messages to log

optional arguments:
-h, --help show this help message and exit
--key KEY, -k KEY log key
--host HOST, -H HOST Sinklog host
--port PORT, -P PORT Sinklog port
--format FORMAT, -F FORMAT
Python log format
Python log level
--tee, -t when reading from stdin, copy to stdout

example usage:

# log a message on the command line
$ sinklog -k <log key> "my log message"

# log from stdin
$ tail -f /var/log/myapp.log | sinklog -k <log key>

# usage in a pipeline
$ tail -f /var/log/myapp.log | sinklog -k <log key> --tee | grep foo

### Python
Any Python script or app:

import logging
from sinklog import SinklogHandler

sinklog = SinklogHandler(logkey="<log key>", transport="tls")
logger = logging.getLogger()

# Just use the logger as you would normally and log
# messages will be forwarded to your Sinklog stream."Hello Sinklog!")

### Django
Add `SinklogHandler` to your Django logging config:

'handlers': {
'sinklog': {
'level': "DEBUG",
'class': "sinklog.SinklogHandler",
'logkey': "<log key>",
'transport': "tls"
'loggers': {
'django.db.backends': {
'level': 'ERROR',
'handlers': ['sinklog'],
'propagate': False

### Flask
Add `SinklogHandler` to Flask's root app logger:

from sinklog import SinklogHandler

sinklog = SinklogHandler(logkey="<log key>", transport="tcp")

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

python-sinklog-1.1.tar.gz (7.7 kB view hashes)

Uploaded source

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