Threat Map
editThreat Map
editVersion |
0.1.0 [beta] This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. (View all) |
Compatible Kibana version(s) |
8.14.0 or higher |
Supported Serverless project types |
Security |
Subscription level |
Basic |
Level of support |
Elastic |
The Threat Map dashboard visualizes network traffic flow between regions using directed paths and animations. It includes arrows indicating direction and pulsing arcs at the destination.
The animations may increase browser CPU usage.
Prerequisites
editTo use the Threat Map dashboard, ensure the following:
-
Timestamp Field: Documents must contain a
@timestamp
field for time-range filtering. -
GeoIP Processor: Apply a GeoIP processor to the IP field. The resulting document should contain
source.geo
anddestination.geo
fields.-
Here is an example of an ingest pipeline that adds the geographical information to the
geo
field based on theip
field.PUT _ingest/pipeline/geoip { "description" : "Add ip geolocation info", "processors" : [ { "geoip" : { "field" : "source.ip", "target_field" : "source.geo" } }, { "geoip" : { "field" : "destination.ip", "target_field" : "destination.geo" } } ] }
-
-
Data View: Use documents accessible via the
logs-*
data view.
Data Format
editData is retrieved from Elasticsearch using the _all
index search endpoint. Ensure the following fields exist in each document:
Field | Description | Required/Optional | Default Value |
---|---|---|---|
|
Latitude of the source |
Required |
|
|
Longitude of the source |
Required |
|
|
Country name of the source |
Required |
|
|
IP address of the source |
Required |
|
|
Latitude of the destination |
Required |
|
|
Longitude of the destination |
Required |
|
|
Country name of the destination |
Required |
|
|
IP address of the destination |
Required |
|
|
Arc color |
Optional |
|
|
Determines if the arc is animated |
Optional |
|
|
Arc line thickness |
Optional |
|
|
Label at the source location |
Optional |
|
|
Label at the destination location |
Optional |
|
|
If true, the pulse begins at the source instead of the destination |
Optional |
|
These fields can be added or modified using
Custom pipeline
. Read more.
Usage
editThe Threat Map visualization can be added to other dashboards in two ways:
1. Duplicate the Dashboard
edit- Click the Duplicate button in the top-right corner of the dashboard.
- A clone of the dashboard will be created for your customization.
2. Copy Visualization to a Dashboard
edit- Click the three dots in the top-right corner of the visualization and select Copy to Dashboard.
-
Choose one of the following options:
- Existing Dashboard: Select an existing dashboard from the dropdown, then click Copy and Go to Dashboard.
- New Dashboard: Create a new dashboard with the visualization.
[role="screenshot"]
editVisualizations
editThe Threat Map dashboard includes the following visualizations:
1. Map
edit- Framework: Utilizes Vega within Kibana.
-
Fields Used:
source.geo.location
,destination.geo.location
,color
,animate
,weight
,source_label
, anddestination_label
. -
Customization:
- Click the three dots in the top-right corner and select Maximize to enlarge.
- The map adapts to Kibana’s dark/light mode automatically. Read more.
2. Panels
editIncludes four tables for analyzing traffic flow:
- Source/Destination Countries: Shows the top 5 countries with the highest traffic flow.
- Source/Destination IPs: Shows the top 5 IPs with the highest traffic flow.
Data in panels can be sorted by clicking on the Count column header.
Filtering Data
editGlobal Filters
edit- Use KQL (Kibana Query Language) in the query bar at the top of the dashboard.
- Adjust the time range using the selector in the top-right corner (default: last 30 minutes).
- Maximum records displayed: 10,000.
Visualization-Specific Filters
edit- Click the three dots in the top-right corner of the map and select Edit Visualization.
- Apply a filter using the query bar.
- Click Save and Return to apply changes.
[role="screenshot"]
editCustomization Options
editThe following options are available for customization:
Option | Description | Default Value |
---|---|---|
|
Sets the EMS-layer for the map. |
|
|
Starting latitude of the map |
|
|
Starting longitude of the map |
|
|
Starting zoom level of the map |
|
|
If true, disables mouse wheel zoom to avoid accidental zooming |
|
To customize these options, click on Edit visualization from the dropdown in the top right corner of the visualization. A Vega editor will open, where you can modify the following configurations.
For additional customization options, see the Vega Kibana Guide.
[role="screenshot"]
editChangelog
editChangelog
Version | Details | Kibana version(s) |
---|---|---|
0.1.0 |
Enhancement (View pull request) |
— |