logging-k8s-metadata

Enriches log records with kubernetes metadata

Getting started

Installation

Install library:

pip install logging-k8s-metadata

Usage

Call setup_logging_k8s_pod_info() method to set up logger factory.

Expose k8s metadata

Logger factory provided by this lib enriches log records with kubernetes metadata read from /etc/podinfo directory which should be exposed by pod. See Expose Pod Information to Containers Through Files for details.

Configure your deployment and add podinfo metadata volume.

Example deployment.yaml with metadata volumes:

apiVersion: apps/v1
kind: Deployment
spec:
  template:
    spec:
      containers:
        volumeMounts:
          - name: podinfo
            mountPath: /etc/podinfo
      volumes:
        - name: podinfo
          downwardAPI:
            items:
              - path: "name"
                fieldRef:
                  fieldPath: metadata.name
              - path: "namespace"
                fieldRef:
                  fieldPath: metadata.namespace
              - path: "labels"
                fieldRef:
                  fieldPath: metadata.labels
              - path: "annotations"
                fieldRef:
                  fieldPath: metadata.annotations

Development

For standalone library development install requirements:

pip install -r requirements/dev.txt

or install from local repo in developer mode in other project:

pip install -e ../logging-k8s-metadata

Test

pytest

Release

Set version in git tags to release. Always include a patch version to work correctly (ex: 1.2.0, even if patch is 0). After git tag is set, CI will build and publish library on PYPI.