Add description of config vars

This commit is contained in:
Fabian Affolter 2016-02-13 09:33:50 +01:00
parent 944c7a40e4
commit e71b6bbd28

View File

@ -11,18 +11,21 @@ logo:
ha_category: History ha_category: History
--- ---
Component that records all events and state changes and feeds the data to The `graphite` component records all events and state changes and feeds the data to a [graphite](http://graphite.wikidot.com/) instance.
a graphite installation.
Example configuration: To enable this component, add the following lines to your `configuration.yaml`:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
graphite: graphite:
host: foobar host: IP_ADDRESS
port: 2003 port: 2003
prefix: ha prefix: ha
``` ```
All config elements are optional, and assumed to be on localhost at the Configuration variables:
default port if not specified. Prefix is the metric prefix in graphite,
and defaults to 'ha'. - **host** (*Option*): IP address of your graphite host, eg. http://192.168.1.10. Defaults to `localhost`
- **port** (*Optional*): Port to use. Defaults to 2003.
- **prefix** (*Optional*): Prefix is the metric prefix in graphite. Defaults to `ha`.