skydive

module

v0.1.0 Latest Latest Go to latest Published: Feb 10, 2016 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/skydive-project/skydive

Links

Open Source Insights

README ¶

Skydive

Skydive is an open source real-time network topology and protocols analyzer. It aims to provide a comprehensive way of what is happening in the network infrastrure.

Skydive agents collect topology informations and flows and forward them to a central agent for further analysis. All the informations a stored in an Elasticsearch database.

Skydive is SDN-agnostic but provides SDN drivers in order to enhance the topology and flows informations. Currently only the Neutron driver is provided but more drivers will come soon.

Topology Probes

Topology probes currently implemented:

OVSDB
NetLINK
NetNS
Ethtool

Flow Probes

Flow probes currenlty implemented:

sFlow

Dependencies

Go >= 1.5
Elasticsearch

Install

Make sure you have a working Go environment. See the install instructions.

Then make sure you have Godep installed. See the install instructions.

$ go get github.com/redhat-cip/skydive/cmd/skydive_agent
$ go get github.com/redhat-cip/skydive/cmd/skydive_analyzer

Getting started

Skydive relies on two main components:

skydive_agent, has to be started on each node where the topology and flows informations will be captured
skydive_analyzer, the node collecting data captured by the agents

Configuration

A default configuration is present under etc/. For a single node setup only the analyzer and agent port need probably to be changed. For a multiple node setup the analyzer IP/PORT needs to be adapted. Processes are binding 127.0.0.1 by default, you can explicitly change binding address with "listen = 0.0.0.0:port" in any configuration section. The [openstack] section is optional. You can declare it if you want the analyzer to get informations from Openstack/Neutron.

[cache]
# expiration time in second
expire = 300

# cleanup interval in second
cleanup = 30

[openstack]
auth_url = http://xxx.xxx.xxx.xxx:5000/v2.0
username = admin
password = password123
tenant_name = admin
region_name = RegionOne

[analyzer]
flowtable_expire = 5
listen = 8082

[agent]
flowtable_expire = 5
listen = 8081
analyzers = 127.0.0.1:8082

[sflow]
# listen parameter for the sflow agent, Format: addr:port.
# Default addr is 127.0.0.1
listen = 6345

[ovs]
# ovsdb connection, Format: addr:port.
ovsdb = 6400

[graph]
# graph backend memory, gremlin
backend = memory
gremlin = 127.0.0.1:8182

[storage]
elasticsearch = 127.0.0.1:9200

Start

$ skydive_agent -conf etc/skydive.ini

$ skydive_analyzer -conf etc/skydive.ini

WebUI

To access to the WebUI of agents or analyzer:

http://<address>:<port>/static/topology

API

Topology informations are accessible through a RPC API or a WebSocket API

RPC:

curl http://<address>:<port>/rpc/topology

WebSocket endpoint:

ws://<address>:<port>/ws/graph

Messages:

NodeUpdated
NodeAdded
NodeDeleted
EdgeUpdated
EdgeAdded
EdgeDeleted

Contributing

This project accepts contributions. Just fork the repo and submit a pull request!

License

This software is licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
Godeps
_workspace/src/github.com/araddon/gou
_workspace/src/github.com/araddon/gou/goutest
_workspace/src/github.com/bitly/go-hostpool A Go package to intelligently and flexibly pool among multiple hosts from your Go application.	A Go package to intelligently and flexibly pool among multiple hosts from your Go application.
_workspace/src/github.com/calmh/ipfix Package ipfix implements an IPFIX (RFC 5101) parser and interpreter.	Package ipfix implements an IPFIX (RFC 5101) parser and interpreter.
_workspace/src/github.com/calmh/ipfix/etc
_workspace/src/github.com/cenkalti/hub Package hub provides a simple event dispatcher for publish/subscribe pattern.	Package hub provides a simple event dispatcher for publish/subscribe pattern.
_workspace/src/github.com/cenkalti/rpc2 Package rpc2 provides bi-directional RPC client and server similar to net/rpc.	Package rpc2 provides bi-directional RPC client and server similar to net/rpc.
_workspace/src/github.com/cenkalti/rpc2/jsonrpc Package jsonrpc implements a JSON-RPC ClientCodec and ServerCodec for the rpc2 package.	Package jsonrpc implements a JSON-RPC ClientCodec and ServerCodec for the rpc2 package.
_workspace/src/github.com/gima/jsonv/src JSON validator that validates data produced by `json.Unmarshal`.	JSON validator that validates data produced by `json.Unmarshal`.
_workspace/src/github.com/go-gremlin/gremlin
_workspace/src/github.com/golang/protobuf/proto Package proto converts data structures to and from the wire format of protocol buffers.	Package proto converts data structures to and from the wire format of protocol buffers.
_workspace/src/github.com/golang/protobuf/proto/proto3_proto Package proto3_proto is a generated protocol buffer package.	Package proto3_proto is a generated protocol buffer package.
_workspace/src/github.com/google/gopacket Package gopacket provides packet decoding for the Go language.	Package gopacket provides packet decoding for the Go language.
_workspace/src/github.com/google/gopacket/afpacket Package afpacket provides Go bindings for MMap'd AF_PACKET socket reading.	Package afpacket provides Go bindings for MMap'd AF_PACKET socket reading.
_workspace/src/github.com/google/gopacket/bsdbpf
_workspace/src/github.com/google/gopacket/bytediff Package bytediff provides a simple diff utility for looking at differences in byte slices.	Package bytediff provides a simple diff utility for looking at differences in byte slices.
_workspace/src/github.com/google/gopacket/dumpcommand Package dumpcommand implements a run function for pfdump and pcapdump with many similar flags/features to tcpdump.	Package dumpcommand implements a run function for pfdump and pcapdump with many similar flags/features to tcpdump.
_workspace/src/github.com/google/gopacket/examples/arpscan arpscan implements ARP scanning of all interfaces' local networks using gopacket and its subpackages.	arpscan implements ARP scanning of all interfaces' local networks using gopacket and its subpackages.
_workspace/src/github.com/google/gopacket/examples/bidirectional This binary provides an example of connecting up bidirectional streams from the unidirectional streams provided by gopacket/tcpassembly.	This binary provides an example of connecting up bidirectional streams from the unidirectional streams provided by gopacket/tcpassembly.
_workspace/src/github.com/google/gopacket/examples/bytediff This binary shows how to display byte differences to users via the bytediff library.	This binary shows how to display byte differences to users via the bytediff library.
_workspace/src/github.com/google/gopacket/examples/httpassembly This binary provides sample code for using the gopacket TCP assembler and TCP stream reader.	This binary provides sample code for using the gopacket TCP assembler and TCP stream reader.
_workspace/src/github.com/google/gopacket/examples/pcapdump The pcapdump binary implements a tcpdump-like command line tool with gopacket using pcap as a backend data collection mechanism.	The pcapdump binary implements a tcpdump-like command line tool with gopacket using pcap as a backend data collection mechanism.
_workspace/src/github.com/google/gopacket/examples/pfdump The pfdump binary implements a tcpdump-like command line tool with gopacket using pfring as a backend data collection mechanism.	The pfdump binary implements a tcpdump-like command line tool with gopacket using pfring as a backend data collection mechanism.
_workspace/src/github.com/google/gopacket/examples/statsassembly This binary provides sample code for using the gopacket TCP assembler raw, without the help of the tcpreader library.	This binary provides sample code for using the gopacket TCP assembler raw, without the help of the tcpreader library.
_workspace/src/github.com/google/gopacket/examples/synscan synscan implements a TCP syn scanner on top of pcap.	synscan implements a TCP syn scanner on top of pcap.
_workspace/src/github.com/google/gopacket/examples/util Package util provides shared utilities for all gopacket examples.	Package util provides shared utilities for all gopacket examples.
_workspace/src/github.com/google/gopacket/ip4defrag
_workspace/src/github.com/google/gopacket/layers Package layers provides decoding layers for many common protocols.	Package layers provides decoding layers for many common protocols.
_workspace/src/github.com/google/gopacket/macs Package macs provides an in-memory mapping of all valid Ethernet MAC address prefixes to their associated organization.	Package macs provides an in-memory mapping of all valid Ethernet MAC address prefixes to their associated organization.
_workspace/src/github.com/google/gopacket/pcap Package pcap allows users of gopacket to read packets off the wire or from pcap files.	Package pcap allows users of gopacket to read packets off the wire or from pcap files.
_workspace/src/github.com/google/gopacket/pcap/gopacket_benchmark This benchmark reads in file <tempdir>/gopacket_benchmark.pcap and measures the time it takes to decode all packets from that file.	This benchmark reads in file <tempdir>/gopacket_benchmark.pcap and measures the time it takes to decode all packets from that file.
_workspace/src/github.com/google/gopacket/pcapgo Package pcapgo provides some native PCAP support, not requiring C libpcap to be installed.	Package pcapgo provides some native PCAP support, not requiring C libpcap to be installed.
_workspace/src/github.com/google/gopacket/pfring Package pfring wraps the PF_RING C library for Go.	Package pfring wraps the PF_RING C library for Go.
_workspace/src/github.com/google/gopacket/routing Package routing provides a very basic but mostly functional implementation of a routing table for IPv4/IPv6 addresses.	Package routing provides a very basic but mostly functional implementation of a routing table for IPv4/IPv6 addresses.
_workspace/src/github.com/google/gopacket/tcpassembly Package tcpassembly provides TCP stream re-assembly.	Package tcpassembly provides TCP stream re-assembly.
_workspace/src/github.com/google/gopacket/tcpassembly/tcpreader Package tcpreader provides an implementation for tcpassembly.Stream which presents the caller with an io.Reader for easy processing.	Package tcpreader provides an implementation for tcpassembly.Stream which presents the caller with an io.Reader for easy processing.
_workspace/src/github.com/gorilla/context Package context stores values shared during a request lifetime.	Package context stores values shared during a request lifetime.
_workspace/src/github.com/gorilla/mux Package gorilla/mux implements a request router and dispatcher.	Package gorilla/mux implements a request router and dispatcher.
_workspace/src/github.com/gorilla/websocket Package websocket implements the WebSocket protocol defined in RFC 6455.	Package websocket implements the WebSocket protocol defined in RFC 6455.