Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

This is a Snap publisher plugin for storing the metrics into etcd.

License

Notifications You must be signed in to change notification settings

intelsdi-x/snap-plugin-publisher-etcd

Repository files navigation

DISCONTINUATION OF PROJECT.

This project will no longer be maintained by Intel.

This project has been identified as having known security escapes.

Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.

Intel no longer accepts patches to this project.

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.

Build Status

snap publisher plugin - etcd

Allows publishing of data to etcd from 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 snap:

  • Linux/amd64
  • Darwin/amd64

Installation

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

$ git clone https://github.com/<yourGithubID>/snap-plugin-publisher-etcd.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
  • Set Snap Global Global Config field etcd_host to proper etcd host string (e.g. http://localhost:2379)

Documentation

Examples

Example of using snap-plugin-publisher-etcd to store metrics collected by snap-plugin-colector-psutil.

Run etcd (for more info on how to run etcd see etcd getting started and etcd GitHub):

$ etcd &

Ensure Snap daemon is running:

$ snapteld -l -t 0 &

Download and load Snap plugins:

$ snaptel plugin load snap-plugin-collector-psutil
$ snaptel plugin load snap-plugin-publisher-etcd

Create a task:

$ snaptel task create -t psutil-etcd.yml
Using task manifest to create task
Task created
ID: 3b2bc29c-8256-4ca0-a958-05f5d41f6f11
Name: Task-3b2bc29c-8256-4ca0-a958-05f5d41f6f11
State: Running

You may view example tasks here.

Ensure the task is running and collecting metrics:

$ snaptel task watch 3b2bc29c-8256-4ca0-a958-05f5d41f6f11

Query etcd to see metrics:

$ etcdctl ls /intel/psutil --recursive

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 https://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

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