ingest: document fields that support templating#34536
ingest: document fields that support templating#34536jakelandis merged 7 commits intoelastic:masterfrom
Conversation
This change also updates many of the examples to use ecs as the example. Some additional minor improvements are also included. Part of elastic#33188
| @@ -751,23 +751,23 @@ pipeline basis. Useful to find out which pipelines are used the most or spent th | |||
| Appends one or more values to an existing array if the field already exists and it is an array. | |||
| Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. | |||
| Creates an array containing the provided values if the field doesn't exist. | |||
| @@ -846,7 +846,8 @@ Parses dates from fields, and then uses the date or timestamp as the timestamp f | |||
| By default, the date processor adds the parsed date as a new field called `@timestamp`. You can specify a | |||
| @@ -1041,12 +1042,12 @@ understands this to mean `2016-04-01` as is explained in the <<date-math-index-n | |||
| |====== | |||
| @@ -1365,21 +1366,22 @@ a scalar field to an object field. | |||
| === Fail Processor | |||
| Raises an exception. This is useful for when | |||
| @@ -2077,14 +2079,14 @@ Converts a string to its lowercase equivalent. | |||
|
|
|||
| [[remove-processor]] | |||
|
|
||
| [[rename-options]] | ||
| .Rename Options | ||
| [options="header"] |
| @@ -2243,24 +2246,24 @@ and depending on the progress made, indexed into different indices. | |||
| [[set-processor]] | |||
| === Set Processor | |||
There was a problem hiding this comment.
@tomcallahan @debadair ^^ example using description instead of superscript. Thoughts on which you prefer seeing side by side ?
There was a problem hiding this comment.
I like this the best of the available options
|
Pinging @elastic/es-core-infra |
|
@debadair - could I get your review on this documentation change ? I am abit uncertain about the superscript approach, however after playing around with a few options it came out as less busy/crowded as other options I tried. I have included screen shots of the rendered output to hopefully make the review quick. Also, I updated many of the examples to be based from https://github.com/elastic/ecs where applicable. |
|
So you're saying it didn't look good with "templating supported" as another column in the table? I am not a huge fan the superscript. It also appears that |
It's a judgement call for sure ... here is an example of the set processor rendered with the extra column:
Of the processors changed, Date and Date Index Name do not support templates for |
debadair
left a comment
There was a problem hiding this comment.
I probably would have added "Supports template values." to the descriptions, rather than using the "T" annotation, but the annotation works, too. I would change "Settings" to "Options" to be consistent with the option tables, though.
|
@debadair @tomcallahan - Thanks for the feedback! I have removed the superscript in favor of a comment in the description. (and updated the screen shots) |
tomcallahan
left a comment
There was a problem hiding this comment.
In this doc, we use the term template values, however when I click through we refer to these as template snippets, is there a reason we're not consistent here?
|
@tomcallahan - An oversight on my part, I will update the wording to be consistent. |
This change also updates many of the examples to use ecs as the example. Some additional minor improvements are also included. Part of elastic#33188
This change also updates many of the examples to use ecs as the example. Some additional minor improvements are also included. Part of #33188
|
6.5 backport: e9a380c |
This change also updates many of the examples to use ecs as the example. Some additional minor improvements are also included. Part of #33188
This change also updates many of the examples to use ecs as the example.
Some additional minor improvements are also included.
Part of #33188