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

Add container parser blog post #4489

Merged
merged 6 commits into from
May 22, 2024

Conversation

ChrsMark
Copy link
Member

@ChrsMark ChrsMark commented May 15, 2024

This PR adds a blog post about the new filelogreceiver's container parser which was introduced with open-telemetry/opentelemetry-collector-contrib#31959.

/cc @djaglowski

Preview: https://deploy-preview-4489--opentelemetry.netlify.app/blog/2024/otel-collector-container-log-parser/

@ChrsMark ChrsMark changed the title Add container parser blogpost Add container parser blog post May 15, 2024
@ChrsMark ChrsMark force-pushed the add_container_parser_blog_post branch from 4da29cf to d08fbe5 Compare May 15, 2024 15:16
@github-actions github-actions bot added the blog label May 15, 2024
@ChrsMark ChrsMark force-pushed the add_container_parser_blog_post branch 9 times, most recently from 97da040 to 47528d1 Compare May 15, 2024 16:43
@ChrsMark ChrsMark marked this pull request as ready for review May 15, 2024 16:46
@ChrsMark ChrsMark requested review from a team as code owners May 15, 2024 16:46
@svrnm svrnm requested review from a team and bogdandrutu and removed request for a team May 16, 2024 08:13
@svrnm
Copy link
Member

svrnm commented May 16, 2024

@open-telemetry/collector-approvers please take a look as well, thx!

@ChrsMark ChrsMark force-pushed the add_container_parser_blog_post branch from ad5c294 to 24a1f28 Compare May 16, 2024 10:59
@ChrsMark ChrsMark requested review from svrnm and chalin May 16, 2024 13:40
@ChrsMark ChrsMark force-pushed the add_container_parser_blog_post branch 4 times, most recently from 9f7ee5b to 83a055c Compare May 17, 2024 10:36
Copy link
Member

@theletterf theletterf left a comment

Choose a reason for hiding this comment

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

Just a language edit. Nice post and feature!

Comment on lines 35 to 39
operators together. The end result is rather complex, and this configuration
complexity can be mitigated by using the corresponding
[helm chart preset](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-collector#configuration-for-kubernetes-container-logs).
However, despite having the preset, it can still be challenging for users to
maintain and troubleshoot such advanced configurations.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
operators together. The end result is rather complex, and this configuration
complexity can be mitigated by using the corresponding
[helm chart preset](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-collector#configuration-for-kubernetes-container-logs).
However, despite having the preset, it can still be challenging for users to
maintain and troubleshoot such advanced configurations.
operators together. The end result is rather complex. This configuration
complexity can be mitigated by using the corresponding
[helm chart preset](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-collector#configuration-for-kubernetes-container-logs).
However, despite having the preset, it can still be challenging for users to
maintain and troubleshoot such advanced configurations.

Style nit: In some parts you use first person plural ("we"), in others you switch to passive voice ("it can be..."). I recommend to select a single voice and stick to it, preferably second person, which is more engaging ("You can...").

Comment on lines 160 to 163
In order to implement that parser operator most of the code was written from
scratch, but we were able to re-use the recombine operator internally for the
partial logs parsing. In order to achieve this some small refactoring was
required but this gave us the opportunity to re-use an already existent and well
tested component.
Copy link
Member

Choose a reason for hiding this comment

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

You can remove most of the "In order"s.

required but this gave us the opportunity to re-use an already existent and well
tested component.

Additionally, during the discussions around the implementation of this feature,
Copy link
Member

Choose a reason for hiding this comment

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

Similarly, you can remove most of the opening adverbs. It'll flow better.

@ChrsMark ChrsMark force-pushed the add_container_parser_blog_post branch 2 times, most recently from ff3a2a4 to f0033ce Compare May 17, 2024 13:39
operators:
- id: container-parser
type: container
```
Copy link
Member

Choose a reason for hiding this comment

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

How about showing the comparison to the config previously (with the container parser) required (that you mention in the issue above: open-telemetry/opentelemetry-collector-contrib#31959)?
Or at least mention that the config now is 8 lines long vs. ~80 lines to achieve the same result.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point! Added at 44778bd, thank's.

@ChrsMark ChrsMark requested a review from theletterf May 20, 2024 07:52
@ChrsMark ChrsMark force-pushed the add_container_parser_blog_post branch from 44778bd to aec5a1b Compare May 22, 2024 10:49
@ChrsMark
Copy link
Member Author

@svrnm @theletterf thank's for the feedback. I have tried to address your comments. Feel free to take another look.

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
@ChrsMark ChrsMark force-pushed the add_container_parser_blog_post branch from aec5a1b to db56d91 Compare May 22, 2024 10:49
@svrnm svrnm merged commit b15af70 into open-telemetry:main May 22, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants