Python logging handler for Grafana Loki.
Project description
python-logging-loki
Python logging handler for Loki.
https://grafana.com/loki
Installation
pip install inuits-python-logging-loki
Usage
import logging
import logging_loki
handler = logging_loki.LokiHandler(
url="https://my-loki-instance/loki/api/v1/push",
tags={"application": "my-app"},
headers={"X-Scope-OrgID": "example-id"},
auth=("username", "password"),
props_to_labels = ["foo"]
)
logger = logging.getLogger("my-logger")
logger.addHandler(handler)
logger.error(
"Something happened",
extra={"tags": {"service": "my-service"}},
)
Example above will send Something happened
message along with these labels:
- Default labels from handler
- Message level as
serverity
- Logger's name as
logger
- Labels from
tags
item ofextra
dict - Property
foo
from log record will be sent as loki label
Properties to label
Using a dict instead of a list for props_to_labels
will enable renaming labels
handler = logging_loki.LokiHandler(
url="https://my-loki-instance/loki/api/v1/push",
tags={"application": "my-app"},
props_to_labels = {
"otelTraceID": "trace_id"
"otelSpanID": "span_id"
}
)
In this case, the properties otelTraceID
& otelSpanID
will be renamed to trace_id
& span_id
loki labels
Non-blocking mode
The given example is blocking (i.e. each call will wait for the message to be sent).
But you can use the built-in QueueHandler
and QueueListener
to send messages in a separate thread.
import logging.handlers
import logging_loki
from multiprocessing import Queue
queue = Queue(-1)
handler = logging.handlers.QueueHandler(queue)
handler_loki = logging_loki.LokiHandler(
url="https://my-loki-instance/loki/api/v1/push",
tags={"application": "my-app"},
headers={"X-Scope-OrgID": "example-id"},
auth=("username", "password"),
props_to_labels: Optional[list[str]] = ["foo"]
)
logging.handlers.QueueListener(queue, handler_loki)
logger = logging.getLogger("my-logger")
logger.addHandler(handler)
logger.error(...)
Or you can use LokiQueueHandler
shortcut, which will automatically create listener and handler.
import logging.handlers
import logging_loki
from multiprocessing import Queue
handler = logging_loki.LokiQueueHandler(
Queue(-1),
url="https://my-loki-instance/loki/api/v1/push",
tags={"application": "my-app"},
auth=("username", "password"),
)
logger = logging.getLogger("my-logger")
logger.addHandler(handler)
logger.error(...)
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 inuits_python_logging_loki-1.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b880935ce875ee71c577e1d81faaa6501e6b26bcdbf6d6bb1d99bf4264a61b8c |
|
MD5 | 3ed79930b4916bb4005138e76bc4c1b0 |
|
BLAKE2b-256 | 001bd1b56f74dc9991b2f8872e61d33cef81b75db17a22525bb24734dec4c2d9 |
Hashes for inuits_python_logging_loki-1.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34d8bd04423722f049a6b39331b8c17fcacc7a9ad2b1d35f85066fd0ad249838 |
|
MD5 | 3d990ed4bb28bf020e396f87cecc7019 |
|
BLAKE2b-256 | 846eac96c13704a94b5aa738ecba60424d880d24d130a9480cd227773b71cf84 |