Documentation ¶
Index ¶
- type Config
- type Parser
- func NewCollectdParser(authFile string, securityLevel string, typesDB []string, split string) (Parser, error)
- func NewDropwizardParser(metricRegistryPath string, timePath string, timeFormat string, tagsPath string, ...) (Parser, error)
- func NewFormUrlencodedParser(metricName string, defaultTags map[string]string, tagKeys []string) (Parser, error)
- func NewGraphiteParser(separator string, templates []string, defaultTags map[string]string) (Parser, error)
- func NewInfluxParser() (Parser, error)
- func NewLogFmtParser(metricName string, defaultTags map[string]string) (Parser, error)
- func NewNagiosParser() (Parser, error)
- func NewParser(config *Config) (Parser, error)
- func NewValueParser(metricName string, dataType string, defaultTags map[string]string) (Parser, error)
- func NewWavefrontParser(defaultTags map[string]string) (Parser, error)
- type ParserFunc
- type ParserFuncInput
- type ParserInput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct { // Dataformat can be one of: json, influx, graphite, value, nagios DataFormat string `toml:"data_format"` // Separator only applied to Graphite data. Separator string `toml:"separator"` // Templates only apply to Graphite data. Templates []string `toml:"templates"` // TagKeys only apply to JSON data TagKeys []string `toml:"tag_keys"` // Array of glob pattern strings keys that should be added as string fields. JSONStringFields []string `toml:"json_string_fields"` JSONNameKey string `toml:"json_name_key"` // MetricName applies to JSON & value. This will be the name of the measurement. MetricName string `toml:"metric_name"` // holds a gjson path for json parser JSONQuery string `toml:"json_query"` // key of time JSONTimeKey string `toml:"json_time_key"` // time format JSONTimeFormat string `toml:"json_time_format"` // default timezone JSONTimezone string `toml:"json_timezone"` // Whether to continue if a JSON object can't be coerced JSONStrict bool `toml:"json_strict"` // Authentication file for collectd CollectdAuthFile string `toml:"collectd_auth_file"` // One of none (default), sign, or encrypt CollectdSecurityLevel string `toml:"collectd_security_level"` // Dataset specification for collectd CollectdTypesDB []string `toml:"collectd_types_db"` // whether to split or join multivalue metrics CollectdSplit string `toml:"collectd_split"` // DataType only applies to value, this will be the type to parse value to DataType string `toml:"data_type"` // DefaultTags are the default tags that will be added to all parsed metrics. DefaultTags map[string]string `toml:"default_tags"` // an optional json path containing the metric registry object // if left empty, the whole json object is parsed as a metric registry DropwizardMetricRegistryPath string `toml:"dropwizard_metric_registry_path"` // an optional json path containing the default time of the metrics // if left empty, the processing time is used DropwizardTimePath string `toml:"dropwizard_time_path"` // time format to use for parsing the time field // defaults to time.RFC3339 DropwizardTimeFormat string `toml:"dropwizard_time_format"` // an optional json path pointing to a json object with tag key/value pairs // takes precedence over DropwizardTagPathsMap DropwizardTagsPath string `toml:"dropwizard_tags_path"` // an optional map containing tag names as keys and json paths to retrieve the tag values from as values // used if TagsPath is empty or doesn't return any tags DropwizardTagPathsMap map[string]string `toml:"dropwizard_tag_paths_map"` //grok patterns GrokPatterns []string `toml:"grok_patterns"` GrokNamedPatterns []string `toml:"grok_named_patterns"` GrokCustomPatterns string `toml:"grok_custom_patterns"` GrokCustomPatternFiles []string `toml:"grok_custom_pattern_files"` GrokTimezone string `toml:"grok_timezone"` GrokUniqueTimestamp string `toml:"grok_unique_timestamp"` //csv configuration CSVColumnNames []string `toml:"csv_column_names"` CSVColumnTypes []string `toml:"csv_column_types"` CSVComment string `toml:"csv_comment"` CSVDelimiter string `toml:"csv_delimiter"` CSVHeaderRowCount int `toml:"csv_header_row_count"` CSVMeasurementColumn string `toml:"csv_measurement_column"` CSVSkipColumns int `toml:"csv_skip_columns"` CSVSkipRows int `toml:"csv_skip_rows"` CSVTagColumns []string `toml:"csv_tag_columns"` CSVTimestampColumn string `toml:"csv_timestamp_column"` CSVTimestampFormat string `toml:"csv_timestamp_format"` CSVTrimSpace bool `toml:"csv_trim_space"` // FormData configuration FormUrlencodedTagKeys []string `toml:"form_urlencoded_tag_keys"` }
Config is a struct that covers the data types needed for all parser types, and can be used to instantiate _any_ of the parsers.
type Parser ¶
type Parser interface { // Parse takes a byte buffer separated by newlines // ie, `cpu.usage.idle 90\ncpu.usage.busy 10` // and parses it into telegraf metrics // // Must be thread-safe. Parse(buf []byte) ([]telegraf.Metric, error) // ParseLine takes a single string metric // ie, "cpu.usage.idle 90" // and parses it into a telegraf metric. // // Must be thread-safe. ParseLine(line string) (telegraf.Metric, error) // SetDefaultTags tells the parser to add all of the given tags // to each parsed metric. // NOTE: do _not_ modify the map after you've passed it here!! SetDefaultTags(tags map[string]string) }
Parser is an interface defining functions that a parser plugin must satisfy.
func NewCollectdParser ¶
func NewDropwizardParser ¶
func NewFormUrlencodedParser ¶
func NewGraphiteParser ¶
func NewInfluxParser ¶
func NewLogFmtParser ¶
NewLogFmtParser returns a logfmt parser with the default options.
func NewNagiosParser ¶
func NewValueParser ¶
type ParserFunc ¶
type ParserFuncInput ¶
type ParserFuncInput interface { // GetParser returns a new parser. SetParserFunc(fn ParserFunc) }
ParserFuncInput is an interface for input plugins that are able to parse arbitrary data formats.
type ParserInput ¶
type ParserInput interface { // SetParser sets the parser function for the interface SetParser(parser Parser) }
ParserInput is an interface for input plugins that are able to parse arbitrary data formats.
Click to show internal directories.
Click to hide internal directories.