README
¶
routebeat
For constantly tracing routes
routebeat sends ICMP pings to a list of targets to record TCP/IP routing information.
It uses github.com/aeden/traceroute for
sending/recieving ping packets and tracing routes. As well as
elastic/libbeat to talk to
Elasticsearch and other outputs. Essentially, those two libraries do
all the heavy lifting, routebeat is just glue around them.
Routebeat has three events it can publish, including:
- Route summary stats (with a type of "route")
- Route hop messages (with a type of "route_hop")
- Route changes during a beat run (with a type of "route_change")
By default, only the first route event is published.
Requirements
routebeat has the same requirements around the Go environment as libbeat, see here.
Supported Platforms
Currently only MacOS X and Linux are supported due to the use of syscall in github.com/aeden/traceroute
Installation
Install and configure Go.
Install and update this go package with go get -u github.com/xeb/routebeat. The routebeat binary will then be
available in $GOPATH/bin.
If intending on using the Elasticsearch output, you should add a
new index template using the
supplied one, for example with curl -XPUT /_template/routebeat -d @/path/to/routebeat-template.json.
Usage
See the example configuration file for configuring your targets and assigning an output (default output is Elasticsearch).
Once you've created a configuration file you can run
routebeat with routebeat -c /path/to/pingbeat.yml.
NOTE: you will likely need to run sudo routebeat in order to send ICMP pings.
If you'd like to see everything routebeat is doing, run something like:
sudo ./routebeat -e -v -d routebeat -c etc/pingbeat.yml which will output information
from the Debug logger "routebeat".
Kibana Dashboard
There is a Kibana export you can use to create some basic visulizations and a simple dashboard to explore routebeat data.
Note on privileges
In order to send regular ICMP ping packets, routebeat needs to open raw sockets, which can only be done with superuser privileges. So you either need to run routebeat with sudo or as root to send regular pings. I haven't tried a non-priviledged UDP traceroute yet.
Feel free to submit a PR if that is useful:)
License
pingbeat is licensed under the Apache 2.0 license.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/github.com/aeden/traceroute
Package traceroute provides functions for executing a tracroute to a remote host.
|
Package traceroute provides functions for executing a tracroute to a remote host. |
|
_workspace/src/github.com/davecgh/go-spew/spew
Package spew implements a deep pretty printer for Go data structures to aid in debugging.
|
Package spew implements a deep pretty printer for Go data structures to aid in debugging. |
|
_workspace/src/github.com/elastic/libbeat/common/streambuf
The streambuf module provides helpers for buffering multiple packet payloads and some general parsing functions.
|
The streambuf module provides helpers for buffering multiple packet payloads and some general parsing functions. |
|
_workspace/src/github.com/elastic/libbeat/outputs/mode
Package mode defines and implents output strategies with failover or load balancing modes for use by output plugins.
|
Package mode defines and implents output strategies with failover or load balancing modes for use by output plugins. |
|
_workspace/src/github.com/garyburd/redigo/redis
Package redis is a client for the Redis database.
|
Package redis is a client for the Redis database. |
|
_workspace/src/github.com/pmezard/go-difflib/difflib
Package difflib is a partial port of Python difflib module.
|
Package difflib is a partial port of Python difflib module. |
|
_workspace/src/github.com/stretchr/testify/assert
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
|
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system. |
|
_workspace/src/golang.org/x/sys/windows/registry
Package registry provides access to the Windows registry.
|
Package registry provides access to the Windows registry. |
|
_workspace/src/golang.org/x/sys/windows/svc
Package svc provides everything required to build Windows service.
|
Package svc provides everything required to build Windows service. |
|
_workspace/src/golang.org/x/sys/windows/svc/debug
Package debug provides facilities to execute svc.Handler on console.
|
Package debug provides facilities to execute svc.Handler on console. |
|
_workspace/src/golang.org/x/sys/windows/svc/eventlog
Package eventlog implements access to Windows event log.
|
Package eventlog implements access to Windows event log. |
|
_workspace/src/golang.org/x/sys/windows/svc/example
Example service program that beeps.
|
Example service program that beeps. |
|
_workspace/src/golang.org/x/sys/windows/svc/mgr
Package mgr can be used to manage Windows service programs.
|
Package mgr can be used to manage Windows service programs. |
|
_workspace/src/gopkg.in/yaml.v2
Package yaml implements YAML support for the Go language.
|
Package yaml implements YAML support for the Go language. |