The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-ElasticSearch-Utilities-1.3
River stage zero No dependents
7 ++
/ es-metrics-to-graphite.pl

NAME

es-metrics-to-graphite.pl - Gather performance metrics from an ES node and send them to Graphite

VERSION

version 1.3

SYNOPSIS

es-metrics-to-graphite.pl --format=graphite --host [host] [options]

Options:

    --help              print help
    --manual            print full manual
    --local             Poll localhost and use name reported by ES
    --host|-H           Host to poll for statistics
    --format            stats Format (graphite or cacti) (Default: graphite)
    --carbon-base       The prefix to use for carbon metrics (Default: general.es)
    --carbon-server     Send Graphite stats to Carbon Server (Automatically sets format=graphite)
    --carbon-port       Port for to use for Carbon (Default: 2003)
    --carbon-proto      Protocol for to use for Carbon (Default: tcp)
    --verbose           Send additional messages to STDERR
    --with-indices      Also send individual index stats

DESCRIPTION

This is a plugin to poll elasticsearch for performance data and stats it in a relevant format for your monitoring infrastructure.

NAME

es-metrics-to-graphite.pl - Check Elastic Search Performance

OPTIONS

help

Print this message and exit

manual

Print this message and exit

local

Optional, check local host (if not specified, --host required)

host

Optional, the host to check (if not specified --local required)

format

stats format:

    graphite        Use format for graphite/carbon (default)
    cacti           For use with Cacti
carbon-base

The prefix to use for metrics sent to carbon. The default is "general.es". Please note, the host name of the ElasticSearch node will be appended, followed by the metric name.

carbon-server

Send stats to the carbon server specified. This automatically forces --format=graphite and does not produce stats on STDOUT

carbon-port

Use this port for the carbon server, useless without --carbon-server

with-indices

Also grab data at the individual index level

verbose

Verbose stats, to not interfere with cacti, output goes to STDERR

AUTHOR

Brad Lhotsky <brad@divisionbyzero.net>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2012 by Brad Lhotsky.

This is free software, licensed under:

  The (three-clause) BSD License