IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« irc juggernaut »
Elastic Docs ›Logstash Reference [1.5] ›Logstash Reference ›Output plugins

influxdb

edit

influxdb

edit

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/plugin install logstash-output-influxdb.

This output lets you output Metrics to InfluxDB

The configuration here attempts to be as friendly as possible and minimize the need for multiple definitions to write to multiple series and still be efficient

the InfluxDB API let’s you do some semblance of bulk operation per http call but each call is database-specific

You can learn more at InfluxDB homepage

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

influxdb {
    data_points => ...
    host => ...
    password => ...
    user => ...
}

Available configuration options:

Setting Input type Required Default value

allow_time_override

boolean

No

false

codec

codec

No

"plain"

coerce_values

hash

No

{}

data_points

hash

Yes

{}

db

string

No

"stats"

flush_size

number

No

100

host

string

Yes

idle_flush_time

number

No

1

password

password

Yes

nil

port

number

No

8086

series

string

No

"logstash"

time_precision

string, one of ["m", "s", "u"]

No

"s"

user

string

Yes

nil

workers

number

No

1

Details

edit

 

allow_time_override

edit
  • Value type is boolean
  • Default value is false

Allow the override of the time column in the event?

By default any column with a name of time will be ignored and the time will be determined by the value of @timestamp.

Setting this to true allows you to explicitly set the time column yourself

Note: time must be an epoch value in either seconds, milliseconds or microseconds

codec

edit
  • Value type is 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.

coerce_values

edit
  • Value type is hash
  • Default value is {}

Allow value coercion

this will attempt to convert data point values to the appropriate type before posting otherwise sprintf-filtered numeric values could get sent as strings format is {'column_name' => 'datatype'}

currently supported datatypes are integer and float

data_points

edit
  • This is a required setting.
  • Value type is hash
  • Default value is {}

Hash of key/value pairs representing data points to send to the named database Example: {'column1' => 'value1', 'column2' => 'value2'}

Events for the same series will be batched together where possible Both keys and values support sprintf formatting

db

edit
  • Value type is string
  • Default value is "stats"

The database to write

exclude_tags (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Optional.

flush_size

edit
  • Value type is number
  • Default value is 100

This setting controls how many events will be buffered before sending a batch of events. Note that these are only batched for the same series

host

edit
  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

The hostname or IP address to reach your InfluxDB instance

idle_flush_time

edit
  • Value type is number
  • Default value is 1

The amount of time since last flush before a flush is forced.

This setting helps ensure slow event rates don’t get stuck in Logstash. For example, if your flush_size is 100, and you have received 10 events, and it has been more than idle_flush_time seconds since the last flush, logstash will flush those 10 events automatically.

This helps keep both fast and slow log streams moving along in near-real-time.

password

edit
  • This is a required setting.
  • Value type is password
  • Default value is nil

The password for the user who access to the named database

port

edit
  • Value type is number
  • Default value is 8086

The port for InfluxDB

series

edit
  • Value type is string
  • Default value is "logstash"

Series name - supports sprintf formatting

tags (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Optional.

time_precision

edit
  • Value can be any of: m, s, u
  • Default value is "s"

Set the level of precision of time

only useful when overriding the time value

type (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s type attribute for more. Optional.

user

edit
  • This is a required setting.
  • Value type is string
  • Default value is nil

The user who has access to the named database

workers

edit
  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.

« irc juggernaut »