From e71b6bbd28dd9bf1e1fbbd1938cf31551099c9a6 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 13 Feb 2016 09:33:50 +0100 Subject: [PATCH] Add description of config vars --- source/_components/graphite.markdown | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/source/_components/graphite.markdown b/source/_components/graphite.markdown index 89e7209984d..8346d0b1410 100644 --- a/source/_components/graphite.markdown +++ b/source/_components/graphite.markdown @@ -11,18 +11,21 @@ logo: ha_category: History --- -Component that records all events and state changes and feeds the data to -a graphite installation. -Example configuration: +The `graphite` component records all events and state changes and feeds the data to a [graphite](http://graphite.wikidot.com/) instance. + +To enable this component, add the following lines to your `configuration.yaml`: ```yaml # Example configuration.yaml entry graphite: - host: foobar + host: IP_ADDRESS port: 2003 prefix: ha ``` -All config elements are optional, and assumed to be on localhost at the -default port if not specified. Prefix is the metric prefix in graphite, -and defaults to 'ha'. +Configuration variables: + +- **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`. +