config

Documentation

Overview

This package handles all the configuration things.

Index

• type Configuration
  • func ReadConfig() Configuration
  • func (conf *Configuration) ForPlugin(name string) *PluginConfig
• type Options
• type PluginConfig
• type Query
  • func CreateQuery(name string, query string) Query
  • func (query *Query) Name() string
  • func (query *Query) QueryText() string

Types

type Configuration

type Configuration struct {
	Options Options
	// contains filtered or unexported fields
}

Configuration holds both the application config and the plugin configuration

func ReadConfig

func ReadConfig() Configuration

ReadConfig reads the configuration from the CLI options, the ENV vars and the config file

func (*Configuration) ForPlugin

func (conf *Configuration) ForPlugin(name string) *PluginConfig

ForPlugin get the configuration for the plugin name

type Options

type Options struct {
	Freq             time.Duration
	ElasticsearchURL *url.URL
	Port             int
	Config           string
	PluginDir        string
	Path             string
	TimeKey          string
}

Options holds all the application configuration

type PluginConfig

type PluginConfig struct {
	Options interface{}
	Queries []Query
}

PluginConfig the config struct for a plugin

type Query

type Query map[string]interface{}

Query all the options for a single query

func CreateQuery

func CreateQuery(name string, query string) Query

CreateQuery creates a valid Query instance

func (*Query) Name

func (query *Query) Name() string

Name the name of the query

func (*Query) QueryText

func (query *Query) QueryText() string

QueryText the query instruction