README.md

tailing-sidecar

TL;DR

helm repo add tailing-sidecar https://sumologic.github.io/tailing-sidecar
helm repo update

helm upgrade --install tailing-sidecar tailing-sidecar/tailing-sidecar-operator \
  -n tailing-sidecar-system \
  --create-namespace

Add tailing-sidecar annotation to Pod:

metadata:
  annotations:
    tailing-sidecar: <sidecar-name-0>:<volume-name-0>:<path-to-tail-0>;<sidecar-name-1>:<volume-name-1>:<path-to-tail-1>

Tailing Sidecar Operator configuration is described here.

Tailing Sidecar

tailing sidecar is a streaming sidecar container, the cluster-level logging agent for Kubernetes.

It helps when your application inside the Pod cannot write to standard output and/or standard error stream or when it outputs additional logs to a file instead (eg. the gc.log).

It tails the files inside Kubernetes Pods, handling situations like the file not being there when tailing starts, tailing multiple files, rotating files, etc.

It uses Fluent Bit under the hood, benefiting from its performance.

For more information about cluster-level logging architecture please read Kubernetes documentation.

The project consists of two parts:

• tailing sidecar container image which can be used to manually extend Pods by tailing sidecars
• tailing sidecar operator which automatically adds tailing sidecars to Pods based on configuration provided in annotation

License

This project is released under the Apache 2.0 License.

Contributing

Please share your thoughts about tailing sidecar by opening an issue.

To get started contributing, please refer to our Contributing documentation.