:plugin: circonus
:type: output
:default_codec: plain

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Circonus output plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

This output sends annotations to Circonus based on Logstash events.


[id="plugins-{type}s-{plugin}-options"]
==== Circonus Output Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-annotation>> |<<hash,hash>>|Yes
| <<plugins-{type}s-{plugin}-api_token>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-app_name>> |<<string,string>>|Yes
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
output plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-annotation"]
===== `annotation` 

  * This is a required setting.
  * Value type is <<hash,hash>>
  * Default value is `{}`

Annotations
Registers an annotation with Circonus
The only required field is `title` and `description`.
`start` and `stop` will be set to the event timestamp.
You can add any other optional annotation values as well.
All values will be passed through `event.sprintf`

Example:
[source,ruby]
-----
  ["title":"Logstash event", "description":"Logstash event for %{host}"]
-----

or

[source,ruby]
-----
  ["title":"Logstash event", "description":"Logstash event for %{host}", "parent_id", "1"]
-----

[id="plugins-{type}s-{plugin}-api_token"]
===== `api_token` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

Your Circonus API Token

[id="plugins-{type}s-{plugin}-app_name"]
===== `app_name` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

Your Circonus App name
This will be passed through `event.sprintf`
so variables are allowed here:

Example:
 `app_name => "%{myappname}"`



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]

:default_codec!: