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

Commit

Permalink
added README.md for examples package
Browse files Browse the repository at this point in the history
  • Loading branch information
candysmurf committed Dec 4, 2015
1 parent ef027e5 commit cea8bce
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,10 +199,7 @@ Documentation for snap will be kept in this repository for now. We would also li
* [tribe](docs/TRIBE.md)

### Examples
There are interesting examples of using snap in every plugin repository. For the full list of plugins, review the [plugin catalog](https://github.com/intelsdi-x/snap/blob/master/docs/PLUGIN_CATALOG.md):

* [configs](examples/configs/) is a basic example of the configuration file that powers your plugins
* [tasks](examples/tasks/) has JSON-encoded execution requests for snap plugins
There are interesting examples of using snap in every plugin repository. For the full list of plugins, review the [plugin catalog](docs/PLUGIN_CATALOG.md). There is an [Examples](examples/README.md) package that demonstrates snap configurations and usages.

### Roadmap
We have a few known features we want to take on from here while we remain open for feedback after public release. They are:
Expand Down
27 changes: 27 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!--
http://www.apache.org/licenses/LICENSE-2.0.txt
Copyright 2015 Intel Corporation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# Examples
Example package contains a collection of snap examples and [videos](./videos.md) that demonstrate the snap libraries and usages.

* [configs](./configs) is an example of the global configuration file that powers your plugins
* [influxdb-grafana](./influxdb-grafana) has an example of [snap Influxdb publisher plugin](https://github.com/intelsdi-x/snap-plugin-publisher-influxdb). The example demonstrates
Intel [PCM](https://software.intel.com/en-us/articles/intel-performance-counter-monitor) (Performance Counter Monitor) and [PSUTIL](https://github.com/intelsdi-x/snap-plugin-collector-psutil) (Processes and System Utilization) plugins to publish data into Influxdb and using Grafana to view the results.
* [riemann](./riemann) has an example of [snap Riemann publisher plugin](https://github.com/intelsdi-x/snap-plugin-publisher-riemann)
* [tasks](./tasks) has JSON and YAML formatted execution requests for snap tasks

0 comments on commit cea8bce

Please sign in to comment.