Skip to content
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

[receiver/filelog] Add documentation about contents of the offset tracking file #31886

Merged

Conversation

ycombinator
Copy link
Contributor

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

@github-actions github-actions bot requested a review from djaglowski March 21, 2024 01:44
@ycombinator ycombinator force-pushed the doc-receiver-filelog-tracking-file branch from 3dd0ea2 to 32ec424 Compare March 21, 2024 23:23
@ycombinator ycombinator marked this pull request as ready for review March 21, 2024 23:49
@ycombinator ycombinator requested a review from a team March 21, 2024 23:49
@Frapschen Frapschen added the documentation Improvements or additions to documentation label Mar 22, 2024
Copy link
Contributor

@tiffany76 tiffany76 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tech writer here. Just a few suggestions to improve clarity. Thanks!

receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
@ycombinator ycombinator force-pushed the doc-receiver-filelog-tracking-file branch from 4ff3ecf to f9cd15a Compare March 25, 2024 23:02
@ycombinator ycombinator requested a review from tiffany76 March 25, 2024 23:05
Copy link
Contributor

@tiffany76 tiffany76 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
@ycombinator ycombinator force-pushed the doc-receiver-filelog-tracking-file branch from 02ead63 to 03c757b Compare March 28, 2024 20:26
@crobert-1 crobert-1 added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Mar 29, 2024
@ycombinator ycombinator force-pushed the doc-receiver-filelog-tracking-file branch 2 times, most recently from 22e5584 to 8211b78 Compare April 2, 2024 22:41
Copy link
Contributor

@tiffany76 tiffany76 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with some quick fixes.

receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
@ycombinator ycombinator requested a review from ChrsMark April 3, 2024 22:22
ycombinator and others added 10 commits April 3, 2024 15:23
Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>
Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>
Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>
Co-authored-by: Chris Mark <chrismarkou92@gmail.com>
Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>
Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>
@ycombinator ycombinator force-pushed the doc-receiver-filelog-tracking-file branch from 08405ad to ec98397 Compare April 3, 2024 22:23
@djaglowski djaglowski merged commit 1e51071 into open-telemetry:main Apr 4, 2024
142 checks passed
@github-actions github-actions bot added this to the next release milestone Apr 4, 2024
@ycombinator ycombinator deleted the doc-receiver-filelog-tracking-file branch April 4, 2024 18:29
djaglowski pushed a commit that referenced this pull request Apr 16, 2024
… 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation receiver/filelog Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants