README
¶
Fireboard Input Plugin
The fireboard plugin gathers the real time temperature data from fireboard thermometers. In order to use this input plugin, you'll need to sign up to use the Fireboard REST API.
Configuration
[[inputs.fireboard]]
## Specify auth token for your account
auth_token = "invalidAuthToken"
## You can override the fireboard server URL if necessary
# url = https://fireboard.io/api/v1/devices.json
## You can set a different http_timeout if you need to
# http_timeout = 4
auth_token
In lieu of requiring a username and password, this plugin requires an authentication token that you can generate using the Fireboard REST API.
url
While there should be no reason to override the URL, the option is available in case Fireboard changes their site, etc.
http_timeout
If you need to increase the HTTP timeout, you can do so here. You can set this value in seconds. The default value is four (4) seconds.
Metrics
The Fireboard REST API docs have good examples of the data that is available, currently this input only returns the real time temperatures. Temperature values are included if they are less than a minute old.
- fireboard
- tags:
- channel
- scale (Celcius; Farenheit)
- title (name of the Fireboard)
- uuid (UUID of the Fireboard)
- fields:
- temperature (float, unit)
- tags:
Example Output
This section shows example output in Line Protocol format. You can often use
telegraf --input-filter <plugin-name> --test
or use the file
output to get
this information.
fireboard,channel=2,host=patas-mbp,scale=Farenheit,title=telegraf-FireBoard,uuid=b55e766c-b308-49b5-93a4-df89fe31efd0 temperature=78.2 1561690040000000000
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Fireboard ¶
type Fireboard struct { AuthToken string `toml:"auth_token"` URL string `toml:"url"` HTTPTimeout internal.Duration `toml:"http_timeout"` // contains filtered or unexported fields }
Fireboard gathers statistics from the fireboard.io servers
func NewFireboard ¶
func NewFireboard() *Fireboard
NewFireboard return a new instance of Fireboard with a default http client
func (*Fireboard) Description ¶
Description Returns a description of the plugin
func (*Fireboard) Gather ¶
func (r *Fireboard) Gather(acc telegraf.Accumulator) error
Gather Reads stats from all configured servers.
func (*Fireboard) SampleConfig ¶
SampleConfig Returns a sample configuration for the plugin