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 OTel Anti-Patterns blog post. Ref: #4043 #4044

Merged

Conversation

avillela
Copy link
Contributor

Add blog post on OTel Collector Anti-Patterns

Ref: #4043

@avillela avillela requested review from a team February 24, 2024 04:24
@svrnm svrnm requested review from a team and dmitryax and removed request for a team February 26, 2024 10:12
@svrnm
Copy link
Member

svrnm commented Feb 26, 2024

thanks @avillela ! Overall this looks good to me. I would like to get @open-telemetry/collector-approvers' review, to check all details

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.

Lovely post! Just some suggestions and nits.

Copy link
Member

@jpkrohling jpkrohling left a comment

Choose a reason for hiding this comment

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

Looks really good. I had a couple of comments, but other than that, :shipit:


## Anti-Patterns

### 1- Not using the OpenTelemetry Collector
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure how I feel about this one: there are certainly use-cases where people don't want or can't use a collector. For instance, people collecting data at the edge from IOT devices might have a better time sending data to their backend instead of a local collector, given that resources on that edge might be limited.

I would certainly state that having a Collector is a great general pattern, but not having it isn't necessarily an anti-pattern IMO.

Copy link
Member

Choose a reason for hiding this comment

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

I think it's great to use this one for attention grabbing. I agree that it'd need some explanation after the heading following @jpkrohling 's arguments.

Copy link
Member

Choose a reason for hiding this comment

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

The problem is that more people read the titles than the whole text, and that's the message they'll get and pass forward. Perhaps the title could be "1 - Not using the OTel Collector (with exceptions)" or something like that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jpkrohling @theletterf revised per the above comments. Let me know what you think!

third-parties (including vendors and individual community members), that are
useful to the OpenTelemetry community at large.

Neither Core nor Contrib is meant to be part of your production workload. Core
Copy link
Member

Choose a reason for hiding this comment

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

I don't think that's right. It's correct that we don't recommend contrib to be used in production, but core is certainly recommended, especially if all users need is a distribution with OTLP receivers and exporters, and a couple of processors in between, like the batch processor.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let me re-word that, because it's not that I'm saying to not use the components here. I'm just saying to not use these as THE distribution.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jpkrohling re-worded it. Let me know what you think!

avillela and others added 7 commits February 26, 2024 10:38
Co-authored-by: Fabrizio Ferri-Benedetti <fferribenedetti@splunk.com>
Co-authored-by: Fabrizio Ferri-Benedetti <fferribenedetti@splunk.com>
Co-authored-by: Fabrizio Ferri-Benedetti <fferribenedetti@splunk.com>
Co-authored-by: Fabrizio Ferri-Benedetti <fferribenedetti@splunk.com>
Co-authored-by: Juraci Paixão Kröhling <juraci.github@kroehling.de>
Copy link
Member

@jpkrohling jpkrohling left a comment

Choose a reason for hiding this comment

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

LGTM. I'd still use a different title for the first item, but that's your decision :-)

useful to the OpenTelemetry community at large.

Neither Core nor Contrib alone are meant to be part of your production workload.
Using just Core by itself is too bare-bones and wouldn’t suit an organization’s
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jpkrohling is this more of what you had in mind?

Copy link
Member

@cijothomas cijothomas left a comment

Choose a reason for hiding this comment

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

Excellent content!

@svrnm svrnm merged commit a998322 into open-telemetry:main Mar 1, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants