Feedback from a newcomer on logging specs
#1,806 opened on Jul 8, 2021
Repository metrics
- Stars
- (4,267 stars)
- PR merge metrics
- (PR metrics pending)
Description
What are you trying to achieve?
I was reading the spec regarding the logs in attempt to understand what I can do to implement it.
What did you expect to see?
From reading the overview, it wasn’t at all clear that logs are meant to be shipped using OTLP, which is an established protocol one should be aware of.
After asking around, I learnt about OTLP. Having re-read the overview, I can see OTLP being mentioned, but I think there should be a section somewhere at the top that addresses it more explicitly. That section should say that the spec is about the wire format for log, and transport protocol is OTLP, it should also provide a short summary of what OTLP actually is.
Additionally, I found all reference to the collector in the overview document on logs rather confusing, I wished these were spared for a a blog post or some other content. This makes it seem like the spec is heavily tied to the current implementation of the collector, but from what I gathered it doesn't seem to be intended that way.