49 lines
1.4 KiB
Markdown
49 lines
1.4 KiB
Markdown
# Date Processor Plugin
|
|
|
|
Use the `date` processor to add the metric timestamp as a human readable tag.
|
|
|
|
A common use is to add a tag that can be used to group by month or year.
|
|
|
|
A few example usecases include:
|
|
1) consumption data for utilities on per month basis
|
|
2) bandwith capacity per month
|
|
3) compare energy production or sales on a yearly or monthly basis
|
|
|
|
### Configuration
|
|
|
|
```toml
|
|
[[processors.date]]
|
|
## New tag to create
|
|
tag_key = "month"
|
|
|
|
## Date format string, must be a representation of the Go "reference time"
|
|
## which is "Mon Jan 2 15:04:05 -0700 MST 2006".
|
|
date_format = "Jan"
|
|
|
|
## Offset duration added to the date string when writing the new tag.
|
|
# date_offset = "0s"
|
|
|
|
## Timezone to use when generating the date. This can be set to one of
|
|
## "Local", "UTC", or to a location name in the IANA Time Zone database.
|
|
## example: timezone = "America/Los_Angeles"
|
|
# timezone = "UTC"
|
|
```
|
|
|
|
#### timezone
|
|
|
|
On Windows, only the `Local` and `UTC` zones are available by default. To use
|
|
other timezones, set the `ZONEINFO` environment variable to the location of
|
|
[`zoneinfo.zip`][zoneinfo]:
|
|
```
|
|
set ZONEINFO=C:\zoneinfo.zip
|
|
```
|
|
|
|
### Example
|
|
|
|
```diff
|
|
- throughput lower=10i,upper=1000i,mean=500i 1560540094000000000
|
|
+ throughput,month=Jun lower=10i,upper=1000i,mean=500i 1560540094000000000
|
|
```
|
|
|
|
[zoneinfo]: https://github.com/golang/go/raw/50bd1c4d4eb4fac8ddeb5f063c099daccfb71b26/lib/time/zoneinfo.zip
|