snap-plugin-publisher-graphite

README

snap publisher plugin - Graphite

This plugin publishes metrics to graphite.

1. Getting Started

• System Requirements
• Installation
• Configuration and Usage

1. Documentation

• Examples
• Roadmap

1. Community Support
2. Contributing
3. License
4. Acknowledgements

System Requirements

• Graphite set up and running `An easy way to get up and running for testing is to use this
• Snap Daemon running

Installation

Download Graphite plugin binary:

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

To build the plugin binary:

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

$ git clone https://github.com/<yourGithubID>/snap-plugin-publisher-graphite

Build the plugin by running make in repo:

$ make

This builds the plugin in /build/rootfs

Configuration and Usage

• Set up the snap framework
• Ensure $SNAP_PATH is exported export SNAP_PATH=$GOPATH/src/github.com/intelsdi-x/snap/build

Documentation

graphite

Examples

Example task manifest to use Graphite plugin:

{
    "version": 1,
    "schedule": {
        "type": "simple",
        "interval": "1s"
    },
    "workflow": {
        "collect": {
            "metrics": {
                "/intel/mock/foo": {},
                "/intel/mock/bar": {},
                "/intel/mock/*/baz": {}
            },
            "config": {
                "/intel/mock": {
                    "user": "root",
                    "password": "secret"
                }
            },
            "process": [
                {
                    "plugin_name": "passthru",
                    "process": null,
                    "publish": [
                        {
                            "plugin_name": "graphite",
                            "config": {
                                "server": "127.0.0.1",
                                "port": 2003
                            }
                        }
                    ]
                }
            ]
        }
    }
}

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

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.

License

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

Acknowledgements

List authors, co-authors and anyone you'd like to mention

• Author: Cody Roseborough

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