Commit cc905f77 authored by Mateusz Kleina's avatar Mateusz Kleina Committed by GitHub

Merge pull request #24 from mkleina/update-doc

Update snap binary names to snaptel/snapteld
parents 462d196c b8e45dcf
...@@ -8,7 +8,7 @@ If you suspect your issue is a bug, please add as much context as you can using ...@@ -8,7 +8,7 @@ If you suspect your issue is a bug, please add as much context as you can using
As a basic rule, if you cannot provide enough information to continue addressing the issue within 7 days, a maintainer will close it. We will, however, reopen it if you later provide the information. Thanks again. As a basic rule, if you cannot provide enough information to continue addressing the issue within 7 days, a maintainer will close it. We will, however, reopen it if you later provide the information. Thanks again.
--> -->
**Snap version** (use `snapctl -v`): **Snap version** (use `snaptel -v`):
**Environment**: **Environment**:
- **Cloud provider or hardware configuration**: - **Cloud provider or hardware configuration**:
......
...@@ -31,7 +31,7 @@ All OSs currently supported by Snap: ...@@ -31,7 +31,7 @@ All OSs currently supported by Snap:
### Installation ### Installation
#### Download the plugin binary: #### Download the plugin binary:
You can get the pre-built binaries for your OS and architecture from the plugin's [GitHub Releases](https://github.com/intelsdi-x/snap-plugin-collector-df/releases) page. Download the plugin from the latest release and load it into `snapd` (`/opt/snap/plugins` is the default location for snap packages). You can get the pre-built binaries for your OS and architecture from the plugin's [GitHub Releases](https://github.com/intelsdi-x/snap-plugin-collector-df/releases) page. Download the plugin from the latest release and load it into `snapteld` (`/opt/snap/plugins` is the default location for snap packages).
#### To build the plugin binary: #### To build the plugin binary:
...@@ -67,26 +67,26 @@ Example running snap-plugin-collector-df plugin and writing data to a file. ...@@ -67,26 +67,26 @@ Example running snap-plugin-collector-df plugin and writing data to a file.
Ensure [snap daemon is running](https://github.com/intelsdi-x/snap#running-snap): Ensure [snap daemon is running](https://github.com/intelsdi-x/snap#running-snap):
* initd: `service snap-telemetry start` * initd: `service snap-telemetry start`
* systemd: `sysctl start snap-telemetry` * systemd: `sysctl start snap-telemetry`
* command line: `snapd -l 1 -t 0 &` * command line: `snapteld -l 1 -t 0 &`
Download and load snap plugins: Download and load snap plugins:
``` ```
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-collector-df/latest/linux/x86_64/snap-plugin-collector-df $ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-collector-df/latest/linux/x86_64/snap-plugin-collector-df
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-publisher-file/latest/linux/x86_64/snap-plugin-publisher-file $ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-publisher-file/latest/linux/x86_64/snap-plugin-publisher-file
$ chmod 755 snap-plugin-* $ chmod 755 snap-plugin-*
$ snapctl plugin load snap-plugin-collector-df $ snaptel plugin load snap-plugin-collector-df
$ snapctl plugin load snap-plugin-publisher-file $ snaptel plugin load snap-plugin-publisher-file
``` ```
See all available metrics: See all available metrics:
``` ```
$ snapctl metric list $ snaptel metric list
``` ```
Download an [example task file](examples/tasks/df-file.json) and load it: Download an [example task file](examples/tasks/df-file.json) and load it:
``` ```
$ curl -sfLO https://raw.githubusercontent.com/intelsdi-x/snap-plugin-collector-df/master/examples/tasks/df-file.json $ curl -sfLO https://raw.githubusercontent.com/intelsdi-x/snap-plugin-collector-df/master/examples/tasks/df-file.json
$ snapctl task create -t df-file.json $ snaptel task create -t df-file.json
Using task manifest to create task Using task manifest to create task
Task created Task created
ID: 480323af-15b0-4af8-a526-eb2ca6d8ae67 ID: 480323af-15b0-4af8-a526-eb2ca6d8ae67
...@@ -94,16 +94,16 @@ Name: Task-480323af-15b0-4af8-a526-eb2ca6d8ae67 ...@@ -94,16 +94,16 @@ Name: Task-480323af-15b0-4af8-a526-eb2ca6d8ae67
State: Running State: Running
``` ```
See realtime output from `snapctl task watch <task_id>` (CTRL+C to exit) See realtime output from `snaptel task watch <task_id>` (CTRL+C to exit)
``` ```
$ snapctl task watch 480323af-15b0-4af8-a526-eb2ca6d8ae67 $ snaptel task watch 480323af-15b0-4af8-a526-eb2ca6d8ae67
``` ```
This data is published to a file `/tmp/published_df.log` per task specification This data is published to a file `/tmp/published_df.log` per task specification
Stop task: Stop task:
``` ```
$ snapctl task stop 480323af-15b0-4af8-a526-eb2ca6d8ae67 $ snaptel task stop 480323af-15b0-4af8-a526-eb2ca6d8ae67
Task stopped: Task stopped:
ID: 480323af-15b0-4af8-a526-eb2ca6d8ae67 ID: 480323af-15b0-4af8-a526-eb2ca6d8ae67
``` ```
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment