Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add index_sorting, synthetic_source_mode and force_merge_max_num_segments track parameters to elastic/logs track #522

Merged
merged 5 commits into from
Jan 12, 2024
Merged

Add index_sorting, synthetic_source_mode and force_merge_max_num_segments track parameters to elastic/logs track #522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3d5de9c
Add index_sorting track parameter to elastic/logs track.
martijnvg Nov 23, 2023
05e0620
fix typo
martijnvg Nov 24, 2023
804adbb
iter
martijnvg Nov 24, 2023
c4cf420
added force_merge_max_num_segments parameter
martijnvg Dec 6, 2023
44ee845
Merge branch 'master' into elastic-logs/index_sorting
elasticmachine Dec 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions elastic/logs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,9 @@ The following parameters are available:
* `disable_pipelines` (default: `false`) - Prevent installing ingest node pipelines. This parameter is experimental and is to be used with indexing-only challenges.
* `initial_indices_count` (default: 0) - Number of initial indices to create, each containing `100` auditbeat style documents. Parameter is applicable in [many-shards-quantitative challenge](#many-shards-quantitative-many-shards-quantitative) and in [many-shards-snapshots challenge](#many-shards-snapshots-many-shards-snapshots).
* `ingest_percentage` (default: 100) - The percentage of data to be ingested.
* `index_sorting` (default: unset): Whether index sorting should be used. Accepted values: `hostname` and `timestamp`.
* `synthetic_source_mode` (default: `false`): Whether to enable synthetic source.
* `force_merge_max_num_segments` (default: unset): An integer specifying the max amount of segments the force-merge operation should use. Only supported in `logging-querying` track.

### Querying parameters

Expand Down
46 changes: 46 additions & 0 deletions elastic/logs/challenges/logging-querying.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,52 @@
"clients": {{ p_bulk_indexing_clients }},
"ignore-response-error-level": "{{error_level | default('non-fatal')}}"
}
{%- if force_merge_max_num_segments is defined %},
{
"name": "refresh-after-index",
"index": "logs-*",
"operation": "refresh"
},
{
"name": "wait-until-index-merges-fininshes",
"operation": {
"operation-type": "index-stats",
"index": "logs-*",
"condition": {
"path": "_all.total.merges.current",
"expected-value": 0
},
"retry-until-success": true,
"include-in-reporting": false
}
},
{
"operation": {
"operation-type": "force-merge",
"index": "logs-*",
"request-timeout": 36000,
"max-num-segments": {{ force_merge_max_num_segments | tojson }}
}
},
{
"name": "wait-until-merges-finish",
"operation": {
"operation-type": "index-stats",
"index": "logs-*",
"condition": {
"path": "_all.total.merges.current",
"expected-value": 0
},
"retry-until-success": true,
"include-in-reporting": false
}
},
{
"name": "refresh-after-force-merge",
"index": "logs-*",
"operation": "refresh"
}
{%- endif %}
{# non-serverless-index-statistics-marker-start #}{%- if build_flavor != "serverless" or serverless_operator == true -%},
{
"name": "compression-stats",
Expand Down
6 changes: 6 additions & 0 deletions elastic/logs/templates/component/auditbeat-mappings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1785,6 +1785,9 @@
"message": {
"norms": false,
"type": "text"
{% if synthetic_source_mode | default(false) is true %},
"store": true
{% endif %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hopefully one day this will work automagically when synthetic source is enabled.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we should just fix this. For the match_only_text this is working as expected. If synthetic source is enabled then store defaults to true.

},
"stack_trace": {
"fields": {
Expand Down Expand Up @@ -2941,6 +2944,9 @@
"message": {
"norms": false,
"type": "text"
{% if synthetic_source_mode | default(false) is true %},
"store": true
{% endif %}
},
"network": {
"properties": {
Expand Down
22 changes: 22 additions & 0 deletions elastic/logs/templates/component/track-shared-logsdb-mode.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"template": {
"settings": {
"index": {
{% if index_sorting == "hostname" %}
"sort.field": [ "host.name", "@timestamp" ],
"sort.order": [ "asc", "desc" ]
{% elif index_sorting == "timestamp" %}
"sort.field": [ "@timestamp", "host.name" ],
"sort.order": [ "desc", "asc" ]
{% endif %}
}
},
"mappings": {
{% if synthetic_source_mode | default(false) is true %}
"_source": {
"mode": "synthetic"
}
{% endif %}
}
}
}
2 changes: 1 addition & 1 deletion elastic/logs/templates/composable/auditbeat-frozen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"lifecycle": {}
{%- endif -%}
},
"composed_of" : ["auditbeat-mappings"],
"composed_of" : ["auditbeat-mappings", "track-shared-logsdb-mode"],
"priority": 1,
"data_stream" : { }
}
2 changes: 1 addition & 1 deletion elastic/logs/templates/composable/auditbeat-quantitative.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"lifecycle": {}
{%- endif -%}
},
"composed_of" : ["auditbeat-mappings"],
"composed_of" : ["auditbeat-mappings", "track-shared-logsdb-mode"],
"priority": 1,
"data_stream" : { }
}
2 changes: 1 addition & 1 deletion elastic/logs/templates/composable/auditbeat.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"lifecycle": {}
{%- endif -%}
},
"composed_of" : ["auditbeat-mappings"],
"composed_of" : ["auditbeat-mappings", "track-shared-logsdb-mode"],
"priority": 1,
"data_stream" : { }
}
3 changes: 2 additions & 1 deletion elastic/logs/templates/composable/logs-apache.access.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,8 @@
".fleet_component_template-1",
"track-custom-mappings",
"track-custom-shared-settings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
3 changes: 2 additions & 1 deletion elastic/logs/templates/composable/logs-apache.error.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,8 @@
".fleet_component_template-1",
"track-custom-mappings",
"track-custom-shared-settings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
3 changes: 2 additions & 1 deletion elastic/logs/templates/composable/logs-k8-application.log.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2000,7 +2000,8 @@
"composed_of": [
"logs-mappings",
"track-custom-mappings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
12 changes: 11 additions & 1 deletion elastic/logs/templates/composable/logs-kafka.log.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,9 @@
"properties": {
"message": {
"type": "text"
{% if synthetic_source_mode | default(false) is true %},
"store": true
{% endif %}
},
"class": {
"ignore_above": 1024,
Expand Down Expand Up @@ -266,11 +269,17 @@
},
"message": {
"type": "text"
{% if synthetic_source_mode | default(false) is true %},
"store": true
{% endif %}
},
"error": {
"properties": {
"message": {
"type": "text"
{% if synthetic_source_mode | default(false) is true %},
"store": true
{% endif %}
}
}
},
Expand All @@ -287,7 +296,8 @@
".fleet_component_template-1",
"track-custom-mappings",
"track-custom-shared-settings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
3 changes: 2 additions & 1 deletion elastic/logs/templates/composable/logs-mysql.error.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,8 @@
".fleet_component_template-1",
"track-custom-mappings",
"track-custom-shared-settings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
3 changes: 2 additions & 1 deletion elastic/logs/templates/composable/logs-mysql.slowlog.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,8 @@
".fleet_component_template-1",
"track-custom-mappings",
"track-custom-shared-settings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
3 changes: 2 additions & 1 deletion elastic/logs/templates/composable/logs-nginx.access.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,8 @@
".fleet_component_template-1",
"track-custom-mappings",
"track-custom-shared-settings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
3 changes: 2 additions & 1 deletion elastic/logs/templates/composable/logs-nginx.error.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,8 @@
".fleet_component_template-1",
"track-custom-mappings",
"track-custom-shared-settings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
3 changes: 2 additions & 1 deletion elastic/logs/templates/composable/logs-postgresql.log.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,8 @@
".fleet_component_template-1",
"track-custom-mappings",
"track-custom-shared-settings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
3 changes: 2 additions & 1 deletion elastic/logs/templates/composable/logs-redis.log.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,8 @@
".fleet_component_template-1",
"track-custom-mappings",
"track-custom-shared-settings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
3 changes: 2 additions & 1 deletion elastic/logs/templates/composable/logs-redis.slowlog.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,8 @@
".fleet_component_template-1",
"track-custom-mappings",
"track-custom-shared-settings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
3 changes: 2 additions & 1 deletion elastic/logs/templates/composable/logs-system.auth.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,8 @@
".fleet_component_template-1",
"track-custom-mappings",
"track-custom-shared-settings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
3 changes: 2 additions & 1 deletion elastic/logs/templates/composable/logs-system.syslog.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,8 @@
".fleet_component_template-1",
"track-custom-mappings",
"track-custom-shared-settings",
"track-data-stream-lifecycle"
"track-data-stream-lifecycle",
"track-shared-logsdb-mode"
],
"priority": 200,
"_meta": {
Expand Down
4 changes: 4 additions & 0 deletions elastic/logs/track.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,10 @@
{
"name": "track-data-stream-lifecycle",
"template": "./templates/component/track-data-stream-lifecycle.json"
},
{
"name": "track-shared-logsdb-mode",
"template": "./templates/component/track-shared-logsdb-mode.json"
}
],
"composable-templates": [
Expand Down