isabella232 / snap-plugin-collector-meminfo

Collects Linux memory metrics from /proc/meminfo

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 - meminfo

This plugin collects metrics from /proc/meminfo kernel interface about distribution and utilization of memory.

It's used in the snap framework.

1. Getting Started

• System Requirements
• Installation
• Configuration and Usage

2. Documentation

• Collected Metrics
• Examples
• Roadmap

3. Community Support
4. Contributing
5. License
6. Acknowledgements

Getting Started

System Requirements

• golang 1.7+ - needed only for building

Operating systems

All OSs currently supported by snap:

• Linux/amd64

Installation

Download meminfo plugin binary:

You can get the pre-built binaries for your OS and architecture at plugin's GitHub Releases page.

To build the plugin binary:

Fork https://github.com/intelsdi-x/snap-plugin-collector-meminfo

Clone repo into $GOPATH/src/github.com/intelsdi-x/:

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

Build the plugin by running make within the cloned repo:

$ make

This builds the plugin in ./build

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:
      meminfo:
        all:
          proc_path: /hostproc

Or as part of the task manifest

{
...
    "workflow": {
        "collect": {
            "metrics": {
	      "/intel/procfs/meminfo/mem_total": {}
	    },
	    "config": {
	      "/intel/procfs": {
                "proc_path": "/hostproc"
	      }
	    },
	    ...
       },
    },
...

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

Documentation

Collected Metrics

List of collected metrics is described in METRICS.md.

Examples

Example running meminfo plugin and writing data to a file using snap-plugin-publisher-file.

Set up the Snap framework

Ensure Snap daemon is running:

• initd: service snap-telemetry start
• systemd: systemctl start snap-telemetry
• command line: sudo snapteld -l 1 -t 0 &

Download and load Snap plugins:

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

See available metrics for your system

$ snaptel metric list

Create a task manifest (see exemplary tasks), for example meminfo-file.json with following content:

{
  "version": 1,
  "schedule": {
    "type": "simple",
    "interval": "1s"
  },
  "workflow": {
    "collect": {
      "metrics": {
        "/intel/procfs/meminfo/mem_free": {},
        "/intel/procfs/meminfo/mem_available": {},
        "/intel/procfs/meminfo/mem_total": {},
        "/intel/procfs/meminfo/mem_used": {}
      },
      "config": {
        "/intel/procfs": {
          "proc_path": "/proc"
        }
      },
      "publish": [
        {
          "plugin_name": "file",
          "config": {
            "file": "/tmp/published_meminfo.log"
          }
        }
      ]
    }
  }
}

Create a task:

$ snaptel task create -t meminfo-file.json

Watch created task:

$ snaptel task watch <task_id>

To stop previously created task:

$ snaptel task stop <task_id>

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.

Community Support

This repository is one of many plugins in Snap, a powerful telemetry framework. See the full project at http://github.com/intelsdi-x/snap To reach out to other users, head to the main framework or visit Slack 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: Marcin Krolik