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.

Sign up for GitHub

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

Jump to bottom

[receiver/filelog] Add docs for offset tracking #30914

Merged
merged 3 commits into from
Feb 1, 2024
Merged

[receiver/filelog] Add docs for offset tracking #30914

merged 3 commits into from
Feb 1, 2024

Conversation

ChrsMark
Copy link
Member

Description:

This PR adds documentation notes on how to achieve fault tolerance on filelog's receiver offset tracking.
The need for this is obvious but was also explained at #20552 (comment).

Link to tracking Issue:

Testing:

Documentation:

@ChrsMark
[receiver/filelog] Add docs for offset tracking
655f325 
Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
@ChrsMark ChrsMark marked this pull request as ready for review January 31, 2024 13:21
@ChrsMark ChrsMark requested a review from a team January 31, 2024 13:21
@songy23 songy23 added documentation Improvements or additions to documentation Skip Changelog PRs that do not require a CHANGELOG.md entry labels Jan 31, 2024
djaglowski
djaglowski reviewed Jan 31, 2024
View reviewed changes
Copy link
Member

@djaglowski djaglowski left a comment

Choose a reason for hiding this comment

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

We already have some documentation for this under the storage parameter. Will you please update that parameter description to refer to this section, and ensure terminology is aligned? (i.e. entire doc should use offset or checkpoint but not both)

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
@ChrsMark
Improve descriptions and move config to examples folder
e9c7cf0 
Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
@ChrsMark
Copy link
Member Author

ChrsMark commented Feb 1, 2024 •
edited
Loading

Thank's for the feedback @djaglowski! I tried to get this aligned with your comments.
I'm not sure if we would like to be more descriptive/extensive in the examples/fault-tolerant-log-collection.
For now I only move the content there.
Let me know what you think.

djaglowski
djaglowski reviewed Feb 1, 2024
View reviewed changes
examples/fault-tolerant-logs-collection/otel-col-config.yaml Outdated Show resolved Hide resolved
receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
receiver/filelogreceiver/README.md Outdated Show resolved Hide resolved
@djaglowski
Copy link
Member

Thanks @ChrsMark. I've made some additional suggestions but I think we can get this merged with a few more tweaks.

@ChrsMark
address review comments
0be9d09 
Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
djaglowski
djaglowski approved these changes Feb 1, 2024
View reviewed changes
Copy link
Member

@djaglowski djaglowski left a comment

Choose a reason for hiding this comment

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

Thanks @ChrsMark

@djaglowski djaglowski merged commit 7319c8f into open-telemetry:main Feb 1, 2024
128 of 129 checks passed
@github-actions github-actions bot added this to the next release milestone Feb 1, 2024
cparkins pushed a commit to AmadeusITGroup/opentelemetry-collector-contrib that referenced this pull request Feb 1, 2024
@ChrsMark @cparkins
[receiver/filelog] Add docs for offset tracking (open-telemetry#30914)
e1aa852 
**Description:** <Describe what has changed.>
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->

This PR adds documentation notes on how to achieve fault tolerance on
`filelog`'s receiver offset tracking.
The need for this is obvious but was also explained at
open-telemetry#20552 (comment).

**Link to tracking Issue:** <Issue number if applicable>

**Testing:** <Describe what testing was performed and which tests were
added.>

**Documentation:** <Describe the documentation added.>

---------

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
@ChrsMark ChrsMark mentioned this pull request Feb 21, 2024
Merged
djaglowski pushed a commit that referenced this pull request Feb 21, 2024
@ChrsMark
Remove accidentaly added sample config (#31367)
e94acd7 
This PR removes the sample testing config that was added accidentally
with
#30914.

cc: @djaglowski

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
XinRanZhAWS pushed a commit to XinRanZhAWS/opentelemetry-collector-contrib that referenced this pull request Mar 13, 2024
@ChrsMark @XinRanZhAWS
Remove accidentaly added sample config (open-telemetry#31367)
7234f0a 
This PR removes the sample testing config that was added accidentally
with
open-telemetry#30914.

cc: @djaglowski

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
@ChrsMark ChrsMark deleted the add_offset_docs branch April 11, 2024 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@djaglowski djaglowski djaglowski approved these changes

Assignees

@songy23 songy23

Labels
documentation Improvements or additions to documentation receiver/filelog Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Milestone
v0.94.0
Development

Successfully merging this pull request may close these issues.
3 participants
@ChrsMark @djaglowski @songy23