## 1. Project Overview & Quickstart (fluent/fluentd)

Fluentd: Open-Source Log Collector
===================================

[](https://github.com/fluent/fluentd/actions/workflows/test.yml)
[](https://github.com/fluent/fluentd/actions/workflows/test-ruby-head.yml)
[](https://bestpractices.coreinfrastructure.org/projects/1189)
[](https://scorecard.dev/viewer/?uri=github.com/fluent/fluentd)
[](https://github.com/fluent/fluentd/actions/workflows/backport.yml)

[Fluentd](https://www.fluentd.org/) 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](https://www.fluentd.org/blog/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

- master: For v1 development.
- v0.12: For v0.12. This is a deprecated version. we already stopped supporting (See https://www.fluentd.org/blog/drop-schedule-announcement-in-2019).

### Prerequisites

- Ruby 3.3 or later
- git

`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

- Website: https://www.fluentd.org/
- Documentation: https://docs.fluentd.org/
- Project repository: https://github.com/fluent
- Discussion: https://github.com/fluent/fluentd/discussions
- Slack / Community: https://slack.fluentd.org
- Newsletters: https://www.fluentd.org/newsletter
- Author: [Sadayuki Furuhashi](https://github.com/frsyuki)
- Copyright: 2011-2021 Fluentd Authors
- License: Apache License, Version 2.0

## Security

A third party security audit was performed by Cure53, you can see the full report [here](docs/SECURITY_AUDIT.pdf).

See [SECURITY](SECURITY.md) to contact us about vulnerability.

## Contributors:

Patches contributed by [great developers](https://github.com/fluent/fluentd/contributors).

## 2. Official Technical Reference & Guides (fluent/fluentd-docs)

# Fluentd Docs App

# Important Warnings

**THE OFFICIAL DOCUMENTATION FOR FLUENTD HAS BEEN MOVED TO GITBOOK**

This repository is kept as a historical archive. If you find something
wrong on https://docs.fluentd.org, please submit issues or PRs to the new
GitBook repository.

https://github.com/fluent/fluentd-docs-gitbook

# Overview

Ultrasimple CMS and content for Fluentd documentation. The production site is [here](https://docs.fluentd.org/).

If you'd like to propose an edit to the Fluentd docs, please fork this repo and send us a pull request.

Note that we require each commit to be signed off by the author as policy. Thus, when writing a patch, please sign your commit using the `-s` option.

    # Append `--amend` to sign the previous commit
    $ git commit -s

# Install

    $ gem install bundler
    $ bundle install --path vendor/bundle
    $ bundle exec rake server
    $ open "http://localhost:9395/"

# Test

    $ bundle exec rake test

# Build Search Index

    $ heroku run rake index

# Deploy

We deploy fluentd-docs by Circle-CI automatically.
If you want to deploy it manually, run following command.

    $ git push heroku master

## NOTE

When you have updated an article, please update config/last_updated.json too.

    $ bundle exec rake last_updated
    $ git add config/last_updated.json

# Contributing docs for v1

v1 docs are under docs/v1. Currently, most articles are symlinked to the corresponding file in docs/.

- If you are updating an exiting article. Just replace the symlink with an actual article.
- If you are adding a new article, just add it under docs/v1.

Once v1 is released, this process will be updated.

# INCLUDE pragma

You can use the "INCLUDE pragma" to avoid copy-and-pasting the same content or updates on multiple pages.

The syntax is as follows:

    INCLUDE: <filename without extension>

    ... the rest of the document.

Please remember to include a blank line between "INCLUDE..." and the rest of the document.
The docs app will search for \<filename\>.txt in the `docs` directory and insert its contents into the current document.

For example, if you write

    INCLUDE: _buffer_parameters

    ... the rest of the document.

then the docs app will insert the contents of \_buffer\_parameters.txt into the current document.

# Acknowledgement

This program is forked from [heroku/heroku-docs](http://github.com/heroku/heroku-docs), and originally written by @rtomayko and @adamwiggins. Later, modified by @kzk and @doryokujin.

Code is released under the MIT License: http://www.opensource.org/licenses/mit-license.php

All rights reserved on the content (text files in the docs subdirectory), although you're welcome to modify these for the purpose of suggesting edits.