geo

README

S2 Geo Processor Plugin

Use the s2geo processor to add tag with S2 cell ID token of specified cell level. The tag is used in experimental/geo Flux package functions. The lat and lon fields values should contain WGS-84 coordinates in decimal degrees.

Configuration

[[processors.s2geo]]
  ## The name of the lat and lon fields containing WGS-84 latitude and
  ## longitude in decimal degrees.
  # lat_field = "lat"
  # lon_field = "lon"

  ## New tag to create
  # tag_key = "s2_cell_id"

  ## Cell level (see https://s2geometry.io/resources/s2cell_statistics.html)
  # cell_level = 9

Example

- mta,area=llir,id=GO505_20_2704,status=1 lat=40.878738,lon=-72.517572 1560540094
+ mta,area=llir,id=GO505_20_2704,status=1,s2_cell_id=89e8ed4 lat=40.878738,lon=-72.517572 1560540094

Documentation

Index

• Variables
• type Geo
  • func (g *Geo) Apply(in ...telegraf.Metric) []telegraf.Metric
  • func (g *Geo) Description() string
  • func (g *Geo) Init() error
  • func (g *Geo) SampleConfig() string

Variables

var SampleConfig = `` /* 299-byte string literal not displayed */

Types

type Geo

type Geo struct {
	LatField  string `toml:"lat_field"`
	LonField  string `toml:"lon_field"`
	TagKey    string `toml:"tag_key"`
	CellLevel int    `toml:"cell_level"`
}

func (*Geo) Apply

func (g *Geo) Apply(in ...telegraf.Metric) []telegraf.Metric

func (*Geo) Description

func (g *Geo) Description() string

func (*Geo) Init

func (g *Geo) Init() error

func (*Geo) SampleConfig

func (g *Geo) SampleConfig() string