influxdata / influxdata/telegraf
Telegraf and Tail Plugin Documenation Suggestion - State File
- Dominant language
- Go
- Stars
- 17.8k
- Forks
- 5.8k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 161
Description
### Use Case
If correct, I discovered - for Windows the following. I could not find any specifics on this. Perhaps, some hints could be added to the following:
https://github.com/influxdata/telegraf/blob/master/plugins/inputs/tail/README.md
https://github.com/influxdata/telegraf/blob/master/docs/CONFIGURATION.md#plugins
**For CONFIGURATION.md**
As required, for Windows, create a folder and let telegraf process create a state file under
[agent]
statefile = "C:\\ProgramData\\Telegraf\\telegraf.state"
For Windows (suggested location for an app/service):
Create folder (not state file):
C:\ProgramData\Telegraf
**For /tail/README.md**
In section with the following text "## Offset to start reading at", reference makeing a folder location for Windows and/or that it is documented in CONFIGURATION.md.
### Expected behavior
That documentation helps understand what is required for a state file when using Windows.
### Actual behavior
I couldn't find an references to making a state file folder on Windows.
### Additional info
_No response_
Contributor guide
Research direction
Start with plugins/inputs/tail/README.md and docs/CONFIGURATION.md#plugins, focusing on the “Offset to start reading at” section and the statefile setting. Add clear Windows guidance about creating the containing folder and using the suggested application or service location. Done means both documentation locations explain the required folder and state-file behavior consistently.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, operating-systems
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100