homeassistant.components.statsd Namespace Reference

Functions
bool	setup (HomeAssistant hass, ConfigType config)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_ATTR = "log_attributes"
string	CONF_RATE = "rate"
string	CONF_VALUE_MAP = "value_mapping"
	CONFIG_SCHEMA
string	DEFAULT_HOST = "localhost"
int	DEFAULT_PORT = 8125
string	DEFAULT_PREFIX = "hass"
int	DEFAULT_RATE = 1
string	DOMAIN = "statsd"

Detailed Description

Support for sending data to StatsD.

Function Documentation

setup()

bool homeassistant.components.statsd.setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the StatsD component.

Definition at line 45 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.statsd._LOGGER = logging.getLogger(__name__)

private

Definition at line 14 of file __init__.py.

CONF_ATTR

string homeassistant.components.statsd.CONF_ATTR = "log_attributes"

Definition at line 16 of file __init__.py.

CONF_RATE

string homeassistant.components.statsd.CONF_RATE = "rate"

Definition at line 17 of file __init__.py.

CONF_VALUE_MAP

string homeassistant.components.statsd.CONF_VALUE_MAP = "value_mapping"

Definition at line 18 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.statsd.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: vol.Schema(
            {
                vol.Required(CONF_HOST, default=DEFAULT_HOST): cv.string,
                vol.Optional(CONF_ATTR, default=False): cv.boolean,
                vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
                vol.Optional(CONF_PREFIX, default=DEFAULT_PREFIX): cv.string,
                vol.Optional(CONF_RATE, default=DEFAULT_RATE): vol.All(
                    vol.Coerce(int), vol.Range(min=1)
                ),
                vol.Optional(CONF_VALUE_MAP): dict,
            }
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 26 of file __init__.py.

DEFAULT_HOST

string homeassistant.components.statsd.DEFAULT_HOST = "localhost"

Definition at line 20 of file __init__.py.

DEFAULT_PORT

int homeassistant.components.statsd.DEFAULT_PORT = 8125

Definition at line 21 of file __init__.py.

DEFAULT_PREFIX

string homeassistant.components.statsd.DEFAULT_PREFIX = "hass"

Definition at line 22 of file __init__.py.

DEFAULT_RATE

int homeassistant.components.statsd.DEFAULT_RATE = 1

Definition at line 23 of file __init__.py.

DOMAIN

string homeassistant.components.statsd.DOMAIN = "statsd"

Definition at line 24 of file __init__.py.