feat(operator): User-guide for OTLP configuration #14620
Conversation
|
Marked as a draft, because I want to give it a second read as well. But please feel free to review already 🙂 |
|
|
||
| Because OTLP is not specifically geared towards Loki but is a standard format, it needs additional configuration on Loki's side to map the OpenTelemetry data format to Loki's data model. | ||
|
|
||
| Specifically, OTLP has no concept of "stream labels" or "structured metadata". OTLP instead provides metadata about a log entry in _attributes_ that are grouped into three buckets (resource, scope and log), depending on the number of entries an attribute applies to. |
There was a problem hiding this comment.
At the end of this phrase, I'm unsure what you mean: "depending on the number of entries an attribute applies to."
There was a problem hiding this comment.
I had rewritten this paragraph on the second try. Can you check, if the new text makes this clearer?
There was a problem hiding this comment.
Yes much better 👍
|
|
||
| Once the `effectiveDate` has passed your `LokiStack` will be using the new schema configuration and is ready to store structured metadata. | ||
|
|
||
| ## Attribute Mapping |
There was a problem hiding this comment.
Should we briefly describe the difference between stream label & structured metadata? In this section or other section that you find relevant
There was a problem hiding this comment.
I tried getting around that by linking to the stream-label / structured-metadata documentation on the Loki site. Another idea I had, was for us to have a few "concepts" pages where we can describe things like stream-labels, structured-metadata, schema versions and so on.
I'll think about this again. Maybe it makes sense to make this distinction clear in this document as well in a short paragraph.
|
|
||
| Once the `effectiveDate` has passed your `LokiStack` will be using the new schema configuration and is ready to store structured metadata. | ||
|
|
||
| ## Attribute Mapping |
There was a problem hiding this comment.
I tried getting around that by linking to the stream-label / structured-metadata documentation on the Loki site. Another idea I had, was for us to have a few "concepts" pages where we can describe things like stream-labels, structured-metadata, schema versions and so on.
I'll think about this again. Maybe it makes sense to make this distinction clear in this document as well in a short paragraph.
|
|
||
| Because OTLP is not specifically geared towards Loki but is a standard format, it needs additional configuration on Loki's side to map the OpenTelemetry data format to Loki's data model. | ||
|
|
||
| Specifically, OTLP has no concept of "stream labels" or "structured metadata". OTLP instead provides metadata about a log entry in _attributes_ that are grouped into three buckets (resource, scope and log), depending on the number of entries an attribute applies to. |
There was a problem hiding this comment.
I had rewritten this paragraph on the second try. Can you check, if the new text makes this clearer?
What this PR does / why we need it:
This PR provides a user-guide for setting up the OTLP configuration using the LokiStack resource provided by the Loki Operator to be displayed on the operator's website.
Which issue(s) this PR fixes:
Special notes for your reviewer:
Checklist
CONTRIBUTING.mdguide (required)