Skip to content

Commit 8686200

Browse files
jrodewigrw-access
andcommitted
[DOCS] EQL: Document concat function (#56239)
Co-authored-by: Ross Wolf <[email protected]>
1 parent 6674f14 commit 8686200

File tree

1 file changed

+53
-1
lines changed

1 file changed

+53
-1
lines changed

docs/reference/eql/functions.asciidoc

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ experimental::[]
1010

1111
* <<eql-fn-between>>
1212
* <<eql-fn-cidrmatch>>
13+
* <<eql-fn-concat>>
1314
* <<eql-fn-endswith>>
1415
* <<eql-fn-indexof>>
1516
* <<eql-fn-length>>
@@ -180,6 +181,57 @@ CIDR block you wish to search. If `null`, the function returns `null`.
180181
*Returns:* boolean or `null`
181182
====
182183

184+
[discrete]
185+
[[eql-fn-concat]]
186+
=== `concat`
187+
188+
Returns a concatenated string of provided values.
189+
190+
[%collapsible]
191+
====
192+
*Example*
193+
[source,eql]
194+
----
195+
concat("process is ", "regsvr32.exe") // returns "process is regsvr32.exe"
196+
concat("regsvr32.exe", " ", 42) // returns "regsvr32.exe 42"
197+
concat("regsvr32.exe", " ", 42.5) // returns "regsvr32.exe 42.5"
198+
concat("regsvr32.exe", " ", true) // returns "regsvr32.exe true"
199+
concat("regsvr32.exe") // returns "regsvr32.exe"
200+
201+
// process.name = "regsvr32.exe"
202+
concat(process.name, " ", 42) // returns "regsvr32.exe 42"
203+
concat(process.name, " ", 42.5) // returns "regsvr32.exe 42.5"
204+
concat("process is ", process.name) // returns "process is regsvr32.exe"
205+
concat(process.name, " ", true) // returns "regsvr32.exe true"
206+
concat(process.name) // returns "regsvr32.exe"
207+
208+
// process.arg_count = 4
209+
concat(process.name, " ", process.arg_count) // returns "regsvr32.exe 4"
210+
211+
// null handling
212+
concat(null, "regsvr32.exe") // returns null
213+
concat(process.name, null) // returns null
214+
concat(null) // returns null
215+
----
216+
217+
*Syntax*
218+
[source,txt]
219+
----
220+
concat(<value>[, <value>])
221+
----
222+
223+
*Parameters*
224+
225+
`<value>`::
226+
(Required{multi-arg-ref})
227+
Value to concatenate. If any of the arguments are `null`, the function returns `null`.
228+
+
229+
If using a field as the argument, this parameter does not support the
230+
<<text,`text`>> field datatype.
231+
232+
*Returns:* string or `null`
233+
====
234+
183235
[discrete]
184236
[[eql-fn-endswith]]
185237
=== `endsWith`
@@ -775,4 +827,4 @@ returns `null`. Fields are not supported as arguments.
775827
--
776828
777829
*Returns:* boolean
778-
====
830+
====

0 commit comments

Comments
 (0)