Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sumologic/tailing-sidecar
tailing sidecar - the cluster-level logging agent for Kubernetes
https://github.com/sumologic/tailing-sidecar
k8s k8s-logging k8s-logs-pod kubernetes kubernetes-logging tailing-sidecar
Last synced: 2 months ago
JSON representation
tailing sidecar - the cluster-level logging agent for Kubernetes
- Host: GitHub
- URL: https://github.com/sumologic/tailing-sidecar
- Owner: SumoLogic
- License: apache-2.0
- Created: 2021-01-28T15:22:14.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-09T07:01:09.000Z (9 months ago)
- Last Synced: 2024-04-14T06:09:15.771Z (9 months ago)
- Topics: k8s, k8s-logging, k8s-logs-pod, kubernetes, kubernetes-logging, tailing-sidecar
- Language: Go
- Homepage:
- Size: 3.05 MB
- Stars: 42
- Watchers: 9
- Forks: 12
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# tailing-sidecar
## TL;DR
```sh
helm repo add tailing-sidecar https://sumologic.github.io/tailing-sidecar
helm repo update
```
```sh
helm upgrade --install tailing-sidecar tailing-sidecar/tailing-sidecar-operator \
-n tailing-sidecar-system \
--create-namespace
```
Add `tailing-sidecar` annotation to Pod:
```yaml
metadata:
annotations:
tailing-sidecar: ::;::
```
Tailing Sidecar Operator configuration is described [here](operator/docs/configuration.md).
## Tailing Sidecar
**tailing sidecar** is a [streaming sidecar container](https://kubernetes.io/docs/concepts/cluster-administration/logging/#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](https://en.wikipedia.org/wiki/Tail_(Unix)) 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](https://fluentbit.io/) under the hood, benefiting from its performance.
For more information about cluster-level logging architecture please read Kubernetes
[documentation](https://kubernetes.io/docs/concepts/cluster-administration/logging/#cluster-level-logging-architectures).
The project consists of two parts:
- [tailing sidecar container image](sidecar/) which can be used to manually extend Pods by tailing sidecars
- [tailing sidecar operator](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](LICENSE).
## Contributing
Please share your thoughts about tailing sidecar by opening an [issue](https://github.com/SumoLogic/tailing-sidecar/issues/new).
To get started contributing, please refer to our [Contributing](CONTRIBUTING.md) documentation.