Introduce a new use_synthetic_source_recovery track parameter (#713)

elastic/logs/README.md

@@ -222,6 +222,7 @@ The following parameters are available:
 * `workflow-request-cache` (default: `true`) - Explicit control of request cache query parameter in searches executed in a workflow. This can be further overriden at an operation level with `request-cache` parameter.
 * `synthetic_source_keep` (default: unset) - Allows overriding the default synthetic source behaviour for all field types with the following values: `none` (equivalent to unset) - no source is stored, `arrays` - source stored as is only for multi-value (array) fields.
 * `source_mode` (default: unset) - Specifies the source mode to be used.
+* `use_synthetic_source_recovery` (default: unset): Whether synthetic recovery source will be used.
 
 ### Data Download Parameters
 

elastic/logs/templates/component/track-shared-logsdb-mode.json

@@ -4,6 +4,9 @@
         {% if index_mode %}
         "index": {
             "mode": {{ index_mode | tojson }}
+            {% if use_synthetic_source_recovery %}
+            ,"recovery.use_synthetic_source": {{use_synthetic_source_recovery | tojson}}
+            {% endif %}
             {% if synthetic_source_keep and synthetic_source_keep != 'none' %}
             ,"mapping.synthetic_source_keep": {{ synthetic_source_keep | tojson }}
             {% endif %}

elastic/security/README.md

@@ -86,6 +86,7 @@ The following parameters are available:
 * `index_mode` (default: unset) - A parameter meant to be used internally which defines one of the available indexing modes, "standard", "logsdb" or "time_series". If not set, "standard" is used.
 * `synthetic_source_keep` (default: unset) - Allows overriding the default synthetic source behaviour for all field types with the following values: `none` (equivalent to unset) - no source is stored, `arrays` - source stored as is only for multi-value (array) fields.
 * `source_mode` (default: unset) - Specifies the source mode to be used.
+* `use_synthetic_source_recovery` (default: unset): Whether synthetic recovery source will be used.
 
 ### Data Generation Parameters
 

elastic/security/templates/component/track-shared-logsdb-mode.json

@@ -4,6 +4,9 @@
         {% if index_mode %}
         "index": {
             "mode": {{ index_mode | tojson }},
+            {% if use_synthetic_source_recovery %}
+            "recovery.use_synthetic_source": {{use_synthetic_source_recovery | tojson}},
+            {% endif %}
             {% if synthetic_source_keep and synthetic_source_keep != 'none' %}
             "mapping.synthetic_source_keep": {{ synthetic_source_keep | tojson}},
             {% endif %}

tsdb/README.md

@@ -204,6 +204,7 @@ This track allows to overwrite the following parameters using `--track-params`:
 * `post_ingest_sleep_duration` (default: 30): Sleep duration in seconds.
 * `document_ids`: documentd IDs to use for search, get and mget apis in the `low-latency` challenge. If empty, a default set of 4 values is used.
 * `synthetic_source_keep` (default: unset): If specified, configures the `index.mapping.synthetic_source_keep` index setting.
+* `use_synthetic_source_recovery` (default: unset): Whether synthetic recovery source will be used.
 
 ### License
 

tsdb/index.json

@@ -8,6 +8,9 @@
       "number_of_shards": {{number_of_shards | default(1)}},
       "number_of_replicas": {{number_of_replicas | default(0)}},
       "requests.cache.enable": false,
+      {% if use_synthetic_source_recovery %}
+      "recovery.use_synthetic_source": {{use_synthetic_source_recovery | tojson}},
+      {% endif %}
       {%- endif -%}{# non-serverless-index-settings-marker-end #}
       "codec": "{{codec | default('default')}}",
       "mode": "{{index_mode | default('time_series')}}",