snap collector plugin - tcpconns

This plugin collects local TCP connection metrics.

It's used in the snap framework.

1. Getting Started

• System Requirements
• Operating systems
• Installation
• Configuration and Usage

2. Documentation

• Collected Metrics
• Examples

3. License
4. Acknowledgements

Getting Started

System Requirements

• golang 1.5+ - needed only for building

Operating systems

All OSs currently supported by snap:

• Linux/amd64

Installation

Download tcpconns plugin binary:

TODO

To build the plugin binary:

Fork https://github.com/raintank/snap-plugin-collector-tcpconns
Clone repo into $GOPATH/src/github.com/raintank/:

$ git clone https://github.com/<yourGithubID>/snap-plugin-collector-tcpconns.git

Build the plugin by running make within the cloned repo:

$ make

This builds the plugin in /build/rootfs/

Configuration and Usage

• Set up the snap framework.
• Load the plugin and create a task, see example in Examples.

Documentation

Collected Metrics

List of collected metrics is described in METRICS.md.

Example

Example running tcpconns collector and writing data to a file.

Make sure that your $SNAP_PATH is set, if not:

$ export SNAP_PATH=<snapDirectoryPath>/build

Other paths to files should be set according to your configuration, using a file you should indicate where it is located.

In one terminal window, open the snap daemon (in this case with logging set to 1, trust disabled and global configuration saved in config.json ):

$ $SNAP_PATH/bin/snapd -l 1 -t 0 --config config.json

In another terminal window: Load tcpconns plugin

$ $SNAP_PATH/bin/snapctl plugin load snap-plugin-collector-tcpconns

See available metrics for your system

$ $SNAP_PATH/bin/snapctl metric list

Create a task manifest file (exemplary files in [examples/tasks/] (https://github.com/raintank/snap-plugin-collector-tcpconns/blob/master/examples/tasks/)):

{
    "version": 1,
    "schedule": {
        "type": "simple",
        "interval": "1s"
    },
    "workflow": {
        "collect": {
            "metrics": {
                "/raintank/tcpconns/*": {}
            },
            "config": {
            	"/raintank/tcpconns": {
            		"hostname": "127.0.0.1"
            	}
            },
            "process": null,
            "publish": [
                {
                    "plugin_name": "file",
                    "config": {
                        "file": "/tmp/published_tcpconns"
                    }
                }
            ]
        }
    }
}

Load file plugin for publishing:

$ $SNAP_PATH/bin/snapctl plugin load $SNAP_PATH/plugin/snap-publisher-file
Plugin loaded
Name: file
Version: 3
Type: publisher
Signed: false
Loaded Time: Fri, 20 Nov 2015 11:41:39 PST

Create a task:

$ $SNAP_PATH/bin/snapctl task create -t examples/tasks/tcpconns-file.json
Using task manifest to create task
Task created
ID: 02dd7ff4-8106-47e9-8b86-70067cd0a850
Name: Task-02dd7ff4-8106-47e9-8b86-70067cd0a850
State: Running

Stop previously created task:

$ $SNAP_PATH/bin/snapctl task stop 02dd7ff4-8106-47e9-8b86-70067cd0a850
Task stopped:
ID: 02dd7ff4-8106-47e9-8b86-70067cd0a850

License

This plugin is Open Source software released under the Apache 2.0 License.

Acknowledgements

• Author: @Anthony Woods