fluentd README

The project's README from github.com/fluent/fluentd. As one markdown file: README.md.

Fluentd: Open-Source Log Collector

Test Test with Ruby head CII Best Practices OpenSSF Scorecard Backport Pull Requests

Fluentd collects events from various data sources and writes them to files, RDBMS, NoSQL, IaaS, SaaS, Hadoop and so on. Fluentd helps you unify your logging infrastructure (Learn more about the Unified Logging Layer).

Quick Start

$ gem install fluentd
$ fluentd -s conf
$ fluentd -c conf/fluent.conf &
$ echo '{"json":"message"}' | fluent-cat debug.test

Development

Branch

Prerequisites

git should be in PATH. On Windows, you can use Github for Windows and GitShell for easy setup.

Install dependent gems

Use bundler:

$ gem install bundler
$ bundle install --path vendor/bundle

Run test

$ bundle exec rake test

You can run specified test via TEST environment variable:

$ bundle exec rake test TEST=test/test_specified_path.rb
$ bundle exec rake test TEST=test/test_*.rb

More Information

Security

A third party security audit was performed by Cure53, you can see the full report here.

See SECURITY to contact us about vulnerability.

Contributors:

Patches contributed by great developers.

fluentd (fluent/fluentd)

Searching Database…

13.6K ·GitHub
What is this?Fluentd is an open-source log collector that sits at the center of your logging setup: it gathers events from many data sources and writes them to files, RDBMS, NoSQL, IaaS, SaaS, Hadoop and more.
Is it a library I call from my code, or something I run on my servers?It is a standalone daemon: you install it, start it with a config file, and it collects and routes logs on its own, while your apps just send events to it.
How do I get it running?Install the gem, generate a config, and start the daemon: 'gem install fluentd', then 'fluentd -s conf', then 'fluentd -c conf/fluent.conf &'. Test it by piping a JSON message through 'fluent-cat debug.test'.
What do I need installed before it will run?Ruby 3.3 or later, plus git on your PATH (on Windows the README suggests GitHub for Windows or GitShell to set git up easily).
I'm still on the old 0.12 branch — is that okay?No: the v0.12 branch is deprecated and no longer supported. Development happens on master for v1, so plan a migration to v1.
Can I use it commercially, and does it cost anything?It is free and open source under the Apache License 2.0, which permits commercial use.
Why does it call itself a unified logging layer?Because it decouples data sources from backends: instead of wiring every app to every storage, Fluentd collects events once and forwards them to wherever they belong — files, RDBMS, NoSQL, IaaS, SaaS or Hadoop — unifying your logging infrastructure.
How can I quickly check that it is actually receiving events?With the daemon running, pipe a small JSON payload into the 'fluent-cat' command targeting a test tag like debug.test, and watch it flow through.
What are similar projects?vector, telegraf, thanos, signoz, kubescape, cat, jaeger, awesome-sysadmin
Creator
fluent
Size
21.2 MB
Stars
13.6K
Age
15y
Commits · 90 Days