Stream supervisor events to a logstash instance
Project description
This is a port of the Supervisor-logging project. Along with capturing loglines, as Supervisor-logging does, it’s also intended to capture the PROCESS_STATE events that Supervisor emits.
supervisor-logstash-notifier
A supervisor plugin to stream events & logs to a Logstash instance.
Installation
Python 2.7 or Python 3.4+ is required.
pip install supervisor-logstash-notifier
Note that Supervisor itself does not yet work on Python 3, though it can be installed in a separate environment (because supervisor-logstash-notifier is a separate process).
Usage
The Logstash instance to send the events to is configured with the environment variables:
LOGSTASH_SERVER
LOGSTASH_PORT
LOGSTASH_PROTO
Add the plugin as an event listener:
# Capture state changes [eventlistener:logging] command = logstash_notifier events = PROCESS_STATE # Capture stdout/stderr [eventlistener:logging] command = logstash_notifier --capture-output events = PROCESS_LOG # Capture state changes and stdout/stderr [eventlistener:logging] command = logstash_notifier --capture-output events = PROCESS_STATE,PROCESS_LOG
If you don’t wish to define the environment variables for the entire shell, you can pass them in via Supervisor’s configuration:
[eventlistener:logging] environment=LOGSTASH_SERVER="127.0.0.1",LOGSTASH_PORT="12201",LOGSTASH_PROTO="tcp" command=logstash_notifier events=PROCESS_STATE
Enable the log events in your program:
[program:yourprogram] stdout_events_enabled = true stderr_events_enabled = true
Advanced Usage
It is also possible to include environment variables in the event messages, by specifying the name of the environment variables to include:
[eventlistener:logging] command=export IPV4=`ec2metadata --local-ipv4`; logstash_notifier --include IPV4 events=PROCESS_STATE
Or alternatively, by specifying arbitrary keyvals of data to log:
[eventlistener:logging] command=logstash_notifier --include bears="polar,brown,black" notbears="unicorn,griffin,sphinx,otter" events=PROCESS_STATE
These two forms of arbitrary user data inclusion can be combined, and used together if necessary.
Running with Logstash
Logstash can be simply configured to receive events:
input { tcp { port => 12201 codec => json } } output { stdout { codec => rubydebug } }
The JSON produced by the events and log output will look like this:
# State changes { "@timestamp": "2016-03-28T23:58:03.469Z", "@version": "1", "eventname": "PROCESS_STATE_STOPPED", "from_state": "STOPPING", "groupname": "myprocess", "host": "ip-10-93-130-24", "level": "INFO", "logger_name": "supervisor", "message": "PROCESS_STATE_STOPPED collectd", "path": "/path/to/supervisor-logstash-notifier/logstash_notifier/__init__.py", "pid": "1234", "processname": "myprocess", "tags": [], "type": "logstash" } # Log output { "@timestamp": "2016-03-28T23:58:03.741Z", "@version": "1", "channel": "stdout" "eventname": "PROCESS_LOG_STDOUT", "groupname": "myprocess", "host": "localhost", "level": "INFO", "logger_name": "supervisor", "message": "myprocess output #1\n", "path": "/path/to/supervisor-logstash-notifier/logstash_notifier/__init__.py", "pid": "1234", "processname": "myprocess", "tags": [], "type": "logstash", }
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
Built Distribution
Hashes for supervisor-logstash-notifier-0.2.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8db8781c1877ddcb234e7b34c68f0d589cf1db941d89f2bc97101078b2c6356 |
|
MD5 | 3434de6daa3c01f02f6aa209be302288 |
|
BLAKE2b-256 | e4b23cd80677014c65e640063e576a2e38b5e017494424724c0f80eb653f1d86 |
Hashes for supervisor_logstash_notifier-0.2.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfa045f28ce169eaff26796feb87003696cc9c10ad04b9a81c51371ed4b8eeab |
|
MD5 | 6e519b8e6f9fd5120e80e5a3348788aa |
|
BLAKE2b-256 | c863e703968c79614cc47e5716c0bdc02365ac609af3237813c5c625eb85bdef |