forked from elastic/built-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconf-map-ui.html
359 lines (341 loc) · 17.2 KB
/
conf-map-ui.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
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Configuring map data | SIEM Guide (Beta) [7.5] | Elastic</title>
<meta class="elastic" name="content" content="Configuring map data | SIEM Guide (Beta) [7.5]">
<link rel="home" href="index.html" title="SIEM Guide (Beta) [7.5]"/>
<link rel="up" href="siem-ui-overview.html" title="SIEM UI"/>
<link rel="prev" href="siem-ui-overview.html" title="SIEM UI"/>
<link rel="next" href="machine-learning.html" title="Anomaly Detection with Machine Learning"/>
<meta class="elastic" name="product_version" content="7.5"/>
<meta class="elastic" name="product_name" content="SIEM"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/SIEM/Guide/7.5"/>
<meta name="DC.subject" content="SIEM"/>
<meta name="DC.identifier" content="7.5"/>
<meta name="robots" content="noindex,nofollow"/>
<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.css" />
</head>
<!--© 2015-2022 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="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<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">SIEM Guide (Beta) [7.5]</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="siem-ui-overview.html">SIEM UI</a></span>
</div>
<div class="navheader">
<span class="prev">
<a href="siem-ui-overview.html">« SIEM UI</a>
</span>
<span class="next">
<a href="machine-learning.html">Anomaly Detection with Machine Learning »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title"><a id="conf-map-ui"></a>Configuring map data<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/stack-docs/edit/7.5/docs/en/siem/siem-ui.asciidoc">edit</a></h2>
</div></div></div>
<p>Depending on your Kibana setup, to display and interact with data on the map you
might need to:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<a class="xref" href="conf-map-ui.html#kibana-index-pattern" title="Create Kibana index patterns">Create Kibana index patterns</a>
</li>
<li class="listitem">
<a class="xref" href="conf-map-ui.html#geoip-data" title="Add geoIP data">Add geographical IP data to events</a>
</li>
<li class="listitem">
<a class="xref" href="conf-map-ui.html#private-network" title="Map your internal network">Map your internal network</a>
</li>
</ul>
</div>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>To see source and destination connections lines on the map, you must
configure <code class="literal">source.geo</code> and <code class="literal">destination.geo</code> ECS fields for your indices.</p>
</div>
</div>
<h4><a id="kibana-index-pattern"></a>Create Kibana index patterns<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/stack-docs/edit/7.5/docs/en/siem/siem-ui.asciidoc">edit</a></h4>
<p>To display map data, you must define
Kibana <a href="/guide/en/kibana/7.5/tutorial-define-index.html" class="ulink" target="_top">index patterns</a> (<span class="strong strong"><strong>Management</strong></span> →
<span class="strong strong"><strong>Index Patterns</strong></span>) with exactly the same names or glob patterns used to define
the SIEM Elasticsearch indices.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>The SIEM Elasticsearch indices are defined in the <code class="literal">siem:defaultIndex</code> field
(<span class="strong strong"><strong>Kibana</strong></span> → <span class="strong strong"><strong>Management</strong></span> → <span class="strong strong"><strong>Advanced Settings</strong></span> → <span class="strong strong"><strong><code class="literal">siem:defaultIndex</code></strong></span>).</p>
</div>
</div>
<p>For example, if you define a SIEM Elasticsearch <code class="literal">servers-europe-*</code> glob pattern,
to display map data for the matching indices you must also define a Kibana index
pattern named <code class="literal">servers-europe-*</code>. If you use a different Kibana index pattern,
such as <code class="literal">servers-*</code>, map data for the indices is <span class="strong strong"><strong>not</strong></span> displayed.</p>
<h4><a id="geoip-data"></a>Add geoIP data<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/stack-docs/edit/7.5/docs/en/siem/siem-ui.asciidoc">edit</a></h4>
<p>When the ECS <a href="/guide/en/ecs/1.2/ecs-geo.html" class="ulink" target="_top">source.geo.location and
destination.geo.location</a> fields are mapped, network data is displayed on
the map.</p>
<p>If you use Beats, configure a geoIP processor to add data to the relevant
fields:</p>
<div id="geo-pipeleine" class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
<p>Define an ingest node pipeline that uses one or more <code class="literal">geoIP</code> processors to add
location information to events. For example, use the Console in Kibana to create
the following pipeline:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT _ingest/pipeline/geoip-info
{
"description": "Add geoip info",
"processors": [
{
"geoip": {
"field": "client.ip",
"target_field": "client.geo",
"ignore_missing": true
}
},
{
"geoip": {
"field": "source.ip",
"target_field": "source.geo",
"ignore_missing": true
}
},
{
"geoip": {
"field": "destination.ip",
"target_field": "destination.geo",
"ignore_missing": true
}
},
{
"geoip": {
"field": "server.ip",
"target_field": "server.geo",
"ignore_missing": true
}
},
{
"geoip": {
"field": "host.ip",
"target_field": "host.geo",
"ignore_missing": true
}
}
]
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/1.console"></div>
<p>In this example, the pipeline ID is <code class="literal">geoip-info</code>. <code class="literal">field</code> specifies the field
that contains the IP address to use for the geographical lookup, and
<code class="literal">target_field</code> is the field that will hold the geographical information.
<code class="literal">"ignore_missing": true</code> configures the pipeline to continue processing when
it encounters an event that doesn’t have the specified field.</p>
</li>
<li class="listitem">
<p>In your Beats configuration files, add the pipeline to the
`output.elasticsearch`tag:</p>
<div class="pre_wrapper lang-yml">
<pre class="programlisting prettyprint lang-yml"> output.elasticsearch:
hosts: ["localhost:9200"]
pipeline: geoip-info <a id="CO1-1"></a><i class="conum" data-value="1"></i></pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO1-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>The value of this field must be the same as the ingest pipeline name in
<a class="xref" href="conf-map-ui.html#geo-pipeleine">step 1</a> (<code class="literal">geoip-info</code> in this example).</p>
</td>
</tr>
</table>
</div>
</li>
</ol>
</div>
<h4><a id="private-network"></a>Map your internal network<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/stack-docs/edit/7.5/docs/en/siem/siem-ui.asciidoc">edit</a></h4>
<p>If you want to add your network’s internal IP addresses to the map, define geo
location fields under the <code class="literal">processors</code> tag in the Beats configuration files
on your hosts:</p>
<div class="pre_wrapper lang-yml">
<pre class="programlisting prettyprint lang-yml"> processors:
- add_host_metadata:
- add_cloud_metadata: ~
- add_fields:
when.network.source.ip: <private/IP address> <a id="CO2-1"></a><i class="conum" data-value="1"></i>
fields:
source.geo.location:
lat: <latitude coordinate>
lon: <longitude coordinate>
target: ''
- add_fields:
when.network.destination.ip: <private/IP address>
fields:
destination.geo.location:
lat: <latitude coordinate>
lon: <longitude coordinate>
target: ''</pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO2-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>For the IP address, you can use either <code class="literal">private</code> or CIDR notation.</p>
</td>
</tr>
</table>
</div>
<div class="tip admon">
<div class="icon"></div>
<div class="admon_content">
<p>You can also enrich your data with other
<a href="/guide/en/beats/packetbeat/7.5/add-host-metadata.html" class="ulink" target="_top">host fields</a>.</p>
</div>
</div>
</div>
<div class="navfooter">
<span class="prev">
<a href="siem-ui-overview.html">« SIEM UI</a>
</span>
<span class="next">
<a href="machine-learning.html">Anomaly Detection with Machine Learning »</a>
</span>
</div>
</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?baymax=default&elektra=docs&storm=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?baymax=default&elektra=docs&storm=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?baymax=default&elektra=docs&storm=top-video">
<p class="mb-0">ELK for Logs & Metrics</p>
</a>
</div>
</div>
</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>
<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
window.initial_state = {}</script>
</body>
</html>