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

Commit

Permalink
Merge pull request #24 from katarzyna-z/readme-update
Browse files Browse the repository at this point in the history 
Updated readme, added example without mock plugins
  • Loading branch information
@kindermoumoute
kindermoumoute authored Nov 12, 2016
2 parents 8ac4e8a + 9dfbedf commit 12f4009
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 45 deletions.
129 changes: 84 additions & 45 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# snap publisher plugin - Graphite
# Snap publisher plugin - Graphite

This plugin publishes metrics to graphite.

1. [Getting Started](#getting-started)
* [System Requirements](#system-requirements)
* [Installation](#installation)
* [Configuration and Usage](configuration-and-usage)
* [Configuration and Usage](#configuration-and-usage)
2. [Documentation](#documentation)
* [Task Manifest Config](#task-manifest-config)
* [Examples](#examples)
* [Roadmap](#roadmap)
3. [Community Support](#community-support)
Expand All @@ -19,10 +20,11 @@ This plugin publishes metrics to graphite.

### Installation
#### Download Graphite plugin binary:
You can get the pre-built binaries for your OS and architecture at snap's [Github Releases](https://github.com/intelsdi-x/snap-plugin-publisher-graphite/releases) page.
You can get the pre-built binaries for your OS and architecture at plugin's [Github Releases](https://github.com/intelsdi-x/snap-plugin-publisher-graphite/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
Expand All @@ -31,79 +33,116 @@ Build the plugin by running make in repo:
```
$ make
```
This builds the plugin in `/build/$GOOS/$GOARCH`
This builds the plugin in `./build`

### Configuration and Usage
* Set up the [Snap framework](https://github.com/intelsdi-x/snap/blob/master/README.md#getting-started)

## Documentation
[graphite](https://graphite.readthedocs.org/en/latest/)

### Task Manifest Config
In task manifest, the config section of graphite publisher describes how to establish a connection.

List of config arguments:
* "server" (required) - the IP of graphite host.
* "port" (optional) - 2003 by default.
* "prefix_tags" (optional) - coma separated list of metric tags used to add prefix on the published name, "plugin_running_on" by default.
* "prefix" (optional) - change the published name prefix, happens before prefixes from "prefix_tags".

### Examples

Example of running [psutil collector plugin](https://github.com/intelsdi-x/snap-plugin-collector-psutil), [movingaverage processor plugin](https://github.com/intelsdi-x/snap-plugin-processor-movingaverage), and publishing data to graphite.
Set up the [Snap framework](https://github.com/intelsdi-x/snap/blob/master/README.md#getting-started)

Ensure [snap daemon is running](https://github.com/intelsdi-x/snap#running-snap):
* initd: `service snap-telemetry start`
* systemd: `systemctl start snap-telemetry`
* command line: `sudo snapd -l 1 -t 0 &`

#### Example task
Example task manifest to use Graphite plugin:

Download and load Snap plugins:
```
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-publisher-graphite/latest/linux/x86_64/snap-plugin-publisher-graphite
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-processor-movingaverage/latest/linux/x86_64/snap-plugin-processor-movingaverage
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-collector-psutil/latest/linux/x86_64/snap-plugin-collector-psutil
$ snapctl plugin load snap-plugin-publisher-graphite
$ snapctl plugin load snap-plugin-processor-movingaverage
$ snapctl plugin load snap-plugin-collector-psutil
```

Create a [task manifest](https://github.com/intelsdi-x/snap/blob/master/docs/TASKS.md) (see [exemplary tasks](examples/tasks/)),
for example `psutil-movingaverage-graphite.json` with following content:
```json
{
"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",
"publish": [
{
"plugin_name": "graphite",
"config": {
"server": "127.0.0.1",
"port": 2003
}
}
]
}
]
"version": 1,
"schedule": {
"type": "simple",
"interval": "1s"
},
"max-failures": 10,
"workflow": {
"collect": {
"metrics": {
"/intel/psutil/load/load1": {},
"/intel/psutil/load/load15": {},
"/intel/psutil/load/load5": {},
"/intel/psutil/vm/available": {},
"/intel/psutil/vm/free": {},
"/intel/psutil/vm/used": {}
},
"process": [
{
"plugin_name": "movingaverage",
"config": {
"MovingAvgBufLength": 5
}
}
],
"publish": [
{
"plugin_name": "graphite",
"config": {
"server": "127.0.0.1",
"port": 2003
}
}
]
}
}
}
```

List of config arguments:
* "server" (required) - the IP of graphite host.
* "port" (optional) - 2003 by default.
* "prefix_tags" (optional) - coma separated list of metric tags used to add prefix on the published name, "plugin_running_on" by default.
* "prefix" (optional) - change the published name prefix, happens before prefixes from "prefix_tags".
Create a task:
```
$ snapctl task create -t psutil-movingaverage-graphite.json
```

Watch created task:
```
$ snapctl task watch <task_id>
```

To stop previously created task:
```
$ snapctl 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](https://github.com/intelsdi-x/snap-plugin-publisher-graphite/issues/new) and/or submit a [pull request](https://github.com/intelsdi-x/snap-plugin-publisher-graphite/pulls).

## 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](https://github.com/intelsdi-x/snap#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](https://github.com/intelsdi-x/snap#community-support)

## 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](CONTRIBUTING.md).

## License
[snap](http://github.com:intelsdi-x/snap), along with this plugin, is an Open Source software released under the Apache 2.0 [License](LICENSE).
[Snap](http://github.com:intelsdi-x/snap), along with this plugin, is an Open Source software released under the Apache 2.0 [License](LICENSE).

## Acknowledgements
List authors, co-authors and anyone you'd like to mention
Expand Down
37 changes: 37 additions & 0 deletions examples/tasks/psutil-movingaverage-graphite.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"version": 1,
"schedule": {
"type": "simple",
"interval": "1s"
},
"max-failures": 10,
"workflow": {
"collect": {
"metrics": {
"/intel/psutil/load/load1": {},
"/intel/psutil/load/load15": {},
"/intel/psutil/load/load5": {},
"/intel/psutil/vm/available": {},
"/intel/psutil/vm/free": {},
"/intel/psutil/vm/used": {}
},
"process": [
{
"plugin_name": "movingaverage",
"config": {
"MovingAvgBufLength": 5
}
}
],
"publish": [
{
"plugin_name": "graphite",
"config": {
"server": "127.0.0.1",
"port": 2003
}
}
]
}
}
}

0 comments on commit 12f4009

Please sign in to comment.