Collects Linux CPU metrics from /proc/stat
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
cpu
examples
scripts
.gitignore
.pluginsync.yml
.sync.yml
.travis.yml
CONTRIBUTING.md
LICENSE
METRICS.md
Makefile
README.md
glide.lock
glide.yaml
main.go
metadata.yml

README.md

Build Status Build Status

DISCONTINUATION OF PROJECT

This project will no longer be maintained by Intel. Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project.

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.

  1. Getting Started
  1. Documentation
  1. Community Support
  2. Contributing
  3. License
  4. Acknowledgements

Getting Started

System Requirements

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 snapteld 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/$GOOS/$GOARCH

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 snapteld global config or as part of the task manifest for the metrics to be collected.

As part of snapteld global config

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

Or as part of the task manifest

{
...
    "workflow": {
        "collect": {
            "metrics": {
	      "/intel/procfs/cpu/*/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 can be found in METRICS.md

Examples

Run the example

./examples/run-cpu-file.sh

Run the plugin manually

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

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):

$ snapteld -l 1 -t 0

In another terminal window:

Load snap-plugin-collector-cpu plugin:

$ snaptel plugin load snap-plugin-collector-cpu

See available metrics for your system:

$ snaptel metric list

Get file plugin for publishing, appropriate for Linux or Darwin:

$ wget  http://snap.ci.snap-telemetry.io/plugins/snap-plugin-publisher-file/latest/linux/x86_64/snap-plugin-publisher-file

or

$ wget  http://snap.ci.snap-telemetry.io/plugins/snap-plugin-publisher-file/latest/darwin/x86_64/snap-plugin-publisher-file

Load file plugin for publishing:

$ snaptel plugin load snap-plugin-publisher-file

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

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

Create a task:

$ snaptel task create -t 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:

$ snaptel 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 Slack.

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