-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[extension/storage/filestorage] Document structure of local file storage files #30970
Comments
Pinging code owners:
See Adding Labels via Comments if you do not have permissions to add labels yourself. |
I'm open to simple solutions here but don't think this is worth increasing the maintenance burden.
Can we just document this? |
I think that would be great, at least for now. |
Thanks @ycombinator, do you mind opening a PR documenting your example? |
…cking file (#31886) **Description:** This PR adds documentation explaining how to interpret the contents of the `filelog` receiver's offset tracking file, configured using the `storage` extension. **Link to tracking Issue:** #30970 --------- Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com> Co-authored-by: Chris Mark <chrismarkou92@gmail.com> Co-authored-by: Daniel Jaglowski <jaglows3@gmail.com>
… the `file_storage` extension (#32180) **Description:** This PR adds documentation explaining how to read the contents of files created by the `file_storage` extension. **Link to tracking Issue:** * Related to #30970 * Follow up to #31886 (comment) --------- Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>
This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping Pinging code owners:
See Adding Labels via Comments if you do not have permissions to add labels yourself. |
Resolved by #32180 |
Component(s)
extension/storage/filestorage
Is your feature request related to a problem? Please describe.
When the
filestorage
extension is used, a binary file is created on the local filesystem to persist the state being managed by the extension. For easily debugging this state it would be convenient to have a way to read the contents of this file in a human-readable fashion.As a concrete example, if the
filestorage
extension is configured as thestorage
for thefilelog
receiver, it would be convenient to see a human-readable version of the contents of the binary file to debug:filelog
receiver, andfilelog
receiverDescribe the solution you'd like
[UPDATE] Per the discussion in this issue, the decision is, at least for now, to simply document that we can read the binary files by using
strings /path/to/binary/file
and also the structure of the results.I'm open to ideas here but one that comes to mind is a command-line utility or a collector sub-command that could take as input a collector configuration and the ID of a component in the configuration that's using the
filestorage
extension and print out a human-readable version of the corresponding binary file being managed by the extension for that component.Whatever solution is chosen, even if it is the alternative described below, we should document how to use it.
Describe alternatives you've considered
At the moment, I'm just running
strings /path/to/binary/file
. The results are quite good with this approach, e.g.Additional context
No response
The text was updated successfully, but these errors were encountered: