README
¶
InfluxConnector
The influxconnector plugin enables the recording of various soundtouch message updates to an existing InfluxDB installation.
The plugin is enabled by including an [influxDB] section in your
configuration-toml file.
[influxDB]
## speakers for which messages should be logged. If empty, all
speakers = ["Office", "Kitchen"]
## log_messages describes the message types to be logged
## one or more of "ConnectionStateUpdated", "NowPlaying", "Volume"
## all if empty
log_messages = ["ConnectionStateUpdated", "NowPlaying", "Volume"]
## URL of the InfluxDB
influxURL = "http://influxdb:8086"
## Database where to store the events
database = "soundtouch"
#
## dry_run indicates that the plugin dumps lineporoto for the influxDB conncetion
## as curl statement.
# dry_run = true
##
If a connection to the provided influxDB can not be established, the plugin will be disabled after some 20 retries.
Documentation
¶
Index ¶
- type Config
- type InfluxDB
- func (d *InfluxDB) Description() string
- func (d *InfluxDB) Disable()
- func (d *InfluxDB) Enable()
- func (d *InfluxDB) Execute(pluginName string, update soundtouch.Update, speaker soundtouch.Speaker)
- func (d *InfluxDB) IsEnabled() bool
- func (d *InfluxDB) Name() string
- func (d *InfluxDB) SampleConfig() string
- func (d *InfluxDB) Terminate() bool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
InfluxURL string `toml:"influxURL"`
Database string `toml:"database"`
Speakers []string `toml:"speakers"`
LogMessages []string `toml:"log_messages"`
DryRun bool `toml:"dry_run"`
}
Config contains the configuration of the plugin Speakers list of SpeakerNames the handler is added. All if empty IgnoreMessages a list of message types to be ignored
type InfluxDB ¶
type InfluxDB struct {
Config
Plugin soundtouch.PluginFunc
// contains filtered or unexported fields
}
InfluxDB describes the plugin. It has a Config to store the configuration Plugin the plugin function suspended indicates that the plugin is temporarely suspended
func (*InfluxDB) Description ¶
Description returns a string explaining the purpose of this plugin
func (*InfluxDB) Disable ¶
func (d *InfluxDB) Disable()
Disable temporarely the execution of the plugin
func (*InfluxDB) Enable ¶
func (d *InfluxDB) Enable()
Enable temporarely the execution of the plugin
func (*InfluxDB) SampleConfig ¶
SampleConfig returns text explaining how plugin should be configured
Source Files