Better out-of-the-box mappings for logs, metrics and synthetics #64978
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| { | ||
| "template": { | ||
| "mappings": { | ||
| "dynamic_templates": [ | ||
| { | ||
| "match_ip": { | ||
| "match_mapping_type": "string", | ||
| "match": "ip", | ||
| "mapping": { | ||
| "type": "ip" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "match_message": { | ||
| "match_mapping_type": "string", | ||
| "match": "message", | ||
| "mapping": { | ||
| "type": "match_only_text" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "strings_as_keyword": { | ||
| "mapping": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| }, | ||
| "match_mapping_type": "string" | ||
| } | ||
| } | ||
| ], | ||
| "date_detection": false, | ||
| "properties": { | ||
| "@timestamp": { | ||
| "type": "date" | ||
| }, | ||
| "data_stream": { | ||
| "properties": { | ||
| "dataset": { | ||
| "type": "constant_keyword" | ||
| }, | ||
| "namespace": { | ||
| "type": "constant_keyword" | ||
| } | ||
| } | ||
| }, | ||
| "ecs": { | ||
| "properties": { | ||
| "version": { | ||
| "ignore_above": 1024, | ||
| "type": "keyword" | ||
| } | ||
| } | ||
| }, | ||
| "host": { | ||
| "type": "object" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "_meta": { | ||
| "description": "general mapping conventions for data streams", | ||
| "managed": true | ||
| }, | ||
| "version": ${xpack.stack.template.version} | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,12 @@ | ||
| { | ||
| "template": { | ||
| "mappings": { | ||
| "properties": { | ||
| "data_stream": { | ||
| "properties": { | ||
| "type": { | ||
| "type": "constant_keyword", | ||
| "value": "synthetics" | ||
| } | ||
| } | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -4,6 +4,7 @@ | |||||||||
| "data_stream": {}, | ||||||||||
| "composed_of": [ | ||||||||||
| "synthetics-mappings", | ||||||||||
| "data-streams-mappings", | ||||||||||
|
Comment on lines
6
to
+7
There was a problem hiding this comment. And same here with:
Suggested change
|
||||||||||
| "synthetics-settings" | ||||||||||
| ], | ||||||||||
| "allow_auto_create": true, | ||||||||||
|
|
||||||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,6 +14,10 @@ setup: | |
| ilm.get_lifecycle: | ||
| policy: "metrics" | ||
|
|
||
| - do: | ||
| cluster.get_component_template: | ||
| name: data-streams-mappings | ||
|
|
||
| - do: | ||
| cluster.get_component_template: | ||
| name: logs-mappings | ||
|
|
@@ -46,6 +50,11 @@ setup: | |
| body: | ||
| "@timestamp": "2020-01-01" | ||
| message: "test-log-message" | ||
| source.ip: "10.1.2.3" | ||
| log.file.path: "/var/log/web/access.log" | ||
| data_stream.type: "logs" | ||
| data_stream.dataset: "foo" | ||
| data_stream.namespace: "bar" | ||
|
|
||
| - do: | ||
| indices.get_data_stream: | ||
|
|
@@ -66,7 +75,16 @@ setup: | |
| - is_true: .$idx0name.settings | ||
| - is_true: .$idx0name.mappings | ||
| - match: { .$idx0name.settings.index.lifecycle.name: "logs" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.type.type: "constant_keyword" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.type.value: "logs" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.dataset.type: "constant_keyword" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.dataset.value: "foo" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.namespace.type: "constant_keyword" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.namespace.value: "bar" } | ||
| - is_true: .$idx0name.mappings.properties.message | ||
| - match: { .$idx0name.mappings.properties.message.type: "match_only_text" } | ||
| - match: { .$idx0name.mappings.properties.source.properties.ip.type: "ip" } | ||
| - match: { .$idx0name.mappings.properties.log.properties.file.properties.path.type: "keyword" } | ||
| - match: { .$idx0name.data_stream: "logs-foo-bar" } | ||
|
|
||
| - do: | ||
|
|
@@ -80,7 +98,10 @@ setup: | |
| index: metrics-foo-bar | ||
| body: | ||
| "@timestamp": "2020-01-01" | ||
| source.ip: "10.1.2.3" | ||
| data_stream.type: "metrics" | ||
| data_stream.dataset: "foo" | ||
| data_stream.namespace: "bar" | ||
|
|
||
| - do: | ||
| indices.get_data_stream: | ||
|
|
@@ -101,9 +122,92 @@ setup: | |
| - is_true: .$idx0name.settings | ||
| - is_true: .$idx0name.mappings | ||
| - match: { .$idx0name.settings.index.lifecycle.name: "metrics" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.type.type: "constant_keyword" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.type.value: "metrics" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.dataset.type: "constant_keyword" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.dataset.value: "foo" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.namespace.type: "constant_keyword" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.namespace.value: "bar" } | ||
| - match: { .$idx0name.mappings.properties.source.properties.ip.type: "ip" } | ||
| - match: { .$idx0name.data_stream: "metrics-foo-bar" } | ||
|
|
||
| - do: | ||
| indices.delete_data_stream: | ||
| name: metrics-foo-bar | ||
|
|
||
| --- | ||
| "Test synthetics index auto creation": | ||
| - do: | ||
| index: | ||
| index: synthetics-foo-bar | ||
| body: | ||
| "@timestamp": "2020-01-01" | ||
| source.ip: "10.1.2.3" | ||
| data_stream.type: "synthetics" | ||
| data_stream.dataset: "foo" | ||
| data_stream.namespace: "bar" | ||
|
|
||
| - do: | ||
| indices.get_data_stream: | ||
| name: synthetics-foo-bar | ||
|
|
||
| - match: { data_streams.0.name: synthetics-foo-bar } | ||
| - match: { data_streams.0.timestamp_field.name: '@timestamp' } | ||
| - match: { data_streams.0.generation: 1 } | ||
| - length: { data_streams.0.indices: 1 } | ||
| - match: { data_streams.0.indices.0.index_name: '/\.ds-synthetics-foo-bar-(\d{4}\.\d{2}\.\d{2}-)?000001/' } | ||
|
|
||
| - set: { data_streams.0.indices.0.index_name: idx0name } | ||
|
|
||
| - do: | ||
| indices.get: | ||
| index: $idx0name | ||
|
|
||
| - is_true: .$idx0name.settings | ||
| - is_true: .$idx0name.mappings | ||
| - match: { .$idx0name.settings.index.lifecycle.name: "synthetics" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.type.type: "constant_keyword" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.type.value: "synthetics" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.dataset.type: "constant_keyword" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.dataset.value: "foo" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.namespace.type: "constant_keyword" } | ||
| - match: { .$idx0name.mappings.properties.data_stream.properties.namespace.value: "bar" } | ||
| - match: { .$idx0name.mappings.properties.source.properties.ip.type: "ip" } | ||
| - match: { .$idx0name.data_stream: "synthetics-foo-bar" } | ||
|
|
||
| - do: | ||
| indices.delete_data_stream: | ||
| name: synthetics-foo-bar | ||
|
|
||
| --- | ||
| "Test wrong data_stream type": | ||
|
|
||
| - do: | ||
| catch: bad_request | ||
| index: | ||
| index: synthetics-dataset0-namespace1 | ||
| body: | ||
| "@timestamp": "2020-01-01" | ||
| data_stream.type: "logs" | ||
| data_stream.dataset: "dataset0" | ||
| data_stream.namespace: "namespace1" | ||
|
|
||
| - do: | ||
| catch: bad_request | ||
| index: | ||
| index: logs-dataset0-namespace1 | ||
| body: | ||
| "@timestamp": "2020-01-01" | ||
| data_stream.type: "metrics" | ||
| data_stream.dataset: "dataset0" | ||
| data_stream.namespace: "namespace1" | ||
|
|
||
| - do: | ||
| catch: bad_request | ||
| index: | ||
| index: metrics-dataset0-namespace1 | ||
| body: | ||
| "@timestamp": "2020-01-01" | ||
| data_stream.type: "synthetics" | ||
| data_stream.dataset: "dataset0" | ||
| data_stream.namespace: "namespace1" | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should apply the
data-streams-mappingssettings first, so that any changes made to thelogs-mappingscomponent template always take precedence over the generic data stream mappings.What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually this would break tests because then the dynamic template that maps strings as keywords would take precedence over the dynamic template that maps message fields as
match_only_text. In order to change the order, we would also need to configureunmatch:messageon the default dynamic template that maps strings as keywords. What is your preference?