thomastaylor312 / snap-plugin-publisher-file

Snap publisher to allow publishing to a file

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status

snap publisher plugin - File

This plugin supports pushing metrics into a local file

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

Installation

Download File 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-file Clone repo into $GOPATH/src/github.com/intelsdi-x/:

$ git clone https://github.com/<yourGithubID>/snap-plugin-publisher-file.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
  • Ensure $SNAP_PATH is exported
    export SNAP_PATH=$GOPATH/src/github.com/intelsdi-x/snap/build

Documentation

<< @TODO

Examples

<< @TODO

Roadmap

There isn't a current roadmap for this plugin. However, if additional output types are wanted, please open an issue or submit a pull request as mentioned below.

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

Original code from the Snap repo.

Additional code written by:

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

About

Snap publisher to allow publishing to a file

License:Apache License 2.0


Languages

Language:Shell 48.5%Language:Go 45.7%Language:Makefile 5.7%