Loki Logger Handler

https://github.com/xente/loki-logger-handler
Admin
A Python logging handler that sends log messages to Grafana Loki in JSON format, supporting custom...
Tokens:2,513
Snippets:10
Trust Score:5.8
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install loki-logger-handler

Source: https://github.com/xente/loki-logger-handler/blob/main/README.md

Installs the loki-logger-handler package using pip. This is the first step to integrate Loki logging into your Python application.

```sh
pip install loki-logger-handler
```

--------------------------------

### Python: Add Log-Specific Metadata via Extra Options

Source: https://github.com/xente/loki-logger-handler/blob/main/README.md

This Python example shows how to add metadata to individual log messages using the 'extra' parameter of the logger. The 'loki_metadata' key within the 'extra' dictionary allows for dynamic context to be attached to specific log entries.

```python
from loki_logger_handler.loki_logger_handler import LokiLoggerHandler
import logging
import os

# Set up logging
logger = logging.getLogger("custom_logger")
logger.setLevel(logging.DEBUG)

# Create an instance of the custom handler with structured metadata
custom_handler = LokiLoggerHandler(
  url=os.environ["LOKI_URL"],
  labels={"application": "Test", "environment": "Develop"},
  label_keys={},
  timeout=10,
  enable_structured_loki_metadata=True,
  loki_metadata={"service": "user-service", "version": "1.0.0"}
)

logger.addHandler(custom_handler)

logger.info("User action", extra={"loki_metadata": {"user_id": 12345, "operation": "update", "status": "success"}})

```

--------------------------------

### Python: Configure LokiLoggerHandler with Global Metadata

Source: https://github.com/xente/loki-logger-handler/blob/main/README.md

This Python code demonstrates how to initialize the LokiLoggerHandler with static structured metadata. The 'loki_metadata' parameter is used to define key-value pairs that will be appended to all log messages, and 'enable_structured_loki_metadata' ensures this data is included.

```python
from loki_logger_handler.loki_logger_handler import LokiLoggerHandler
import logging
import os

# Set up logging
logger = logging.getLogger("custom_logger")
logger.setLevel(logging.DEBUG)

# Create an instance of the custom handler with structured metadata
custom_handler = LokiLoggerHandler(
  url=os.environ["LOKI_URL"],
  labels={"application": "Test", "environment": "Develop"},
  label_keys={},
  timeout=10,
  enable_structured_loki_metadata=True,
  loki_metadata={"service": "user-service", "version": "1.0.0"}
)

logger.addHandler(custom_handler)

```

--------------------------------

### Configure Python Logger with LokiHandler

Source: https://github.com/xente/loki-logger-handler/blob/main/README.md

Demonstrates how to set up a standard Python logger and attach the LokiLoggerHandler. It configures the handler with a Loki URL from an environment variable, custom labels, and a timeout. Log messages, including extra data, are then sent to Loki.

```python
from loki_logger_handler.loki_logger_handler import LokiLoggerHandler
import logging
import os

# Set up logging
logger = logging.getLogger("custom_logger")
logger.setLevel(logging.DEBUG)

# Create an instance of the custom handler
custom_handler = LokiLoggerHandler(
    url=os.environ["LOKI_URL"],
    labels={"application": "Test", "environment": "Develop"},
    label_keys={},
    timeout=10,
)
# Create an instance of the custom handler

logger.addHandler(custom_handler)
logger.debug("Debug message", extra={'custom_field': 'custom_value'})
```

--------------------------------

### Configure Loguru with LokiHandler and LoguruFormatter

Source: https://github.com/xente/loki-logger-handler/blob/main/README.md

Shows how to integrate the LokiLoggerHandler with the Loguru logging library. It utilizes the LoguruFormatter for proper formatting and configures the handler with a Loki URL, custom labels, and a timeout. Loguru messages with additional context are then sent to Loki.

```python
from loki_logger_handler.loki_logger_handler import LokiLoggerHandler
from loki_logger_handler.formatters.loguru_formatter import LoguruFormatter
from loguru import logger
import os

custom_handler = LokiLoggerHandler(
    url=os.environ["LOKI_URL"],
    labels={"application": "Test", "environment": "Develop"},
    label_keys={},
    timeout=10,
    default_formatter=LoguruFormatter(),
)
logger.configure(handlers=[{"sink": custom_handler, "serialize": True}])

logger.info(
    "Response code {code} HTTP/1.1 GET {url}", code=200, url="https://loki_handler.io"
)
```

--------------------------------

### Bash: Query Loki Logs by Trace ID Metadata

Source: https://github.com/xente/loki-logger-handler/blob/main/README.md

This Bash command illustrates querying Loki logs for entries that have a specific 'trace_id' metadata value, demonstrating how mapped log keys can be used for filtering.

```bash
{application="Test"} |= `` | trace_id="000-000000-0000"

```

--------------------------------

### Python: Map Log Keys to Loki Metadata

Source: https://github.com/xente/loki-logger-handler/blob/main/README.md

This Python code demonstrates how to configure the LokiLoggerHandler to map specific log keys to Loki metadata using the 'loki_metadata_keys' parameter. This allows fields from the log message itself to be promoted to metadata for easier querying.

```python
from loki_logger_handler.loki_logger_handler import LokiLoggerHandler
import logging
import os

# Set up logging
logger = logging.getLogger("custom_logger")
logger.setLevel(logging.DEBUG)

# Create an instance of the custom handler with structured metadata
custom_handler = LokiLoggerHandler(
  url=os.environ["LOKI_URL"],
  labels={"application": "Test", "environment": "Develop"},
  label_keys={},
  timeout=10,
  enable_structured_loki_metadata=True,
  loki_metadata={"service": "user-service", "version": "1.0.0"},
  loki_metadata_keys=["trace_id"]
)

logger.addHandler(custom_handler)

logger.info("User action", extra={"loki_metadata": {"user_id": 12345, "operation": "update", "status": "success"}, "trace_id": "000-000000-0000"})

```

--------------------------------

### Bash: Query Loki Logs by Service Metadata

Source: https://github.com/xente/loki-logger-handler/blob/main/README.md

This Bash command demonstrates how to query logs in Loki based on structured metadata. It filters logs where the 'service' label is set to 'user-service', combined with the application label.

```bash
{application="Test"} |= `` | service="user-service"

```

--------------------------------

### Set Loki URL Environment Variable (Python)

Source: https://github.com/xente/loki-logger-handler/blob/main/README.md

This snippet shows how to set the LOKI_URL environment variable in Python to point to the Loki service's push endpoint. This is necessary for the logger handler to send logs to Loki.

```Python
os.environ["LOKI_URL"]=http://loki:3100/loki/api/v1/push
```

--------------------------------

### Bash: Query Loki Logs by User ID Metadata

Source: https://github.com/xente/loki-logger-handler/blob/main/README.md

This Bash command shows how to query Loki logs using metadata added via the 'extra' parameter. It specifically filters for logs where the 'user_id' metadata is '12345'.

```bash
{application="Test"} |= `` | user_id="12345"

```
Tokens:
Raw