snap collector plugin - cpu

This plugin collects metrics from /proc/stat kernel information about the amount of time, measured in units of USER_HZ (1/100ths of a second on most architectures, use sysconf(_SC_CLK_TCK) to obtain the right value), that the system spent in various states.

It's used in the snap framework.

Getting Started

System Requirements
Operating systems
Installation
Configuration and Usage

Documentation

Collected Metrics
Examples
Roadmap

Community Support
Contributing
License
Acknowledgements

Getting Started

System Requirements

golang 1.5+ - needed only for building

Operating systems

All OSs currently supported by plugin:

Linux/amd64

Installation

You can get the pre-built binaries for your OS and architecture at snap's GitHub Releases page. Download the plugins package from the latest release, unzip and store in a path you want snapd to access.

To build the plugin binary:

Fork https://github.com/intelsdi-x/snap-plugin-collector-cpu
Clone repo into $GOPATH/src/github.com/intelsdi-x/:

$ git clone https://github.com/<yourGithubID>/snap-plugin-collector-cpu.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
If /proc resides in a different directory, say for example by mounting host /proc inside a container at /hostproc, a proc_path configuration item can be added to snapd global config or as part of the task manifest for the metrics to be collected.

As part of snapd global config

---
control:
  plugins:
    collector:
      cpu:
        all:
          proc_path: /hostproc

Or as part of the task manifest

{
...
    "workflow": {
        "collect": {
            "metrics": {
	      "/intel/procfs/cpu/all/user_jiffies" : {}
	    },
	    "config": {
	      "/intel/procfs": {
                "proc_path": "/hostproc"
	      }
	    },
	    ...
       },
    },
...

Load the plugin and create a task, see example in Examples.

Documentation

Collected Metrics

Collected metrics have namespace in following format: /intel/procfs/cpu/<cpu_identifier>/<metric_name>. List of collected metrics in METRICS.md

Examples

Example running CPU collector plugin, passthru processor plugin, and writing data to a file using file publisher plugin.

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 and trust disabled):

$ $SNAP_PATH/bin/snapd -l 1 -t 0

In another terminal window: Load snap-plugin-collector-cpu plugin:

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

See available metrics for your system:

$ $SNAP_PATH/bin/snapctl metric list

Create a task manifest file ( see [exemplary files] (https://github.com/intelsdi-x/snap-plugin-collector-cpu/blob/master/examples/task/)):

{
    "version": 1,
    "schedule": {
        "type": "simple",
        "interval": "1s"
    },
    "workflow": {
        "collect": {
            "metrics": {
	"/intel/procfs/cpu/all/user_jiffies" : {},
	"/intel/procfs/cpu/all/nice_jiffies" : {},
	"/intel/procfs/cpu/all/system_jiffies" : {},
	"/intel/procfs/cpu/all/idle_jiffies" : {},
	"/intel/procfs/cpu/all/iowait_jiffies" : {},
	"/intel/procfs/cpu/all/irq_jiffies" : {},
	"/intel/procfs/cpu/all/softirq_jiffies" : {},
	"/intel/procfs/cpu/all/steal_jiffies" : {},
	"/intel/procfs/cpu/all/guest_jiffies" : {},
	"/intel/procfs/cpu/all/guest_nice_jiffies" : {},
	"/intel/procfs/cpu/all/active_jiffies" : {},
	"/intel/procfs/cpu/all/utilization_jiffies" : {},
	"/intel/procfs/cpu/all/user_percentage" : {},
	"/intel/procfs/cpu/all/nice_percentage" : {},
	"/intel/procfs/cpu/all/system_percentage" : {},
	"/intel/procfs/cpu/all/idle_percentage" : {},
	"/intel/procfs/cpu/all/iowait_percentage" : {},
	"/intel/procfs/cpu/all/irq_percentage" : {},
	"/intel/procfs/cpu/all/softirq_percentage" : {},
	"/intel/procfs/cpu/all/steal_percentage" : {},
	"/intel/procfs/cpu/all/guest_percentage" : {},
	"/intel/procfs/cpu/all/guest_nice_percentage" : {},
	"/intel/procfs/cpu/all/active_percentage" : {},
	"/intel/procfs/cpu/all/utilization_percentage" : {},
	"/intel/procfs/cpu/0/user_jiffies" : {},
	"/intel/procfs/cpu/0/nice_jiffies" : {},
	"/intel/procfs/cpu/0/system_jiffies" : {},
	"/intel/procfs/cpu/0/idle_jiffies" : {},
	"/intel/procfs/cpu/0/iowait_jiffies" : {},
	"/intel/procfs/cpu/0/irq_jiffies" : {},
	"/intel/procfs/cpu/0/softirq_jiffies" : {},
	"/intel/procfs/cpu/0/steal_jiffies" : {},
	"/intel/procfs/cpu/0/guest_jiffies" : {},
	"/intel/procfs/cpu/0/guest_nice_jiffies" : {},
	"/intel/procfs/cpu/0/active_jiffies" : {},
	"/intel/procfs/cpu/0/utilization_jiffies" : {},
	"/intel/procfs/cpu/0/user_percentage" : {},
	"/intel/procfs/cpu/0/nice_percentage" : {},
	"/intel/procfs/cpu/0/system_percentage" : {},
	"/intel/procfs/cpu/0/idle_percentage" : {},
	"/intel/procfs/cpu/0/iowait_percentage" : {},
	"/intel/procfs/cpu/0/irq_percentage" : {},
	"/intel/procfs/cpu/0/softirq_percentage" : {},
	"/intel/procfs/cpu/0/steal_percentage" : {},
	"/intel/procfs/cpu/0/guest_percentage" : {},
	"/intel/procfs/cpu/0/guest_nice_percentage" : {},
	"/intel/procfs/cpu/0/active_percentage" : {},
	"/intel/procfs/cpu/0/utilization_percentage" : {}
            },
            "process": [
                {
                    "plugin_name": "passthru",
                    "process": null,
                    "publish": [
                        {
                            "plugin_name": "file",
                            "config": {
                                "file": "/tmp/published_cpu.log"
                            }
                        }
                    ],
                    "config": null
                }
            ],
            "publish": null
        }
    }
}

Load passthru plugin for processing:

$ $SNAP_PATH/bin/snapctl plugin load build/plugin/snap-processor-passthru
Plugin loaded
Name: passthru
Version: 1
Type: processor
Signed: false
Loaded Time: Fri, 20 Nov 2015 11:44:03 PST

Load file plugin for publishing:

$ $SNAP_PATH/bin/snapctl plugin load build/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/cpu-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

Roadmap

There isn't a current roadmap for this plugin, but it is in active development. As we launch this plugin, we do not have any outstanding requirements for the next release. If you have a feature request, please add it as an issue and/or submit a pull request.

If you have a feature request, please add it as an issue.

Community Support

This repository is one of many plugins in snap, a powerful telemetry framework. The full project is at http://github.com:intelsdi-x/snap. To reach out on other use cases, visit:

snap Gitter channel

Contributing

We love contributions!

There's more than one way to give back, from examples to blogs to code updates. See our recommended process in CONTRIBUTING.md.

And thank you! Your contribution, through code and participation, is incredibly important to us.

License

snap, along with this plugin, is an Open Source software released under the Apache 2.0 License.

Acknowledgements

Author: Katarzyna Zabrocka

ircody / snap-plugin-collector-cpu Goto Github PK

snap-plugin-collector-cpu's Introduction