telegraf/plugins/processors/s2geo
reimda 34eff493ae
chore: Fix readme linter errors for processor, aggregator, and parser plugins (#10960)
2022-06-06 17:04:28 -06:00
..
README.md chore: Fix readme linter errors for processor, aggregator, and parser plugins (#10960) 2022-06-06 17:04:28 -06:00
s2geo.go chore: correctly spell embed (#11200) 2022-05-27 07:13:47 -06:00
s2geo_test.go feat: migrate processor plugins to new sample config format (#10913) 2022-04-06 14:49:41 -06:00
sample.conf chore(processors): migrate sample configs into separate files (#11125) 2022-05-18 11:29:43 -05:00

README.md

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

# Add the S2 Cell ID as a tag based on latitude and longitude fields
[[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