https://github.com/fluent/fluent-plugin-multiprocess

Multiprocess agent plugin for Fluentd
https://github.com/fluent/fluent-plugin-multiprocess

fluentd fluentd-plugin

Last synced: 5 months ago
JSON representation

Multiprocess agent plugin for Fluentd

• Host: GitHub
• URL: https://github.com/fluent/fluent-plugin-multiprocess
• Owner: fluent
• Created: 2013-09-17T21:21:34.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2022-09-27T00:00:17.000Z (over 3 years ago)
• Last Synced: 2025-06-08T16:08:27.874Z (9 months ago)
• Topics: fluentd, fluentd-plugin
• Language: Ruby
• Size: 15.6 KB
• Stars: 44
• Watchers: 16
• Forks: 12
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Multiprocess agent plugin for Fluentd

## multiprocess

**multiprocess** agent plugin runs some child fluentd processes.

You can take advantage of multiple CPU cores using this plugin.

Please note that this plugin does not generate records although this is an input plugin.

This plugin just controls start & shutdown of child processes.

### Configuration

    

      @type multiprocess

      # optional:

      #graceful_kill_interval 2s

      #graceful_kill_interval_increment 3s

      #graceful_kill_timeout 60s

      

        cmdline -c /etc/fluent/fluentd_child1.conf --log /var/log/fluent/fluentd_child1.log

        pid_file /var/run/fluentd_child1.pid

      

      

        cmdline -c /etc/fluent/fluentd_child2.conf --log /var/log/fluent/fluentd_child2.log

        sleep_before_start 5s

        pid_file /var/run/fluentd_child2.pid

      

      

        cmdline -c /etc/fluent/fluentd_child3.conf --log /var/log/fluent/fluentd_child3.log

        sleep_before_shutdown 5s

        pid_file /var/run/fluentd_child3.pid

      

    

- **process**: section sets command line arguments of a child process. This plugin creates one child process for each \ section

- **cmdline**: This parameter is required in a \ section

- **sleep\_before\_start**: Optional. Sets wait time before starting the process. Note that child processes **start from last to first** (`fluentd_child3` -\> `sleep 5` -\> { `fluentd_child2`, `fluentd_child1` } in this case)

- **sleep\_before\_shutdown**: Optional. Sets wait time before shutting down the process. Note that child processes **shutdown from first to last** ({ `fluentd_child1`, `fluentd_child2` } -\> `sleep 5` -> `fluentd_child3` in this case)

- **pid_file**: Optional. Writes child process id to this file. This is useful for sending a signal to child processes, e.g. logrotate's  pid.

### Logs for daemonized processes

Daemonized fluentd closes its STDOUT. So child processes on daemonized fluentd & in_multiprocess doesn't put its logs without `--log` option. Specifing `--log` option always is best practice to help this situation.

### NOTE

* You should use unique parameter in each sub configuration to avoid conflict problem, e.g. buffer_path of `buf_file`, `s3_object_key_format` of `out_s3` and more.

* This plugin is mainly for Fluentd v0.x, since Fluentd v1.x has [multi-process-workers feature](https://docs.fluentd.org/deployment/multi-process-workers).

However, you can still use this plugin for Fluentd v1.x to run plugins that don't support the feature in multiple processes (with special care of the configuration to avoid race).