From 7094618bae392161d638c27c287995aeeebbfc27 Mon Sep 17 00:00:00 2001 From: Robert Jacob Date: Mon, 7 Oct 2024 20:48:53 +0200 Subject: [PATCH] Update API docs --- operator/docs/operator/api.md | 64 ++++++++++++++++++++++++++++++----- 1 file changed, 56 insertions(+), 8 deletions(-) diff --git a/operator/docs/operator/api.md b/operator/docs/operator/api.md index 79bccd04859ce..3f8eecb452c1d 100644 --- a/operator/docs/operator/api.md +++ b/operator/docs/operator/api.md @@ -2617,6 +2617,46 @@ string +## OTLPAttributeReference { #loki-grafana-com-v1-OTLPAttributeReference } +

+(Appears on:OTLPMetadataSpec, OTLPStreamLabelSpec) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +
+

Name contains either a verbatim name of an attribute or a regular expression matching many attributes.

+
+regex
+ +bool + +
+(Optional) +

If Regex is true, then Name is treated as a regular expression instead of as a verbatim attribute name.

+
+ ## OTLPMetadataSpec { #loki-grafana-com-v1-OTLPMetadataSpec }

(Appears on:OTLPSpec) @@ -2635,7 +2675,9 @@ string resourceAttributes
-[]string + +[]OTLPAttributeReference + @@ -2647,7 +2689,9 @@ string scopeAttributes
-[]string + +[]OTLPAttributeReference + @@ -2659,7 +2703,9 @@ string logAttributes
-[]string + +[]OTLPAttributeReference + @@ -2735,7 +2781,9 @@ OTLPMetadataSpec resourceAttributes
-[]string + +[]OTLPAttributeReference + @@ -3035,16 +3083,16 @@ It needs to be in the same namespace as the LokiStack custom resource.

-disableRecommendedLabels
+disableRecommendedAttributes
bool (Optional) -

DisableRecommendedLabels can be used to remove the set of “recommended labels” from the generated Loki configuration. -This will cause meta information to not be available as stream labels or structured metadata, potentially making -queries more expensive and less performant.

+

Enabling this setting removes the “recommended attributes” from the generated Loki configuration. This will cause +meta information to not be available as stream labels or structured metadata, +potentially making queries more expensive and less performant.

This option is supposed to be combined with a custom label configuration customizing the labels for the specific usecase.