From 95b10ee54bcfca0bb772ce2e963b9b3267aee27d Mon Sep 17 00:00:00 2001 From: Matt Brender Date: Wed, 24 Aug 2016 09:27:40 -0400 Subject: [PATCH] Adding explanation of plugin folder * These files are not examples, these are part of testing work. Redirect users to our documentation. Note: If we want to update this, it is easy to do so using `cd plugin/; find . -type d -exec cp README.md {} \;` from the project folder. --- plugin/README.md | 23 ++++++++++ plugin/collector/README.md | 23 ++++++++++ .../README.md | 43 ++----------------- .../anothermock/README.md | 23 ++++++++++ .../snap-plugin-collector-mock1/README.md | 13 ++---- .../mock/README.md | 23 ++++++++++ .../snap-plugin-collector-mock2/README.md | 41 ++---------------- .../mock/README.md | 23 ++++++++++ plugin/helper/README.md | 23 ++++++++++ plugin/processor/README.md | 23 ++++++++++ .../snap-plugin-processor-passthru/README.md | 23 ++++++++++ .../passthru/README.md | 23 ++++++++++ plugin/publisher/README.md | 23 ++++++++++ .../snap-plugin-publisher-mock-file/README.md | 5 +++ .../file/README.md | 23 ++++++++++ 15 files changed, 268 insertions(+), 87 deletions(-) create mode 100644 plugin/README.md create mode 100644 plugin/collector/README.md create mode 100644 plugin/collector/snap-plugin-collector-anothermock1/anothermock/README.md create mode 100644 plugin/collector/snap-plugin-collector-mock1/mock/README.md create mode 100644 plugin/collector/snap-plugin-collector-mock2/mock/README.md create mode 100644 plugin/helper/README.md create mode 100644 plugin/processor/README.md create mode 100644 plugin/processor/snap-plugin-processor-passthru/README.md create mode 100644 plugin/processor/snap-plugin-processor-passthru/passthru/README.md create mode 100644 plugin/publisher/README.md create mode 100644 plugin/publisher/snap-plugin-publisher-mock-file/file/README.md diff --git a/plugin/README.md b/plugin/README.md new file mode 100644 index 000000000..d46003c98 --- /dev/null +++ b/plugin/README.md @@ -0,0 +1,23 @@ + +#PLEASE NOTE: These are not example plugins + +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). + +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/collector/README.md b/plugin/collector/README.md new file mode 100644 index 000000000..d46003c98 --- /dev/null +++ b/plugin/collector/README.md @@ -0,0 +1,23 @@ + +#PLEASE NOTE: These are not example plugins + +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). + +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/collector/snap-plugin-collector-anothermock1/README.md b/plugin/collector/snap-plugin-collector-anothermock1/README.md index 570e422ab..d46003c98 100644 --- a/plugin/collector/snap-plugin-collector-anothermock1/README.md +++ b/plugin/collector/snap-plugin-collector-anothermock1/README.md @@ -2,7 +2,7 @@ http://www.apache.org/licenses/LICENSE-2.0.txt -Copyright 2016 Intel Corporation +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. @@ -16,43 +16,8 @@ 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. --> +#PLEASE NOTE: These are not example plugins -## snap Collector Plugin Structure ---- -Mock plugins are for testing purposes and not meant as examples. +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). -#### Plugin binary - -./main.go - -#### Collector Implementation - -./collector/collector.go - -#### JSON RPC examples (using curl) - -If calling a GO based plugin you will want to ensure that the plugin is started in JSON RPC mode. This is done by setting the plugins meta data field RPCType to plugin.JSONRPC. - -You can start a plugin manually for testing by increasing the ping timeout duration. The timeout will be reset each time you call into the plugin. - -``` -./snap-collector-anothermock1 '{"NoDaemon": false, "PingTimeoutDuration": 1000000000000}' -``` - -###### GetConfigPolicy - -``` -curl -d '{"method": "Collector.GetConfigPolicy", "params": [], "id": 1}' http://127.0.0.1: | python -m "json.tool" -``` - -###### GetMetricTypes - -``` -curl -d '{"method": "Collector.GetMetricTypes", "params": [], "id": 1}' http://127.0.0.1: -``` - -###### CollectMetrics - -``` -curl -X POST -H "Content-Type: application/json" -d '{"method": "Collector.CollectMetrics", "params": [[{"namespace": ["intel","anothermock", "bar"]},{"namespace": ["intel","anothermock","foo"], "config": {"table": {"password": {"Value": "asdf"}}}}]], "id": 1}' http://127.0.0.1: | python -m "json.tool" -``` +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/collector/snap-plugin-collector-anothermock1/anothermock/README.md b/plugin/collector/snap-plugin-collector-anothermock1/anothermock/README.md new file mode 100644 index 000000000..d46003c98 --- /dev/null +++ b/plugin/collector/snap-plugin-collector-anothermock1/anothermock/README.md @@ -0,0 +1,23 @@ + +#PLEASE NOTE: These are not example plugins + +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). + +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/collector/snap-plugin-collector-mock1/README.md b/plugin/collector/snap-plugin-collector-mock1/README.md index 4bb7b6389..d46003c98 100644 --- a/plugin/collector/snap-plugin-collector-mock1/README.md +++ b/plugin/collector/snap-plugin-collector-mock1/README.md @@ -16,15 +16,8 @@ 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. --> +#PLEASE NOTE: These are not example plugins -## snap Collector Plugin Structure ---- -Mock plugins are for testing purposes and not meant as examples. +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). -#### Plugin binary - -./main.go - -##### Collector Implementation - -./collector/collector.go +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/collector/snap-plugin-collector-mock1/mock/README.md b/plugin/collector/snap-plugin-collector-mock1/mock/README.md new file mode 100644 index 000000000..d46003c98 --- /dev/null +++ b/plugin/collector/snap-plugin-collector-mock1/mock/README.md @@ -0,0 +1,23 @@ + +#PLEASE NOTE: These are not example plugins + +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). + +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/collector/snap-plugin-collector-mock2/README.md b/plugin/collector/snap-plugin-collector-mock2/README.md index 46d979057..d46003c98 100644 --- a/plugin/collector/snap-plugin-collector-mock2/README.md +++ b/plugin/collector/snap-plugin-collector-mock2/README.md @@ -16,43 +16,8 @@ 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. --> +#PLEASE NOTE: These are not example plugins -## snap Collector Plugin Structure ---- -Mock plugins are for testing purposes and not meant as examples. +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). -#### Plugin binary - -./main.go - -#### Collector Implementation - -./collector/collector.go - -#### JSON RPC examples (using curl) - -If calling a GO based plugin you will want to ensure that the plugin is started in JSON RPC mode. This is done by setting the plugins meta data field RPCType to plugin.JSONRPC. - -You can start a plugin manually for testing by increasing the ping timeout duration. The timeout will be reset each time you call into the plugin. - -``` -./snap-collector-mock2 '{"NoDaemon": false, "PingTimeoutDuration": 1000000000000}' -``` - -###### GetConfigPolicy - -``` -curl -d '{"method": "Collector.GetConfigPolicy", "params": [], "id": 1}' http://127.0.0.1: | python -m "json.tool" -``` - -###### GetMetricTypes - -``` -curl -d '{"method": "Collector.GetMetricTypes", "params": [], "id": 1}' http://127.0.0.1: -``` - -###### CollectMetrics - -``` -curl -X POST -H "Content-Type: application/json" -d '{"method": "Collector.CollectMetrics", "params": [[{"namespace": ["intel","mock", "bar"]},{"namespace": ["intel","mock","foo"], "config": {"table": {"password": {"Value": "asdf"}}}}]], "id": 1}' http://127.0.0.1: | python -m "json.tool" -``` +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/collector/snap-plugin-collector-mock2/mock/README.md b/plugin/collector/snap-plugin-collector-mock2/mock/README.md new file mode 100644 index 000000000..d46003c98 --- /dev/null +++ b/plugin/collector/snap-plugin-collector-mock2/mock/README.md @@ -0,0 +1,23 @@ + +#PLEASE NOTE: These are not example plugins + +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). + +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/helper/README.md b/plugin/helper/README.md new file mode 100644 index 000000000..d46003c98 --- /dev/null +++ b/plugin/helper/README.md @@ -0,0 +1,23 @@ + +#PLEASE NOTE: These are not example plugins + +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). + +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/processor/README.md b/plugin/processor/README.md new file mode 100644 index 000000000..d46003c98 --- /dev/null +++ b/plugin/processor/README.md @@ -0,0 +1,23 @@ + +#PLEASE NOTE: These are not example plugins + +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). + +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/processor/snap-plugin-processor-passthru/README.md b/plugin/processor/snap-plugin-processor-passthru/README.md new file mode 100644 index 000000000..d46003c98 --- /dev/null +++ b/plugin/processor/snap-plugin-processor-passthru/README.md @@ -0,0 +1,23 @@ + +#PLEASE NOTE: These are not example plugins + +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). + +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/processor/snap-plugin-processor-passthru/passthru/README.md b/plugin/processor/snap-plugin-processor-passthru/passthru/README.md new file mode 100644 index 000000000..d46003c98 --- /dev/null +++ b/plugin/processor/snap-plugin-processor-passthru/passthru/README.md @@ -0,0 +1,23 @@ + +#PLEASE NOTE: These are not example plugins + +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). + +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/publisher/README.md b/plugin/publisher/README.md new file mode 100644 index 000000000..d46003c98 --- /dev/null +++ b/plugin/publisher/README.md @@ -0,0 +1,23 @@ + +#PLEASE NOTE: These are not example plugins + +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). + +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/publisher/snap-plugin-publisher-mock-file/README.md b/plugin/publisher/snap-plugin-publisher-mock-file/README.md index a8e2d20b3..d46003c98 100644 --- a/plugin/publisher/snap-plugin-publisher-mock-file/README.md +++ b/plugin/publisher/snap-plugin-publisher-mock-file/README.md @@ -16,3 +16,8 @@ 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. --> +#PLEASE NOTE: These are not example plugins + +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). + +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist). diff --git a/plugin/publisher/snap-plugin-publisher-mock-file/file/README.md b/plugin/publisher/snap-plugin-publisher-mock-file/file/README.md new file mode 100644 index 000000000..d46003c98 --- /dev/null +++ b/plugin/publisher/snap-plugin-publisher-mock-file/file/README.md @@ -0,0 +1,23 @@ + +#PLEASE NOTE: These are not example plugins + +The contents of `plugin/` are used as part of our testing framework. If you are looking for examples of how to write a plugin for Snap, review the [Plugin Authoring documentation](/docs/PLUGIN_AUTHORING.md). + +Curious what plugins are under development? See the `plugin-wishlist` label in [our issue backlog](https://github.com/intelsdi-x/snap/labels/plugin-wishlist).