view release on metacpan or  search on metacpan

README.md  view on Meta::CPAN

# fluent-agent-lite

* http://github.com/tagomoris/fluent-agent-lite

## DESCRIPTION

'fluent-agent-lite' is a log transfer agent, for Fluentd's 'forward' input.

This agent reads specified files, and sends each lines to fluentd servers. One log line will be packed one fluentd message, that has one attribute ('message' or specified in configuration) with entire line (not terminated by newline).

### VERSION

0.9 http://tagomoris.github.io/tarballs/fluent-agent-lite.v0.9.tar.gz

## PACKAGING TARBALL

To get tarball of latest tagged version:

    make -f Makefile.package

Got tarball on `tmp/archive/fluent-agent-lite.vX.Y.tar.gz`.

To do this, versions (tags) MUST be v1.0 not but v0.10 for sorting order...

## INSTALL

On RHEL/CentOS, you can use .spec file to build rpm with your customized default config file.

### RHEL/CentOS

To build your rpm package, do 5 steps below.

1. Download (newest version) tarball, and place it on SOURCES/ .
2. Download package/fluent-agent-lite.conf, and place it on SOURCES/ .
3. Fix SOURCES/package/fluent-agent-lite.conf as you want (ex: server name or servers list), and add servers list for your own.
4. Download SPECS/fluent-agent-lite.spec, and place it on SPECS/ .
5. run 'rpmbuild -ba SPECS/fluent-agent-lite.spec'

To install each RHEL/CentOS host, use yum server, or copy and rpm -i on each host.

NOTE: `yum install perl-devel` and `QA_RPATHS=$[0x001] rpmbuild -ba` may help you if `rpmbuild` fails on your build environment.

### Other Linux or Unix-like OS

On each host, do steps below.

1. Download and extract tarball, or clone repository, and move into extracted directory.
2. Do 'bin/install.sh'.

## Configuration

All of configurations are written in configuration shell-script file (/etc/fluent-agent-lite.conf). Configurable values are below:

### LOGS

Pairs of tag and file, such as:

    LOGS=$(cat <<"EOF"
    www     /var/log/nginx/www_access.log
    app     /var/log/apache2/app_access.log
    EOF

Or, you can use this syntax:

    LOGS=$(cat /etc/fluent-agent.logs)
    
    ## in fluent-agent.logs
    www  /var/log/nginx/www_access.log
    app  /var/log/apache2/app_access.log

### TAG_PREFIX

Prefix of each tags, specified in 'LOGS'. 'TAG_PREFIX="service"' with 'LOGS' above, you will get fluentd messages with tags 'service.www' and 'service.app'.

### FIELD_NAME

Log line attribute name in fluentd message (default: 'message').

### PRIMARY_SERVER, SECONDARY_SERVER

Fluentd server name and port (SERVERNAME:PORT), as primary server. 'fluent-agent-lite' try to connect to primary server at first, and if fails, then try to connect secondary server (if it specified).

Default port is 24224 (if omitted).

### PRIMARY_SERVERS_LIST, SECONDARY_SERVERS_LIST

File path to specify primary(secondary) servers' list. 'fluent-agent-lite' reads this file when executed, and choose one of servers randomly at each connection trial.

You cannot specify both of 'PRIMARY\_SERVER' and 'PRIMARY\_SERVERS\_LIST', and both of 'SECONDARY\_SERVER' and 'SECONDARY\_SERVERS\_LIST'

### READ_BUFFER_SIZE

Bytes size which 'fluent-agent-lite' try to read from 'tail' at once (Default: 1MB).

### PROCESS_NICE

Nice value for 'fluent-agent-lite'. If you want to execute fluent-agent-lite in server with high loadavg, 'PROCESS_NICE="-1"' can help you.

### TAIL_PATH

Path of tail command (Default: /usr/bin/tail).