No description or website provided.
Go Shell Makefile
Latest commit 6e6ce03 Jul 16, 2016 @ctdk ctdk initial re-commit
Permalink
Failed to load latest commit information.
examples/tasks
procnum
scripts
.gitignore
LICENSE
METRICS.md
Makefile
README.md
main.go
main_test.go

README.md

snap collector plugin - procnum

This plugin collects process number metrics.

It's used in the snap framework.

  1. Getting Started
  2. Documentation
  3. License
  4. Acknowledgements

Getting Started

System Requirements

Operating systems

All OSs currently supported by snap:

  • Linux/amd64

Installation

Download procnum plugin binary:

TODO

To build the plugin binary:

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

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

Build the plugin by running make within the cloned repo:

$ make

This builds the plugin in /build/rootfs/

Configuration and Usage

Documentation

Collected Metrics

List of collected metrics is described in METRICS.md.

Example

Example running procnum 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 procnum plugin

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

See available metrics for your system

$ $SNAP_PATH/bin/snapctl metric list

Create a task manifest file (exemplary files in examples/tasks/):

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

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/procnum-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