Record accessor limitation (#1015)

* administration/configuring-fluent-bit/classic-mode/record-accessor adding record accessos syntax limitation Signed-off-by: RicardoAAD <[email protected]> * administration/configuring-fluent-bit/classic-mode/record-accessor fixed links Signed-off-by: RicardoAAD <[email protected]> * administration:configuring-fluent-bit:classic-mode:record-accessor fixed links Signed-off-by: RicardoAAD <[email protected]> * administration:configuring-fluent-bit:classic-mode:record-accessor fixed links Signed-off-by: RicardoAAD <[email protected]> * administration:configuring-fluent-bit:classic-mode:record-accessor fixed links Signed-off-by: RicardoAAD <[email protected]> * pipeline:filters:ecs-metadata git Changed references to the record_accessor library limitation Signed-off-by: RicardoAAD <[email protected]> * pipeline:filters:ecs-metadata git Changed references to the record_accessor library limitation Signed-off-by: RicardoAAD <[email protected]> * pipeline:filters:ecs-metadata git Changed references to the record_accessor library limitation typos Signed-off-by: RicardoAAD <[email protected]> --------- Signed-off-by: RicardoAAD <[email protected]>
fluent · Oct 9, 2023 · e2dea2f · e2dea2f
1 parent c638eca
commit e2dea2f
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 21 deletions.
diff --git a/administration/configuring-fluent-bit/classic-mode/record-accessor.md b/administration/configuring-fluent-bit/classic-mode/record-accessor.md
@@ -95,3 +95,23 @@ Fluent Bit v1.x.x
 {"date":1599862267.483692,"log":"message 4","labels":{"color":"blue"}}
 ```
 
+### Limitations of record_accessor templating
+
+The Fluent Bit record_accessor library has a limitation in the characters that can separate template variables- only dots and commas (`.` and `,`) can come after a template variable. This is because the templating library must parse the template and determine the end of a variable.
+
+The following would be invalid templates because the two template variables are not separated by commas or dots:
+
+- `$TaskID-$ECSContainerName`
+- `$TaskID/$ECSContainerName`
+- `$TaskID_$ECSContainerName`
+- `$TaskIDfooo$ECSContainerName`
+
+However, the following are valid:
+- `$TaskID.$ECSContainerName`
+- `$TaskID.ecs_resource.$ECSContainerName`
+- `$TaskID.fooo.$ECSContainerName`
+
+And the following are valid since they only contain one template variable with nothing after it:
+- `fooo$TaskID`
+- `fooo____$TaskID`
+- `fooo/bar$TaskID`
diff --git a/pipeline/filters/ecs-metadata.md b/pipeline/filters/ecs-metadata.md
@@ -116,7 +116,8 @@ The output log would be similar to:
 }
 ```
 
-Notice that the template variables in the value for the `resource` key are separated by dot characters. Please see the section below about limitations in which characters can be used to separate template variables. 
+Notice that the template variables in the value for the `resource` key are separated by dot characters, only dots and commas
+ (`.` and `,`) can come after a template variable. For more information, please check the [Record accessor limitation's section](../../administration/configuring-fluent-bit/classic-mode/record-accessor.md#limitations-of-record_accessor-templating).
 
 #### Example 3: Attach cluster metadata to non-container logs
 
@@ -148,23 +149,3 @@ This examples shows a use case for the `Cluster_Metadata_Only` option- attaching
     Format json_lines
 ```
 
-### Limitations of record_accessor templating
-
-Notice in example 2, that the template values are separated by dot characters. This is important; the Fluent Bit record_accessor library has a limitation in the characters that can separate template variables- only dots and commas (`.` and `,`) can come after a template variable. This is because the templating library must parse the template and determine the end of a variable.
-
-The following would be invalid templates because the two template variables are not separated by commas or dots:
-
-- `$TaskID-$ECSContainerName`
-- `$TaskID/$ECSContainerName`
-- `$TaskID_$ECSContainerName`
-- `$TaskIDfooo$ECSContainerName`
-
-However, the following are valid:
-- `$TaskID.$ECSContainerName`
-- `$TaskID.ecs_resource.$ECSContainerName`
-- `$TaskID.fooo.$ECSContainerName`
-
-And the following are valid since they only contain one template variable with nothing after it:
-- `fooo$TaskID`
-- `fooo____$TaskID`
-- `fooo/bar$TaskID`