- About SA-geodistance
- Release notes
- Support and resources
- Hardware and software requirements
- Installation steps
- Key concepts
- Data types
- Configure SA-geodistance
- Troubleshooting
- Upgrade
- Copyright & License
| Author | Oluwaseun Remi-Omosowon |
|---|---|
| App Version | 1.2.1 |
| Vendor Products |
|
| Support-addon | This add-on only needs to be installed on the search heads only (Either standalone or dedicated/clustered) |
The SA-geodistance allows a Splunk® Enterprise user to compute the relative vincenty/haversine distances of adjacent events given their latitudes and longitudes.
Includes:
- Splunk SDK for Python (1.6.14)
- vincenty v0.1.4 - supports the calculation of vincenty distances which is used by default
- haversine v2.3.0 - Supports the use of haversine
- geodistance.py : This is the splunk reporting command introduced by this app
- enum34 v1.1.10 : Required by on Python 2.4-3.3 when using haversine
Version 1.2.1 of the SA-geodistance is compatible with Splunk Enterprise 8.x, Splunk Cloud 7.x and Splunk Cloud 8.x. It will also work with later versions of Splunk 7.x that supports Python3. This version removes support for Python2.
| Splunk Enterprise versions | 7.3+, 8.x |
| Splunk Cloud | 7.x, 8.x |
|---|---|
| CIM | Not Applicable |
| Platforms | Platform independent |
| Lookup file changes | No lookups included in this app |
SA-geodistance includes the following new features:
- Diagnostic Logging
- Python v3 / Splunk v8.x support
This version includes support for Python v3 and Splunk v8.x. The distance returned by default is in kilometers.
This version of the SA-geodistance doesnt introduce any fixes and simply updates the permission of python files so it's not executable.
There are no known issues in this version.
This version of the app incorporates the following third-party software or libraries. Available at: and MIT licensed .
- Vincenty 0.1.4, (public domain)
- haversine 2.3.0, (https://github.com/mapado/haversine/blob/master/LICENSE)
- Splunk SDK, 1.6.14, (https://www.apache.org/licenses/LICENSE-2.0)
Questions and answers
Access questions and answers specific to the SA-geodistance at (https://answers.splunk.com/).
Support
This Splunk support add-on is community / developer supported.
Questions asked on Splunk answers will be answered either by the community of users or by the developer when available. All support questions should include the version of Splunk and OS.
You can also contact the developer directly via [Splunkbase] (https://splunkbase.splunk.com/app/3232/). Feedback and feature requests can also be sent via splunkbase.
Issues can also be submitted at the [SA-geodistance repo via on Github] (https://github.com/seunomosowon/SA-geodistance/issues)
-
v1.0.1
- Update to documentation
-
v1.0
- Passed Splunk app certification
-
v0.3.8
- Added logging support
- Added support for debug logging and documentation for this on README.md
- Changed to v2 command style
-
v0.3.7
- Updated field descripition for longitude and haversine
-
v0.3.5 / 0.3.6
- Added icons
- called icons to size
-
v0.3.4
- Updated permission of files
- Added syntax to search UI
-
v0.3.3
- Fixed logging.conf
-
v0.3.1
- Updated check_for_updates in app.conf
-
v0.3
- Added support for haversine
SA-geodistance supports the following server platforms in the versions supported by Splunk Enterprise:
- Linux
- Windows
The app was developed to be platform agnostic, but tests are mostly run on unix. Please contact the developer with issues running this on Windows.
To function properly, SA-geodistance has no external requirements but needs to be installed on a full Splunk install which provides python and the basic math libraries needed.
Because this add-on runs on Splunk Enterprise, all of the Splunk Enterprise system requirements apply.
Download the SA-geodistance at Splunkbase OR GitHub.
To install and configure this app on your supported standalone platform, do one of the following:
- Install on a standalone search head via the GUI (https://docs.splunk.com/Documentation/AddOns/released/Overview/Singleserverinstall)
- Extract the app to
$SPLUNK_HOME/etc/apps/and restart Splunk
For a supported distributed environment, follow the steps to install the SA-geodistance on the search head only.
For a clustered search head environment, install SA-geodistance via the search head deployer.
More instructions available at the following [URL] (https://docs.splunk.com/Documentation/AddOns/released/Overview/Distributedinstall)
For Splunk cloud installations, follow the instructions present at the following [link] (https://docs.splunk.com/Documentation/AddOns/released/Overview/SplunkCloudinstall)
| geodistance latfield= longfield= output_field=
miles= group_by= haversine=
This app can return distances as miles or kilometer (default). To return distances in miles,
pass the miles=True as an argument to the command.
It computes the vincenty distances by default. To use haversine instead, add the paramter haversine=True or haversine=T
It can also compute the adjacent distances for different groups by passing the grouping criteria, group_by=group.
This currently supports grouping by a single field. A future update will support grouping by multiple fields.
-
Note: The first event in the result will also have a distance of 0.0
-
Events that do not have latitudes or longitudes, as is the output when geocoding private non-routed IP addresses, will be given a distance of 0.0. The next relative distance will still be based on last public address found.
This can be used to easily obtain the distance between multiple VPN authentication attempts which could indicate a compromise where relative distances are above a maximum/expected commutable distance.
index=vpn | stats count by src_ip , user |
iplocation src_ip |
fields src_ip, user, lat, lon |
geodistance latfield=lat longfield=lon output_field=distance group_by=user
This example has been written around the sample app that comes with Splunk. THis example was carried out using the data generated by the sample app that ships disabled with Splunk Enterprise.
This search extracts the clientip field from the relay field, and geocodes using the inbuilt iplocation search command.
The relative distance in (Km) of each adjacent event is then computed using the geodistance command.
S1:
index=sample | rex field=relay \"\[(?<clientip>.*)\]\" |
iplocation clientip | table lat lon clientip |
geodistance latfield=lat longfield=lon output_field=distance miles=True
S2:
index=sample | rex field=relay "\[(?<clientip>.*)\]" |
iplocation clientip | table clientip lat lon| search lat=* |
geodistance latfield=lat longfield=lon output_field=distance group_by=clientip
Note: the relative distance between all events with the same clientip will be zero
S3:
index=sample | rex field=relay "\[(?<clientip>.*)\]" |
iplocation clientip | table clientip lat lon from | search lat=* |
geodistance latfield=lat longfield=lon output_field=distance group_by=from | dedup from distance
This app outputs the relative distance into the field specified in output_field parameter.
This app has no configurations.
The command writes logs to `$SPLUNK_HOME/var/log/splunk/SA-geodistance.log. This can be seen by searching your internal index using index=_internal source=*SA-geodistance.log```.
-- To enable debug logging for the geodistance command, add the following to SA-geodistance/local/logging.conf
[logger_GeoDistanceCommand]
level = DEBUG
This app supports in-place upgrade of older verisons. Alternatively, remove older versions before installing the newest version.
The Splunk SDK for Python is licensed under the Apache License 2.0 which can be found at: (https://www.apache.org/licenses/LICENSE-2.0)
The Haversine 2.3.0 module is included from Pypi and is licensed under MIT which permits its use and distribution given the notice below.
Copyright (c) 2015 Mapado
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
This support add-on is licensed under the Splunk End User License Agreement for Third-Party Content license agreement.