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

Commit

Permalink
Adding docs/plugins.yml to generate Plugin Catalog
Browse files Browse the repository at this point in the history 
Fixes #1138

513b401 has a file made usable in this commit. Up to this point, Plugin Catalog has been a manually written markdown file. This commit will include a new file that developers will use to list their plugin in the catalog. We will automate the generation of docs/PLUGIN_CATALOG.md, so that artifact remains.
  • Loading branch information
@mbbroberg
mbbroberg committed Sep 29, 2016
1 parent 513b401 commit f82ec6e
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 18 deletions.
36 changes: 18 additions & 18 deletions docs/PLUGIN_CATALOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ This file is automatically generated. If you would like to add to the plugin lis
| Netstat | Collector | Staples-Inc | Collect TCP connection metrics for the snap telemetry framework | [snap-plugin-collector-netstat](https://github.com/Staples-Inc/snap-plugin-collector-netstat) | [GitHub](https://github.com/Staples-Inc/snap-plugin-collector-netstat/releases/latest) |
| Neutron | Collector | Intel | Collects OpenStack Neutron module metrics | [snap-plugin-collector-neutron](https://github.com/intelsdi-x/snap-plugin-collector-neutron) | [GitHub](https://github.com/intelsdi-x/snap-plugin-collector-neutron/releases/latest) |
| Nfsclient | Collector | Intel | Collects NFS client metrics | [snap-plugin-collector-nfsclient](https://github.com/intelsdi-x/snap-plugin-collector-nfsclient) | [GitHub](https://github.com/intelsdi-x/snap-plugin-collector-nfsclient/releases/latest) |
| Nginx | Collector | Staples-Inc | Collect nginx metrics from the status endpoint | [snap-plugin-collector-nginx](https://github.com/Staples-Inc/snap-plugin-collector-nginx) | [GitHub](https://github.com/Staples-Inc/snap-plugin-collector-nginx/releases/latest) |
| NGINX | Collector | Staples-Inc | Collect nginx metrics from the status endpoint | [snap-plugin-collector-nginx](https://github.com/Staples-Inc/snap-plugin-collector-nginx) | [GitHub](https://github.com/Staples-Inc/snap-plugin-collector-nginx/releases/latest) |
| Node-manager | Collector | Intel | Collects Intel Node Manager performance metrics | [snap-plugin-collector-node-manager](https://github.com/intelsdi-x/snap-plugin-collector-node-manager) | [GitHub](https://github.com/intelsdi-x/snap-plugin-collector-node-manager/releases/latest) |
| Nova | Collector | Intel | Collects OpenStack Nova module metrics | [snap-plugin-collector-nova](https://github.com/intelsdi-x/snap-plugin-collector-nova) | [GitHub](https://github.com/intelsdi-x/snap-plugin-collector-nova/releases/latest) |
| OSv | Collector | Intel | Collects osv performance metrics | [snap-plugin-collector-osv](https://github.com/intelsdi-x/snap-plugin-collector-osv) | [GitHub](https://github.com/intelsdi-x/snap-plugin-collector-osv/releases/latest) |
Expand All @@ -57,31 +57,31 @@ This file is automatically generated. If you would like to add to the plugin lis
| Users | Collector | Intel | Collects Linux user metrics from utmp | [snap-plugin-collector-users](https://github.com/intelsdi-x/snap-plugin-collector-users) | [GitHub](https://github.com/intelsdi-x/snap-plugin-collector-users/releases/latest) |

### Processors
| Name | Type | Maintainer | Description | Link | Download |
| Name | Type | Maintainer | Description | Link | Releases |
| :---- | :---- | :--------- | :---------- | :--- | :------- |
| Anomaly Detection | Processor | Intel | snap plugin intended to process data and highlight outliers | [snap-plugin-processor-anomalydetection](https://github.com/intelsdi-x/snap-plugin-processor-anomalydetection) | [GitHub](https://github.com/intelsdi-x/snap-plugin-processor-anomalydetection/releases/latest) |
| Moving Average | Processor | Intel | Process snap metrics and return a moving average | [snap-plugin-processor-movingaverage](https://github.com/intelsdi-x/snap-plugin-processor-movingaverage) | [GitHub](https://github.com/intelsdi-x/snap-plugin-processor-movingaverage/releases/latest) |
| Statistics | Processor | Intel | Snap plugin intended to process data and return statistics of the data | [snap-plugin-processor-statistics](https://github.com/intelsdi-x/snap-plugin-processor-statistics) | [GitHub](https://github.com/intelsdi-x/snap-plugin-processor-statistics/releases/latest) |
| Tag | Processor | Intel | Process snap metrics and add tags to label the data | [snap-plugin-processor-tag](https://github.com/intelsdi-x/snap-plugin-processor-tag) | [GitHub](https://github.com/intelsdi-x/snap-plugin-processor-tag/releases/latest) |

### Publishers
| Name | Type | Maintainer | Description | Link | Download |
| Name | Type | Maintainer | Description | Link | Releases |
| :---- | :---- | :--------- | :---------- | :--- | :------- |
| Blueflood | Publisher | Staples Inc | Publishes metrics to the Blueflood metrics processing system | [snap-plugin-publisher-blueflood](https://github.com/Staples-Inc/snap-plugin-publisher-blueflood)| direct downloads coming soon |
| Cassandra | Publisher | Intel | Publishes snap metrics into Cassandra | In development by [@candysmurf](https://github.com/candysmurf) | direct downloads coming soon |
| CloudWatch | Publisher | Ticketmaster | Publishes snap metrics to AWS CloudWatch | [snap-plugin-publisher-cloudwatch](https://github.com/Ticketmaster/snap-plugin-publisher-cloudwatch) |direct downloads coming soon |
| File | Publisher | Intel | Publishes snap metrics to a file | [snap-plugin-publisher-file](https://github.com/intelsdi-x/snap-plugin-publisher-file) |
| Graphite | Publisher | Intel | Publishes snap metrics to Graphite | [snap-plugin-publisher-graphite](https://github.com/intelsdi-x/snap-plugin-publisher-graphite) |
| HANA | Publisher | Intel | Publishes snap metrics to SAP Hana | [snap-plugin-publisher-hana](https://github.com/intelsdi-x/snap-plugin-publisher-hana) |
| HEKA | Publisher | Intel | Publishes snap metrics to Mozilla HEKA | [snap-plugin-publisher-heka](https://github.com/intelsdi-x/snap-plugin-publisher-heka) |
| InfluxDB | Publisher | Intel | Publishes snap metrics to InfluxDB | [snap-plugin-publisher-influxdb](https://github.com/intelsdi-x/snap-plugin-publisher-influxdb) |
| Kafka | Publisher | Intel | Publishes snap metrics to Apache Kafka | [snap-plugin-publisher-kafka](https://github.com/intelsdi-x/snap-plugin-publisher-kafka) |
| Kairosdb | Publisher | Intel | Publishes snap metrics to KairosDB | [snap-plugin-publisher-kairosdb](https://github.com/intelsdi-x/snap-plugin-publisher-kairosdb) |
| MySQL | Publisher | Intel | Publishes snap metrics to MySQL | [snap-plugin-publisher-mysql](https://github.com/intelsdi-x/snap-plugin-publisher-mysql) |
| OpenTSDB | Publisher | Intel | Publishes snap metrics to OpenTSDB | [snap-plugin-publisher-opentsdb](https://github.com/intelsdi-x/snap-plugin-publisher-opentsdb) |
| PostgreSQL | Publisher | Intel | Publishes snap metrics to PostreSQL | [snap-plugin-publisher-postgresql](https://github.com/intelsdi-x/snap-plugin-publisher-postgresql) |
| RabbitMQ | Publisher | Intel | Publishes snap metrics to RabbitMQ | [snap-plugin-publisher-rabbitmq](https://github.com/intelsdi-x/snap-plugin-publisher-rabbitmq) |
| Riemann | Publisher | Intel | Publishes snap metrics to Riemann | [snap-plugin-publisher-riemann](https://github.com/intelsdi-x/snap-plugin-publisher-riemann) |
| Blueflood | Publisher | Staples Inc | Publishes metrics to the Blueflood metrics processing system | [snap-plugin-publisher-blueflood](https://github.com/Staples-Inc/snap-plugin-publisher-blueflood)| |
| Cassandra | Publisher | Intel | Publishes snap metrics into Cassandra | In development by [@candysmurf](https://github.com/candysmurf) | No release date - [please open an issue](https://github.com/intelsdi-x/snap/issues) if you'd like to see this
| CloudWatch | Publisher | Ticketmaster | Publishes snap metrics to AWS CloudWatch | [snap-plugin-publisher-cloudwatch](https://github.com/Ticketmaster/snap-plugin-publisher-cloudwatch) | |
| [File](https://github.com/intelsdi-x/snap-plugin-publisher-file) | Publisher | Intel | Publishes snap metrics to a file | [GitHub](https://github.com/intelsdi-x/snap-plugin-publisher-file/releases/latest) |
| [Graphite](https://github.com/intelsdi-x/snap-plugin-publisher-graphite) | Publisher | Intel | Publishes snap metrics to Graphite | [GitHub](https://github.com/intelsdi-x/snap-plugin-publisher-graphite/releases/latest) |
| [HANA](https://github.com/intelsdi-x/snap-plugin-publisher-hana) | Publisher | Intel | Publishes snap metrics to SAP Hana | [GitHub](https://github.com/intelsdi-x/snap-plugin-publisher-hana/releases/latest) |
| [HEKA](https://github.com/intelsdi-x/snap-plugin-publisher-heka) | Publisher | Intel | Publishes snap metrics to Mozilla HEKA | [GitHub](https://github.com/intelsdi-x/snap-plugin-publisher-heka/releases/latest) |
| [InfluxDB](https://github.com/intelsdi-x/snap-plugin-publisher-influxdb) | Publisher | Intel | Publishes snap metrics to InfluxDB | [GitHub](https://github.com/intelsdi-x/snap-plugin-publisher-influxdb/releases/latest) |
| [Kafka](https://github.com/intelsdi-x/snap-plugin-publisher-kafka) | Publisher | Intel | Publishes snap metrics to Apache Kafka | [GitHub](https://github.com/intelsdi-x/snap-plugin-publisher-kafka/releases/latest) |
| [Kairosdb](https://github.com/intelsdi-x/snap-plugin-publisher-kairosdb) | Publisher | Intel | Publishes snap metrics to KairosDB | [GitHub](https://github.com/intelsdi-x/snap-plugin-publisher-kairosdb/releases/latest) |
| [MySQL](https://github.com/intelsdi-x/snap-plugin-publisher-mysql) | Publisher | Intel | Publishes snap metrics to MySQL | [GitHub](https://github.com/intelsdi-x/snap-plugin-publisher-mysql/releases/latest) |
| [OpenTSDB](https://github.com/intelsdi-x/snap-plugin-publisher-opentsdb) | Publisher | Intel | Publishes snap metrics to OpenTSDB | [GitHub](https://github.com/intelsdi-x/snap-plugin-publisher-opentsdb/releases/latest) |
| [PostgreSQL](https://github.com/intelsdi-x/snap-plugin-publisher-postgresql) | Publisher | Intel | Publishes snap metrics to PostreSQL | [GitHub](https://github.com/intelsdi-x/snap-plugin-publisher-postgresql/releases/latest) |
| [RabbitMQ](https://github.com/intelsdi-x/snap-plugin-publisher-rabbitmq) | Publisher | Intel | Publishes snap metrics to RabbitMQ | [GitHub](https://github.com/intelsdi-x/snap-plugin-publisher-rabbitmq/releases/latest) |
| [Riemann](https://github.com/intelsdi-x/snap-plugin-publisher-riemann) | Publisher | Intel | Publishes snap metrics to Riemann | [GitHub](https://github.com/intelsdi-x/snap-plugin-publisher-riemann/releases/latest) |

## Wish List
There will always be more plugins we wish we had. To make sure others can contribute to our community goals, we keep a wish list of what people would like to see. If you see one here and want to start on it please let us know by commenting on the corresponding issue!
Expand Down
28 changes: 28 additions & 0 deletions docs/plugins.yml
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,32 @@
---
#####################
# We're excited you wrote a plugin! Here's how you share it with others:
#
# Notes:
# * This file is in YAML format
# * Plugin repositories MUST have the format of snap-plugin-<TYPE>-<NAME>
# please rename your repository to match.
#
# How to use:
# 1. Add a newline anywhere in the list below
# 2. List your plugin following the <user>/<repo> format
# 3. Open a Pull Request on intelsdi-x/snap (with a clear commit message)
#
# After merging, we run a job to update PLUGIN_CATALOG.md and
# the list available on our website: http://snap-telemetry.io/plugins.html
#####################
- Staples-Inc/snap-plugin-collector-jmx
- Staples-Inc/snap-plugin-collector-couchbase
- Staples-Inc/snap-plugin-collector-nginx
- Staples-Inc/snap-plugin-collector-netstat
- Staples-Inc/snap-plugin-collector-procstat
- raintank/snap-plugin-collector-procnum
- raintank/snap-plugin-collector-ping
- raintank/snap-plugin-collector-memcache
- Staples-Inc/snap-plugin-publisher-blueflood
- Ticketmaster/snap-plugin-publisher-cloudwatch
- intelsdi-x/snap-plugin-processor-statistics
- intelsdi-x/snap-plugin-processor-anomalydetection
- intelsdi-x/snap-plugin-collector-apache
- intelsdi-x/snap-plugin-collector-ceph
- intelsdi-x/snap-plugin-collector-cinder
Expand Down

0 comments on commit f82ec6e

Please sign in to comment.