nosinovacao/floki repository overview

⁠Floki

Floki is a simple micro-service that aggregates Kafka⁠ logs, sorts them and pushes them to Grafana Loki⁠.

⁠Table of Contents

• About the Project⁠
• Getting Started⁠
  • Usage⁠
• Roadmap⁠
• Contributing⁠
• License⁠

⁠About The Project

Loki⁠ has Promtail⁠ which is an agent that installs itself in every k8s cluster nodes and collects the pods logs and sends them to Loki. Since we use the ELK Stack⁠ in our infrastructure, each k8s node has the Filebeat⁠ agent running for log collection, so by using Promtail, we are effectively duplicating the functionality. To avoid this, we have created Floki, which subscribes to our Kafka logging topics, orders the logs and sends them to Loki.

⁠Getting Started

To run Floki, you need to have the ELK Stack⁠ or other distributed logging system compatible with Kafka and also Loki installed in your infrastructure.

⁠Usage

docker run nosinovacao/floki \
   -lokiurl="http://<loki_base_url>/api/prom/push" \
   -brokerList="<kafka_broker_list>" \
   -topicPattern="^logging-*"

⁠Roadmap

See the open issues⁠ for a list of proposed features (and known issues).

⁠Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

⁠License

Distributed under the BSD-3-Clause License. See LICENSE for more information.