templating

Documentation

Index

• Constants
• type Engine
  • func NewEngine(joiner string, defaultTemplate *Template, templates []string) (*Engine, error)
  • func (e *Engine) Apply(line string) (measurementName string, tags map[string]string, field string, err error)
• type Template
  • func NewDefaultTemplateWithPattern(pattern string) (*Template, error)
  • func NewTemplate(separator string, pattern string, defaultTags map[string]string) (*Template, error)
  • func (t *Template) Apply(line string, joiner string) (measurementName string, tags map[string]string, field string, err error)

Constants

const (
	// DefaultSeparator is the default separation character to use when separating template parts.
	DefaultSeparator = "."
)

Types

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

Engine uses a Matcher to retrieve the appropriate template and applies the template to the input string

func NewEngine

func NewEngine(joiner string, defaultTemplate *Template, templates []string) (*Engine, error)

NewEngine creates a new templating engine

func (*Engine) Apply

func (e *Engine) Apply(line string) (measurementName string, tags map[string]string, field string, err error)

Apply extracts the template fields from the given line and returns the measurement name, tags and field name

type Template

type Template struct {
	// contains filtered or unexported fields
}

Template represents a pattern and tags to map a metric string to an influxdb Point

func NewDefaultTemplateWithPattern

func NewDefaultTemplateWithPattern(pattern string) (*Template, error)

func NewTemplate

func NewTemplate(separator string, pattern string, defaultTags map[string]string) (*Template, error)

NewTemplate returns a new template ensuring it has a measurement specified.

func (*Template) Apply

func (t *Template) Apply(line string, joiner string) (measurementName string, tags map[string]string, field string, err error)

Apply extracts the template fields from the given line and returns the measurement name, tags and field name