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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97340086cdaa49beb4acf307c527bb4847ecc4e7e5b98fca0f8e240857bce79d |
|
MD5 | 862c7fb5453ddbadee515aafef54db27 |
|
BLAKE2b-256 | 4e5a7b671dac6b7b575043cc3eeda3699f0510d73bfd61ee1d15db4055bbfdc3 |
Hashes for inuits_python_logging_loki-1.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45a88f456b4fa21aba194cdd02d7ab03cf6db02cdb2ce08a39c9edea16653316 |
|
MD5 | a9febcd0ea549b9f8c65f784ee51afc9 |
|
BLAKE2b-256 | 561d9840cccd6653f6a09f96af740b3d592a8c58e0de38cf53440676fb189503 |