improve dsl docs (elastic#36750)

Scholar-Li · Feb 5, 2024 · 475f11a · 475f11a
1 parent 9ad0dae
commit 475f11a
Show file tree

Hide file tree

Showing 15 changed files with 45 additions and 1 deletion.
diff --git a/auditbeat/auditbeat.reference.yml b/auditbeat/auditbeat.reference.yml
@@ -1348,6 +1348,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is auditbeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "auditbeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -1362,6 +1364,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/filebeat/filebeat.reference.yml b/filebeat/filebeat.reference.yml
@@ -2444,6 +2444,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is filebeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "filebeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -2458,6 +2460,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/heartbeat/heartbeat.reference.yml b/heartbeat/heartbeat.reference.yml
@@ -1440,6 +1440,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is heartbeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "heartbeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -1454,6 +1456,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/libbeat/_meta/config/setup.dsl.reference.yml.tmpl b/libbeat/_meta/config/setup.dsl.reference.yml.tmpl
@@ -8,6 +8,8 @@
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is {{.BeatName}}-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "{{.BeatName}}-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -21,4 +23,4 @@
 #setup.dsl.check_exists: true
 
 # Overwrite the lifecycle policy at startup. The default is false.
-#setup.dsl.overwrite: false
+#setup.dsl.overwrite: false
diff --git a/metricbeat/metricbeat.reference.yml b/metricbeat/metricbeat.reference.yml
@@ -2183,6 +2183,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is metricbeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "metricbeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -2197,6 +2199,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/packetbeat/packetbeat.reference.yml b/packetbeat/packetbeat.reference.yml
@@ -1814,6 +1814,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is packetbeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "packetbeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -1828,6 +1830,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/winlogbeat/winlogbeat.reference.yml b/winlogbeat/winlogbeat.reference.yml
@@ -1230,6 +1230,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is winlogbeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "winlogbeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -1244,6 +1246,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/x-pack/auditbeat/auditbeat.reference.yml b/x-pack/auditbeat/auditbeat.reference.yml
@@ -1404,6 +1404,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is auditbeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "auditbeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -1418,6 +1420,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/x-pack/filebeat/filebeat.reference.yml b/x-pack/filebeat/filebeat.reference.yml
@@ -4814,6 +4814,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is filebeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "filebeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -4828,6 +4830,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/x-pack/functionbeat/functionbeat.reference.yml b/x-pack/functionbeat/functionbeat.reference.yml
@@ -1068,6 +1068,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is functionbeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "functionbeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -1082,6 +1084,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/x-pack/heartbeat/heartbeat.reference.yml b/x-pack/heartbeat/heartbeat.reference.yml
@@ -1440,6 +1440,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is heartbeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "heartbeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -1454,6 +1456,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/x-pack/metricbeat/metricbeat.reference.yml b/x-pack/metricbeat/metricbeat.reference.yml
@@ -2744,6 +2744,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is metricbeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "metricbeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -2758,6 +2760,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/x-pack/osquerybeat/osquerybeat.reference.yml b/x-pack/osquerybeat/osquerybeat.reference.yml
@@ -787,6 +787,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is osquerybeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "osquerybeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -801,6 +803,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/x-pack/packetbeat/packetbeat.reference.yml b/x-pack/packetbeat/packetbeat.reference.yml
@@ -1814,6 +1814,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is packetbeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "packetbeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -1828,6 +1830,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.

diff --git a/x-pack/winlogbeat/winlogbeat.reference.yml b/x-pack/winlogbeat/winlogbeat.reference.yml
@@ -1232,6 +1232,8 @@ setup.template.settings:
 
 # Set the lifecycle policy name or pattern. For DSL, this name must match the data stream that the lifecycle is for.
 # The default data stream pattern is winlogbeat-%{[agent.version]}"
+# The template string `%{[agent.version]}` will resolve to the current stack version. 
+# The other possible template value is `%{[beat.name]}`.
 #setup.dsl.data_stream_pattern: "winlogbeat-%{[agent.version]}"
 
 # The path to a JSON file that contains a lifecycle policy configuration. Used
@@ -1246,6 +1248,7 @@ setup.template.settings:
 
 # Overwrite the lifecycle policy at startup. The default is false.
 #setup.dsl.overwrite: false
+
 # =================================== Kibana ===================================
 
 # Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.