﻿---
title: Ganglia output plugin
description: Plugin version: v3.0.6 (Other versions), Released on: 2018-04-06, Changelog. For questions about the plugin, open a topic in the Discuss forums. For bugs...
url: https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/lsr/plugins-outputs-ganglia
---

# Ganglia output plugin
- Plugin version: v3.0.6 ([Other versions](https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/output-ganglia-index))
- Released on: 2018-04-06
- [Changelog](https://github.com/logstash-plugins/logstash-output-ganglia/blob/v3.0.6/CHANGELOG.md)


## Getting help

For questions about the plugin, open a topic in the [Discuss](http://discuss.elastic.co) forums. For bugs or feature requests, open an issue in [Github](https://github.com/logstash-plugins/logstash-output-ganglia). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins).

## Description

This output allows you to pull metrics from your logs and ship them to ganglia’s gmond. This is heavily based on the graphite output.

## Ganglia Output Configuration Options

This plugin supports the following configuration options plus the [Common options](#plugins-outputs-ganglia-common-options) described later.

| Setting                                                               | Input type                                                                                                                                                                | Required |
|-----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| [`group`](#plugins-outputs-ganglia-group)`group`                      | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                                                                                | No       |
| [`host`](#plugins-outputs-ganglia-host)`host`                         | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                                                                                | No       |
| [`lifetime`](#plugins-outputs-ganglia-lifetime)`lifetime`             | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number                                                                                                | No       |
| [`max_interval`](#plugins-outputs-ganglia-max_interval)`max_interval` | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number                                                                                                | No       |
| [`metric`](#plugins-outputs-ganglia-metric)`metric`                   | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                                                                                | Yes      |
| [`metric_type`](#plugins-outputs-ganglia-metric_type)`metric_type`    | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string, one of `["string", "int8", "uint8", "int16", "uint16", "int32", "uint32", "float", "double"]` | No       |
| [`port`](#plugins-outputs-ganglia-port)`port`                         | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number                                                                                                | No       |
| [`slope`](#plugins-outputs-ganglia-slope)`slope`                      | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string, one of `["zero", "positive", "negative", "both", "unspecified"]`                              | No       |
| [`units`](#plugins-outputs-ganglia-units)`units`                      | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                                                                                | No       |
| [`value`](#plugins-outputs-ganglia-value)`value`                      | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                                                                                | Yes      |

Also see [Common options](#plugins-outputs-ganglia-common-options) for a list of options supported by all output plugins.

### `group`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `""`

Metric group

### `host`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `"localhost"`

The address of the ganglia server.

### `lifetime`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `300`

Lifetime in seconds of this metric

### `max_interval`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `60`

Maximum time in seconds between gmetric calls for this metric.

### `metric`

- This is a required setting.
- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- There is no default value for this setting.

The metric to use. This supports dynamic strings like `%{host}`

### `metric_type`

- Value can be any of: `string`, `int8`, `uint8`, `int16`, `uint16`, `int32`, `uint32`, `float`, `double`
- Default value is `"uint8"`

The type of value for this metric.

### `port`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `8649`

The port to connect on your ganglia server.

### `slope`

- Value can be any of: `zero`, `positive`, `negative`, `both`, `unspecified`
- Default value is `"both"`

Metric slope, represents metric behavior

### `units`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `""`

Gmetric units for metric, such as "kb/sec" or "ms" or whatever unit this metric uses.

### `value`

- This is a required setting.
- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- There is no default value for this setting.

The value to use. This supports dynamic strings like `%{bytes}` It will be coerced to a floating point value. Values which cannot be coerced will zero (0)

## Common options

These configuration options are supported by all output plugins:

| Setting                                                                  | Input type                                                                    | Required |
|--------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------|
| [`codec`](#plugins-outputs-ganglia-codec)`codec`                         | [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#codec)codec       | No       |
| [`enable_metric`](#plugins-outputs-ganglia-enable_metric)`enable_metric` | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean | No       |
| [`id`](#plugins-outputs-ganglia-id)`id`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |


### `codec`

- Value type is [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#codec)
- Default value is `"plain"`

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output without needing a separate filter in your Logstash pipeline.

### `enable_metric`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)
- Default value is `true`

Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

### `id`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- There is no default value for this setting.

Add a unique `ID` to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 ganglia outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
```
output {
  ganglia {
    id => "my_plugin_id"
  }
}
```