Have you ever wanted to plot massive amounts of single value lat/lons with clustering and drill-down to individual markers? Use this app! No geostats aggregation at all! Tested with 1.7 million individual points. Lots of configuration options including the ability to add description popups with HTML support, color and style markers, add icons, disable clustering and plot nothing but single values. Native splunk maps can't do that!
Big thanks to the following people:
- Damien Dallimore and Andrew Stein for all the feature requests and extensive testing.
- Johannes Effland for contributing the path tracing code.
- Paul Thompson for marker priority and SVG marker feature suggestions.
- dxwils3 for pathColor enhancement.
This app is compatible with Splunk 6.4+ as it relies on the Custom Visualization API.
Fields must be named exactly as labled here. The app is keyed off of field names and not field order.
base_search | table latitude, longitude [ description | tooltip | title | icon | markerColor |markerPriority | markerSize | markerAnchor | markerVisibility | iconColor | shadowAnchor | shadowSize | prefix | extraClasses | layerDescription | pathWeight | pathOpacity | pathColor | layerGroup]
Latitude Coordinates
Longitude Coordinates
Desciption that is displayed in a pop-up when then marker is clicked on the map. You can get creative with this field. Combine a bunch of other fields or lookups using eval to make the description full of detail. This field supports HTML.
Description that is added next to the icon in the layer control legend. this field supports HTML
Version 1.1 introduces new features to dynamically style map markers and add icons via SPL. Create fields using eval to define colors for the marker or use an icon from Font Awesome or ionicons. If you find the color set of icons too limiting, feel free to override the map marker icon with a map icon from Font Awesome and style it with any hex color or RGB value.
By default, markers are rendered as PNG's. The set of markers comes in a limited array of color values and cannot be re-sized. If you want access to an unlimited color palette and the ability to size markers, use SVG based markers.
Icon mouse hover over description. Deprecated (with backwards compatibility) - see tooltip
Tooltip to display on marker hover.
Icon displayed in map marker - Any icon from Font Awesome or ionicons. Default circle
Color of map marker - red, darkred, lightred, orange, beige, green, darkgreen, lightgreen, blue, darkblue, lightblue, purple, darkpurple, pink, cadetblue, white, gray, lightgray, black. Default blue
Color of icon - Any CSS color name, Hex or RGB value. Default white.
fa (Font Awesome) or ion (ionicons). Default fa
Any extra CSS classes you wish to add for styling. Here are some additional classes you can use with Font Awesome or Ionicons to change the styling. Default fa-lg
Version 1.4.4 introduces the ability to use SVG based markers. You can dynamically size markers and assign any color (name or hex value). The following settings control SVG based markers.
svg or png Default png
Comma separated string representing the pixel width and height of marker, respectively. Default 35,45
Color of map marker. Use any common HTML color code name or hex value. Default #38AADD
Comma separated string representing the coordinates of the "tip" of the icon (relative to its top left corner). Default 15,50
Comma separated string representing the pixel width and height of the marker shadow. You typically don't need to change this value unless you increase or decrese the markerSize. Set to 0,0 to disable shadows. Default 30,46
Comma separated string representing the coordinates of the "tip" of the shadow (relative to its top left corner). You typically don't need to change this value unless you increase or decrese the markerSize. Default 30,30
Color of icon - Any CSS color name, Hex or RGB value. Default white.
fa (Font Awesome) or ion (ionicons). Default fa
Any extra CSS classes you wish to add for styling. Here are some additional classes you can use with Font Awesome to change the styling.
Version 1.5.0 introduces the ability to trace paths along the map. If you have a dataset that contains multiple coordinates for each point (think cars, trains, planes, bicycles, anything that moves and can be tracked) you can now trace the path of the object. You can control whether markers are displayed along the path using the markerVisibility setting.
Show marker for the given coordinates. Set to marker to show marker or any other value to hide.
Weight (width) of path. Default 5
Opacity of path line. Default 0.5
The color of the path. If not specified, the color will be chosen randomly from the set of colors listed in the Path Colors option.
Version 1.4.4 introduces the ability to prioritize how markers are rendered on the map. Higher priority markers will render on top of lower priority markers. This is especially useful for dense maps where you need certain markers to stand out over others.
Use the following setting to set the marker priority.
Number used to set marker priority. Higher value numbers render over lower value numbers. Set a high value like 1000 (or a high negative value to render beneath). Default 0
Version 1.3.12 introduces drilldown capability! The visualization will identify any non-standard fields and make them available as drilldown fields. Simply add any fields you wish to the final table command and you'll have access to them via drilldown in Simple XML. See the documentation on dynamic drilldown. Refer to this section of the docs on accessing tokens for dynamic drilldown.
Drilldown is disabled by default. Enable it in the main Map section of the format menu. Simply double-click on a marker to activate the drilldown behavior.
This example highlights creating a dashboard with contextual drilldown. I save the description field as orig_desc since I'm modifying it with HTML tags. I then add orig_desc into the table command. The visualization automatically makes that field accessible as a drilldown token. In the visualization you can see I set a <condition> statement on the orig_desc field. I then set a token called orig_desc and use a <depends> statement in the timechart looking for the token. The timechart becomes visible once the marker is double-clicked.
<form>
<label>Clustered Single Value Viz - Contextual Drilldown Example</label>
<fieldset submitButton="false">
<input type="time" token="field1">
<label></label>
<default>
<earliest>0</earliest>
<latest></latest>
</default>
</input>
</fieldset>
<row>
<panel>
<viz type="leaflet_maps_app.leaflet_maps">
<search>
<query>index=chicago_crime | fillnull | eval orig_desc=description, description = "<b>".description."</b>", markerColor = case(like(description, "%HARASSMENT BY TELEPHONE%"), "red", like(description, "%RECKLESS CONDUCT%"), "green", 1=1, "blue"), icon=case(like(description, "%HARASSMENT BY TELEPHONE%"), "exclamation", like(description, "%RECKLESS CONDUCT%"), "check-circle", 1=1, "circle") | table latitude, longitude, description, markerColor, icon, orig_desc</query>
<earliest>$field1.earliest$</earliest>
<latest>$field1.latest$</latest>
</search>
<drilldown>
<condition field="orig_desc">
<set token="orig_desc">$row.orig_desc$</set>
</condition>
</drilldown>
<option name="leaflet_maps_app.leaflet_maps.mapTile">http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png</option>
<option name="leaflet_maps_app.leaflet_maps.scrollWheelZoom">1</option>
<option name="leaflet_maps_app.leaflet_maps.fullScreen">0</option>
<option name="leaflet_maps_app.leaflet_maps.mapCenterZoom">6</option>
<option name="leaflet_maps_app.leaflet_maps.mapCenterLat">42.2846323</option>
<option name="leaflet_maps_app.leaflet_maps.mapCenterLon">-83.7294274</option>
<option name="leaflet_maps_app.leaflet_maps.minZoom">1</option>
<option name="leaflet_maps_app.leaflet_maps.maxZoom">19</option>
<option name="leaflet_maps_app.leaflet_maps.cluster">0</option>
<option name="leaflet_maps_app.leaflet_maps.allPopups">0</option>
<option name="leaflet_maps_app.leaflet_maps.multiplePopups">0</option>
<option name="leaflet_maps_app.leaflet_maps.animate">1</option>
<option name="leaflet_maps_app.leaflet_maps.singleMarkerMode">0</option>
<option name="leaflet_maps_app.leaflet_maps.maxClusterRadius">80</option>
<option name="leaflet_maps_app.leaflet_maps.maxSpiderfySize">100</option>
<option name="leaflet_maps_app.leaflet_maps.spiderfyDistanceMultiplier">1</option>
<option name="leaflet_maps_app.leaflet_maps.rangeOneBgColor">#B5E28C</option>
<option name="leaflet_maps_app.leaflet_maps.rangeOneFgColor">#6ECC39</option>
<option name="leaflet_maps_app.leaflet_maps.warningThreshold">55</option>
<option name="leaflet_maps_app.leaflet_maps.rangeTwoBgColor">#F1D357</option>
<option name="leaflet_maps_app.leaflet_maps.rangeTwoFgColor">#F0C20C</option>
<option name="leaflet_maps_app.leaflet_maps.criticalThreshold">80</option>
<option name="leaflet_maps_app.leaflet_maps.rangeThreeBgColor">#FD9C73</option>
<option name="leaflet_maps_app.leaflet_maps.rangeThreeFgColor">#F18017</option>
<option name="refresh.auto.interval">900</option>
<option name="leaflet_maps_app.leaflet_maps.defaultHeight">600</option>
<option name="leaflet_maps_app.leaflet_maps.layerControl">1</option>
<option name="leaflet_maps_app.leaflet_maps.layerControlCollapsed">1</option>
<option name="leaflet_maps_app.leaflet_maps.measureTool">1</option>
<option name="leaflet_maps_app.leaflet_maps.measureLocalization">en</option>
<option name="leaflet_maps_app.leaflet_maps.measureIconPosition">topright</option>
<option name="leaflet_maps_app.leaflet_maps.measurePrimaryLengthUnit">feet</option>
<option name="leaflet_maps_app.leaflet_maps.measureSecondaryLengthUnit">miles</option>
<option name="leaflet_maps_app.leaflet_maps.measurePrimaryAreaUnit">acres</option>
<option name="leaflet_maps_app.leaflet_maps.measureSecondaryAreaUnit">sqmiles</option>
<option name="leaflet_maps_app.leaflet_maps.measureActiveColor">#00ff00</option>
<option name="leaflet_maps_app.leaflet_maps.measureCompletedColor">#0066ff</option>
<option name="leaflet_maps_app.leaflet_maps.drilldown">1</option>
</viz>
</panel>
</row>
<row>
<panel>
<chart depends="$orig_desc$">
<title>Chart for $orig_desc$</title>
<search>
<query>index=chicago_crime description="$orig_desc$" | timechart count</query>
<earliest>$field1.earliest$</earliest>
<latest>$field1.latest$</latest>
</search>
<option name="charting.axisLabelsX.majorLabelStyle.overflowMode">ellipsisNone</option>
<option name="charting.axisLabelsX.majorLabelStyle.rotation">0</option>
<option name="charting.axisTitleX.visibility">visible</option>
<option name="charting.axisTitleY.visibility">visible</option>
<option name="charting.axisTitleY2.visibility">visible</option>
<option name="charting.axisX.scale">linear</option>
<option name="charting.axisY.scale">linear</option>
<option name="charting.axisY2.enabled">0</option>
<option name="charting.axisY2.scale">inherit</option>
<option name="charting.chart">column</option>
<option name="charting.chart.bubbleMaximumSize">50</option>
<option name="charting.chart.bubbleMinimumSize">10</option>
<option name="charting.chart.bubbleSizeBy">area</option>
<option name="charting.chart.nullValueMode">gaps</option>
<option name="charting.chart.showDataLabels">none</option>
<option name="charting.chart.sliceCollapsingThreshold">0.01</option>
<option name="charting.chart.stackMode">default</option>
<option name="charting.chart.style">shiny</option>
<option name="charting.drilldown">all</option>
<option name="charting.layout.splitSeries">0</option>
<option name="charting.layout.splitSeries.allowIndependentYRanges">0</option>
<option name="charting.legend.labelStyle.overflowMode">ellipsisMiddle</option>
<option name="charting.legend.placement">right</option>
</chart>
</panel>
</row>
</form>
Version 1.3.6 introduces a few feature that groups marker/icon styles into their own layer. A layer control widget (enabled by default, but optionally hidden) is presented in the upper right hand corner that displays a legend for each icon class with a checkbox to toggle visbility of the markers on the map. This control works for both clustered and single value visualizations.
Version 1.5.9 introduces the ability to specify a layerGroup via SPL for filtering markers via layer controls. The default behavior is to group by icon. If you have the same icon with different colors, the layerGroup field allows you to split them into their own group for filtering.
Add description text next to each icon in the layer control legend.
Specify unique group that markers belong to. See Issue 13 for details
Example
layerGroup=case(like(description, "%HARASSMENT BY TELEPHONE%"), "hbt", like(description, "%RECKLESS CONDUCT%"), "rc", 1=1, "default")
Version 1.3.7 introduces a new feature that allows you to add custom overlays to the map. The first release implements a KML or KMZ overlay feature. If you have existing KML/KMZ files that define features (polyline, polygons, whatever) you can now leverage them to overlay these features on the map.
Copy any KML or KMZ files into the following directory
$SPLUNK_HOME/etc/apps/leaflet_maps_app/appserver/static/visualizations/leaflet_maps/contrib/kml
If you use a deployer (search head clustering) or a deployment server to manage your search heads, uncompress the app and place your KML files into the above directory and then recompress the app for distribution.
Click 'Format' and selct the 'Overlays' tab. Enter a comma separated list of filenames that you uploaded to the above directory.
file1.kml,file2.kmz
The files will be asynchronously loaded when the map is rendered.
Version 1.3.8 indroduces a new feature that allows you to interactively measure paths and area on the map. The feature is enabled by default. Click the icon in the upper right corner of the map and then select 'Create new measurement'. You can draw a simple path or click to define multiple points to measure an area. Measurements will not be persisted for future use. This is an interactive tool designed for a single session.
Version 1.5.6 introduces a search control for the Google Places API. Log into the Google API Console and enable the Google Places API Web Service and Google Maps JavaScript API for the given project and create an API key. See Google's docs for detailed instructions.
Enable/Disable the search control via the format menu option Google Places -> Google Places Search -> Enabled
Set the API Key option Google Places -> API Key
Optionally set the Zoom Level option Google Places -> Zoom Level for the desired fly to zoom level.
Version 1.5.17 introduces a Bing Maps tile layer.
Enable/Disable Bing Maps via the format menu option Bing Maps -> Bing Maps -> Enabled. When Bing Maps are enabled, the default tile layer set and the map attribution override setting will not work.
Set the API Key option Bing Maps -> API Key by pasting your Bing Maps API Key into this field.
Choose the desired Tile Layer under Bing Maps -> Tile Layer
Optionally set the Label Language using Bing Maps -> Label Language to localize the tile labels in the desired language. See Microsoft's documentation for more details.
index=chicago_crime
| fillnull
| table latitude, longitude
index=chicago_crime
| fillnull
| eval description = "<b>".description."</b>"
| table latitude, longitude, description
index=chicago_crime
| fillnull
| eval description = "<b>".description."</b>"
| eval markerColor = case(like(description, "%HARASSMENT BY TELEPHONE%"), "red", like(description, "%RECKLESS CONDUCT%"), "green", 1=1, "blue"),
icon=case(like(description, "%HARASSMENT BY TELEPHONE%"), "exclamation", like(description, "%RECKLESS CONDUCT%"), "check-circle", 1=1, "circle")
| table latitude, longitude, description, markerColor, icon
index=chicago_crime
| fillnull
| eval description = "<b>".description."</b>"
| eval markerColor = case(like(description, "%HARASSMENT BY TELEPHONE%"), "red", like(description, "%RECKLESS CONDUCT%"), "green", 1=1, "blue"),
icon=case(like(description, "%HARASSMENT BY TELEPHONE%"), "map-marker", like(description, "%RECKLESS CONDUCT%"), "map-pin", 1=1, "circle"),
iconColor=case(like(description, "%HARASSMENT BY TELEPHONE%"), "#374D13", like(description, "%RECKLESS CONDUCT%"), "rgb(0,255,255)", 1=1, "white")
| table latitude, longitude, description, markerColor, icon, iconColor
Red exclamation markers render on top of green check markers on top of smaller blue markers.
index=chicago_crime
| fillnull
| eval description = "<b>".description."</b>",
shadowSize = case(like(description, "%HARASSMENT BY TELEPHONE%"), "30,46", like(description, "%RECKLESS CONDUCT%"), "30,46", 1=1, "20,36"),
shadowAnchor = case(like(description, "%HARASSMENT BY TELEPHONE%"), "30,30", like(description, "%RECKLESS CONDUCT%"), "30,30", 1=1, "32,40"),
extraClasses = case(like(description, "%HARASSMENT BY TELEPHONE%"), "fa-lg", like(description, "%RECKLESS CONDUCT%"), "fa-lg", 1=1, ""),
markerSize = case(like(description, "%HARASSMENT BY TELEPHONE%"), "35,45", like(description, "%RECKLESS CONDUCT%"), "35,45", 1=1, "15,35"),
markerType = case(like(description, "%HARASSMENT BY TELEPHONE%"), "svg", like(description, "%RECKLESS CONDUCT%"), "svg", 1=1, "svg"),
markerColor = case(like(description, "%HARASSMENT BY TELEPHONE%"), "red", like(description, "%RECKLESS CONDUCT%"), "green", 1=1, "blue"),
icon=case(like(description, "%HARASSMENT BY TELEPHONE%"), "exclamation", like(description, "%RECKLESS CONDUCT%"), "check-circle", 1=1, "circle"),
markerPriority=case(like(description, "%HARASSMENT BY TELEPHONE%"), 1000000, like(description, "%RECKLESS CONDUCT%"), 500000, 1=1, -1000000)
| table latitude, longitude, description, markerColor, icon, markerType, markerSize, extraClasses, shadowSize, shadowAnchor, markerPriority
Show path lines with only the last marker visible for data set with the following fields: _time, latitude, longitude, vehicle
| inputlookup vehicles.csv
| reverse
| streamstats current=f window=1 first(_time) as ftime by vehicle
| reverse
| eval markerVisibility=if(isnull(ftime), "marker", "foo"), description=vehicle, pathWeight=case(like(user, "%mustang%"), 10), pathOpacity=case(like(user, "%mustang%"), 0.8)
| table latitude, longitude, vehicle, description, markerVisibility, pathWeight, pathOpacity
Select one of six available map tiles
Use your own map tile URL and override defaults. Example: http://a.tiles.wmflabs.org/hikebike/{z}/{x}/{y}.png. Find more tiles here
Use your own attribution. - Requires browser Refresh
Enable or disable scroll wheel zoom.
Enable or disable full screen mode. Map takes up all available space in browser and adjust to resize. - Requires browser Refresh
Enable or disable drilldown. Double click a marker to activate drilldown. - Requires browser Refresh
Enable or disable context menu when right clicking the map.
Initial Height Of Map (Default: 600)
Dynamically set map view that contains all markers with the maximum zoom level possible when search finishes. (Default: Enabled)
Delay in milliseconds before triggering Auto Fit & Zoom. Increase if you get inconsistent behavior (Default: 500)
Delay in seconds before refreshing the dasbhoard. WARNING - Refresh forces a full browser refresh on the entire dashboard. This workaround addresses a usability issue in the Custom Viz API around reliably honoring panel or global SimpleXML refresh. (default: 0 - disabled)
Initial Zoom for map (Default: 6)
Initial Center Latitiude (Default: 39.50)
Initial Center Longitude (Default: -98.35)
Minimum zoom for tile layer. Does not affect map zoom. (Default: 1)
Maximum zoom for tile layer. Does not affect map zoom. (Default: 19)
Disable clustering and plot all markers. WARNING - This comes at a significant performance penalty for large datasets. - Requires browser Refresh
Display all popups on page load. Only works with clustering disabled. - Requires browser Refresh
Allow multiple popups to dispaly on screen without closing previous. Will disappear at higher zoom levels with clustering enabled. Enabled by default when showing all popups. - Requires browser Refresh
Animate cluster separation on zoom - Requires browser Refresh
Re-style single marker icon to marker cluster style (round) - Requires browser Refresh
A cluster will cover at most this many pixels from its center (Default: 80) - Requires browser Refresh
Display an alert warning that the cluster exceeds threshold at max-zoom and do not show underlying markers. Browser may hang and die if a single point exceeds a very large number.(Default: 100) - Requires browser refresh
Increase to increase the distance away that markers appear from the center when expanded at max zoom. (Default: 1) - Requires browser refresh
Open the tooltip permanently or only on mouseover. Depends on tooltip field in search results.
Tooltip follows mouse instead of fixed position.
Enable or disable Google Places API search control.
Google Places API Key
Position of Google Places Search Bar (Default: Top Left)
Desired zoom level to fly to
(Default: #B5E28C)
(Default: #6ECC39)
Number at which cluster group two starts
(Default: #F1D357)
(Default: #F0C20C)
Number at which cluster group three starts
(Default: #FD9C73)
(Default: #F18017)
Enable or disable dynamic filtering of layer groups on map. Each icon type's visibility can be toggled via control in upper right corner of map. (Default: Enabled)
Collapse or expand layer control widget. If collapsed, mousing over icon will expand. (Default: Collapsed)
Comma separated list of KML or KMZ file names copied into kml directory of app (file1.kml, file2.kml)
Enable or disable measurement plugin to allow path and area measurement on map. (Default: Enabled)
Language (Default: English)
Position of measurement icon on map (Default: Top Right)
Primary unit for length measurement (Default: feet)
Secondary unit for length measurement (Default: miles)
Primary unit for area measurement (Default: acres)
Secondary unit for area measurement (Default: square miles)
Color of measurement when actively drawing (Default: #00ff00)
Color of measurement when drawing is complete (Default: #0066ff)
Draw path lines on map for markers that have multiple coordinates.
Field used to distinguish unique paths, e.g. vehicle number or trip ID
Comma-separated list of hex or html colors for path lines (wraps around if more paths than colors)