Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ handler = logging_loki.LokiHandler(
headers={"X-Scope-OrgID": "example-id"},
auth=("username", "password"),
version="1",
props_to_labels: Optional[list[str]] = ["foo"]
)

logger = logging.getLogger("my-logger")
Expand Down Expand Up @@ -62,6 +63,7 @@ handler_loki = logging_loki.LokiHandler(
headers={"X-Scope-OrgID": "example-id"},
auth=("username", "password"),
version="1",
props_to_labels: Optional[list[str]] = ["foo"]
)
logging.handlers.QueueListener(queue, handler_loki)

Expand Down
18 changes: 14 additions & 4 deletions logging_loki/emitter.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,14 @@ class LokiEmitter(abc.ABC):
label_replace_with = const.label_replace_with
session_class = requests.Session

def __init__(self, url: str, tags: Optional[dict] = None, headers: Optional[dict] = None, auth: BasicAuth = None, as_json: bool = False):
def __init__(self,
url: str,
tags: Optional[dict] = None,
headers: Optional[dict] = None,
auth: BasicAuth = None,
as_json: bool = False,
props_to_labels: Optional[list[str]] = None
):
"""
Create new Loki emitter.

Expand All @@ -52,6 +59,8 @@ def __init__(self, url: str, tags: Optional[dict] = None, headers: Optional[dict
self.auth = auth
#: Optional bool, send record as json?
self.as_json = as_json
#: Optional list, send record as json?
self.props_to_labels = props_to_labels or []

self._session: Optional[requests.Session] = None
self._lock = threading.Lock()
Expand Down Expand Up @@ -106,10 +115,11 @@ def build_tags(self, record: logging.LogRecord) -> Dict[str, Any]:
tags[self.level_tag] = record.levelname.lower()
tags[self.logger_tag] = record.name

extra_tags = getattr(record, "tags", {})
if not isinstance(extra_tags, dict):
return tags
extra_tags = {k: getattr(record, k) for k in self.props_to_labels if getattr(record, k)}
if isinstance(passed_tags := getattr(record, "tags", {}), dict):
extra_tags = extra_tags | passed_tags


for tag_name, tag_value in extra_tags.items():
cleared_name = self.format_label(tag_name)
if cleared_name:
Expand Down
5 changes: 3 additions & 2 deletions logging_loki/handlers.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ def __init__(
headers: Optional[dict] = None,
auth: Optional[emitter.BasicAuth] = None,
version: Optional[str] = None,
as_json: Optional[bool] = False
as_json: Optional[bool] = False,
props_to_labels: Optional[list[str]] = None
):
"""
Create new Loki logging handler.
Expand All @@ -71,7 +72,7 @@ def __init__(
version = version or const.emitter_ver
if version not in self.emitters:
raise ValueError("Unknown emitter version: {0}".format(version))
self.emitter = self.emitters[version](url, tags, headers, auth, as_json)
self.emitter = self.emitters[version](url, tags, headers, auth, as_json, props_to_labels)

def handleError(self, record): # noqa: N802
"""Close emitter and let default handler take actions on error."""
Expand Down