Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Addressed comments to docs stand alone and diagnostics #1

Merged
merged 2 commits into from
Aug 29, 2017
Merged

Addressed comments to docs stand alone and diagnostics #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa99bb7
Update PLUGIN_DIAGNOSTICS.md
IzabellaRaulin Aug 29, 2017
3504ca7
Update STAND-ALONE_MODE.md
IzabellaRaulin Aug 29, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/PLUGIN_DIAGNOSTICS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ $ ./snap-plugin-collector-psutil
```
or with plugin configuration in the form of a JSON:
```
$ ./snap-plugin-collector-psutil --config {\"mouting_points\":\"/dev/sda\"}
$ ./snap-plugin-collector-psutil --config '{"mount_points":"/dev/sda"}'
```

Example output:
Expand Down
9 changes: 3 additions & 6 deletions docs/STAND-ALONE_MODE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ To specify a different listening port, use the `--stand-alone-port` flag, e.g.:
$ ./snap-plugin-collector-psutil --stand-alone --stand-alone-port 8183
```
## Loading a plugin
When loading a plugin in stand-alone mode into `snapteld` you must provide a URL to indicate which
machine the plugin is running (IP address/hostname with port number), e.g.:
To load a plugin in stand-alone mode, provide a URL to indicate to the machine on which the plugin is running (IP address/hostname with port number), e.g.:

```
$ snaptel plugin load http://127.0.0.1:8182
Expand All @@ -33,7 +32,5 @@ $ snaptel plugin load http://localhost:8182

The rest of operations remains exactly the same as is it for plugins running in regular mode.

## Notice

If there is any disruption in the connection between Snap and a stand-alone plugin then the task is disabled and the plugin is unloaded,
see [github issue](https://github.com/intelsdi-x/snap/issues/1697).
## Known issues
If some disruption occurs in the connection between Snap and a stand-alone plugin, the running task will be stopped with disabled status and the plugin will be unloaded. Providing the mechanism of reconnecting stand-alone plugins upon network disruption is in our scope, addressed by the [issue #1697](https://github.com/intelsdi-x/snap/issues/1697).