-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathelastic-agent-processor-configuration.html
409 lines (342 loc) · 18.1 KB
/
elastic-agent-processor-configuration.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Define processors | Fleet and Elastic Agent Guide [8.18] | Elastic</title>
<meta class="elastic" name="content" content="Define processors | Fleet and Elastic Agent Guide [8.18]">
<link rel="home" href="index.html" title="Fleet and Elastic Agent Guide [8.18]"/>
<link rel="up" href="index.html" title="Fleet and Elastic Agent Guide [8.18]"/>
<link rel="prev" href="data-streams-advanced-features.html" title="Enabling and disabling advanced indexing features for Fleet-managed data streams"/>
<link rel="next" href="processor-syntax.html" title="Processor syntax"/>
<meta class="elastic" name="product_version" content="8.18"/>
<meta class="elastic" name="product_name" content="Fleet and Elastic Agent"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/Fleet/Guide/Elastic Agent/8.18"/>
<meta name="DC.subject" content="Fleet and Elastic Agent"/>
<meta name="DC.identifier" content="8.18"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://cdn.optimizely.com/js/18132920325.js"></script>
<link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
<link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
<link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
<link rel="manifest" href="/manifest.json">
<meta name="apple-mobile-web-app-title" content="Elastic">
<meta name="application-name" content="Elastic">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="/mstile-144x144.png">
<meta name="theme-color" content="#ffffff">
<meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd" />
<meta name="yandex-verification" content="d8a47e95d0972434" />
<meta name="localized" content="true" />
<meta name="st:robots" content="follow,index" />
<meta property="og:image" content="https://static-www.elastic.co/v3/assets/bltefdd0b53724fa2ce/blt280217a63b82a734/6202d3378b1f312528798412/elastic-logo.svg" />
<meta property="og:image:width" content="500" />
<meta property="og:image:height" content="172" />
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
<link rel="icon" href="/favicon.ico" type="image/x-icon">
<link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
<link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
<link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
<!-- Give IE8 a fighting chance -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="stylesheet" type="text/css" href="/guide/static/styles-v1.css" />
</head>
<!--© 2015-2025 Elasticsearch B.V. -->
<!-- All Elastic documentation is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. -->
<!-- http://creativecommons.org/licenses/by-nc-nd/4.0/ -->
<body>
<!-- Google Tag Manager -->
<script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
<!-- End Google Tag Manager -->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-12395217-16');
</script>
<!-- Google Tag Manager for GA4 -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KNJMG2M');</script>
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KNJMG2M" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager for GA4-->
<div id='elastic-nav' style="display:none;"></div>
<script src='https://www.elastic.co/elastic-nav.js'></script>
<div class="main-container">
<section id="content" >
<div class="content-wrapper">
<section id="guide" lang="en">
<div class="container-fluid">
<div class="row pb-3">
<div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
<!-- The TOC is appended here -->
</div>
<div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
<!-- start body -->
<div class="navheader">
<span class="prev">
<a href="data-streams-advanced-features.html">« Enabling and disabling advanced indexing features for Fleet-managed data streams</a>
</span>
<span class="next">
<a href="processor-syntax.html">Processor syntax »</a>
</span>
</div>
<div class="book" lang="en">
<div class="titlepage">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="index.html">Fleet and Elastic Agent Guide [8.18]</a></span>
</div>
<div>
<div><h1 class="title"><a id="id-1"></a>Define processors</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/ingest-docs/edit/8.18/docs/en/ingest-management/processors/processors.asciidoc">edit</a></div>
</div>
<!--EXTRA-->
</div>
<div id="content">
<div id="url-to-v3" class="version-warning">
A newer version is available. Check out the <a href="https://www.elastic.co/docs/reference/fleet/agent-processors">latest documentation</a>.
</div>
<div class="chapter">
<div class="titlepage"><div><div>
<div class="position-relative"><h2 class="title"><a id="elastic-agent-processor-configuration"></a>Define processors</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/ingest-docs/edit/8.18/docs/en/ingest-management/processors/processors.asciidoc">edit</a></div>
</div></div></div>
<p>Elastic Agent processors are lightweight processing components that you can use to
parse, filter, transform, and enrich data at the source. For example, you can
use processors to:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
reduce the number of exported fields
</li>
<li class="listitem">
enhance events with additional metadata
</li>
<li class="listitem">
perform additional processing and decoding
</li>
<li class="listitem">
sanitize data
</li>
</ul>
</div>
<p>Each processor receives an event, applies a defined action to the event, and
returns the event. If you define a list of processors, they are executed in the
order they are defined.</p>
<div class="pre_wrapper lang-yaml">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-yaml">event -> processor 1 -> event1 -> processor 2 -> event2 ...</pre>
</div>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>Elastic Agent processors execute <em>before</em> ingest pipelines, which means that
your processor configurations cannot refer to fields that are created by ingest
pipelines or Logstash. For more limitations, refer to <a class="xref" href="elastic-agent-processor-configuration.html#limitations" title="What are some limitations of using processors?">What are some limitations of using processors?</a></p>
</div>
</div>
<div class="position-relative"><h3><a id="where-valid"></a>Where are processors valid?</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/ingest-docs/edit/8.18/docs/en/ingest-management/processors/processors.asciidoc">edit</a></div>
<p>The processors described in this section are valid:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<p><span class="strong strong"><strong>Under integration settings in the Integrations UI in Kibana</strong></span>. For example,
when configuring an Nginx integration, you can define processors for a specific
dataset under <span class="strong strong"><strong>Advanced options</strong></span>. The processor in this example adds geo
metadata to the Nginx access logs collected by Elastic Agent:</p>
<div class="imageblock screenshot">
<div class="content">
<img src="images/add-processor.png" alt="Screen showing how to add a processor to an integration policy">
</div>
</div>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>Some integrations do not currently support processors.</p>
</div>
</div>
</li>
<li class="listitem">
<p><span class="strong strong"><strong>Under input configuration settings for standalone Elastic Agents</strong></span>. For example:</p>
<div class="pre_wrapper lang-yaml">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-yaml">inputs:
- type: logfile
use_output: default
data_stream:
namespace: default
streams:
- data_stream:
dataset: nginx.access
type: logs
ignore_older: 72h
paths:
- /var/log/nginx/access.log*
tags:
- nginx-access
exclude_files:
- .gz$
processors:
- add_host_metadata:
cache.ttl: 5m
geo:
name: nyc-dc1-rack1
location: '40.7128, -74.0060'
continent_name: North America
country_iso_code: US
region_name: New York
region_iso_code: NY
city_name: New York
- add_locale: null</pre>
</div>
</li>
</ul>
</div>
<p>You can define processors that apply to a specific input defined in the configuration.
Applying a processor to all the inputs on a global basis is currently not supported.</p>
<div class="position-relative"><h3><a id="limitations"></a>What are some limitations of using processors?</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/ingest-docs/edit/8.18/docs/en/ingest-management/processors/processors.asciidoc">edit</a></div>
<p>Processors have the following limitations.</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Cannot enrich events with data from Elasticsearch or other custom data
sources.
</li>
<li class="listitem">
Cannot process data after it’s been converted to the Elastic Common Schema
(ECS) because the conversion is performed by Elasticsearch ingest pipelines. This means
that your processor configuration cannot refer to fields that are created by
ingest pipelines or Logstash because those fields are created <em>after</em> the processor
runs, not before.
</li>
<li class="listitem">
May break integration ingest pipelines in Elasticsearch if the user-defined processing
removes or alters fields expected by ingest pipelines.
</li>
<li class="listitem">
If you create new fields via processors, you are responsible for setting up
field mappings in the <code class="literal">*-@custom</code> component template and making sure the new
mappings are aligned with ECS.
</li>
</ul>
</div>
<div class="position-relative"><h3><a id="processing-options"></a>What other options are available for processing data?</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/ingest-docs/edit/8.18/docs/en/ingest-management/processors/processors.asciidoc">edit</a></div>
<p>The Elastic Stack provides several options for processing data collected by Elastic Agent.
The option you choose depends on what you need to do:</p>
<div class="informaltable">
<table border="1" cellpadding="4px">
<colgroup>
<col class="col_1"/>
<col class="col_2"/>
</colgroup>
<thead>
<tr>
<th align="left" valign="top">If you need to…​</th>
<th align="left" valign="top">Do this…​</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p>Sanitize or enrich raw data at the source</p></td>
<td align="left" valign="top"><p>Use an Elastic Agent processor</p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Convert data to ECS, normalize field data, or enrich incoming data</p></td>
<td align="left" valign="top"><p>Use <a href="/guide/en/elasticsearch/reference/8.18/ingest.html#pipelines-for-fleet-elastic-agent" class="ulink" target="_top">ingest pipelines</a></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Define or alter the schema at query time</p></td>
<td align="left" valign="top"><p>Use <a href="/guide/en/elasticsearch/reference/8.18/runtime.html" class="ulink" target="_top">runtime fields</a></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Do something else with your data</p></td>
<td align="left" valign="top"><p>Use <a href="/guide/en/logstash/8.18/filter-plugins.html" class="ulink" target="_top">Logstash plugins</a></p></td>
</tr>
</tbody>
</table>
</div>
<div class="position-relative"><h3><a id="how-different"></a>How are Elastic Agent processors different from Logstash plugins or ingest pipelines?</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/ingest-docs/edit/8.18/docs/en/ingest-management/processors/processors.asciidoc">edit</a></div>
<p>Logstash plugins and ingest pipelines both require you to send data to another
system for processing. Processors, on the other hand, allow you to apply
processing logic at the source. This means that you can filter out data you
don’t want to send across the connection, and you can spread some of the
processing load across host systems running on edge nodes.</p>
</div>
</div>
</div><div class="navfooter">
<span class="prev">
<a href="data-streams-advanced-features.html">« Enabling and disabling advanced indexing features for Fleet-managed data streams</a>
</span>
<span class="next">
<a href="processor-syntax.html">Processor syntax »</a>
</span>
</div>
<!-- end body -->
</div>
<div class="col-12 order-3 col-lg-2 order-lg-3 h-almost-full-lg sticky-top-lg" id="right_col">
<div id="sticky_content">
<!-- The OTP is appended here -->
<div class="row">
<div class="col-0 col-md-4 col-lg-0" id="bottom_left_col"></div>
<div class="col-12 col-md-8 col-lg-12">
<div id="rtpcontainer">
<div class="mktg-promo" id="most-popular">
<p class="aside-heading">Most Popular</p>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-elasticsearch?page=docs&placement=top-video">
<p class="mb-0">Get Started with Elasticsearch</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-kibana?page=docs&placement=top-video">
<p class="mb-0">Intro to Kibana</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/introduction-elk-stack?page=docs&placement=top-video">
<p class="mb-0">ELK for Logs & Metrics</p>
</a>
</div>
</div>
</div>
<!-- Feedback widget -->
<div id="feedbackWidgetContainer"></div>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
<div id='elastic-footer'></div>
<script src='https://www.elastic.co/elastic-footer.js'></script>
<!-- Footer Section end-->
</section>
</div>
<!-- Feedback modal -->
<div id="feedbackModalContainer"></div>
<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs-v1.js"></script>
<script type="text/javascript">
window.initial_state = {}</script>
</body>
</html>