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

Commit

Permalink
Merge pull request #36 from mkleina/update-doc
Browse files Browse the repository at this point in the history
Update snap binary names to snaptel/snapteld
  • Loading branch information
Mateusz Kleina authored Nov 28, 2016
2 parents 28edfc2 + 0e91a64 commit 2f58b66
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
-->

**Snap version** (use `snapctl -v`):
**Snap version** (use `snaptel -v`):

**Environment**:
- **Cloud provider or hardware configuration**:
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This plugin gather disk statistics from /proc/diskstats (Linux 2.6+) or /proc/pa

#### 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-disk/releasess) 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-disk/releasess) 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:

Expand Down Expand Up @@ -95,20 +95,20 @@ Example of running snap disk collector and writing data to file.
Ensure [snap daemon is running](https://github.com/intelsdi-x/snap#running-snap):
* initd: `service snap-telemetry start`
* systemd: `systemctl start snap-telemetry`
* command line: `snapd -l 1 -t 0 &`
* command line: `snapteld -l 1 -t 0 &`

Download and load snap plugins:
```
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-collector-disk/latest/linux/x86_64/snap-plugin-collector-disk
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-publisher-file/latest/linux/x86_64/snap-plugin-publisher-file
$ chmod 755 snap-plugin-*
$ snapctl plugin load snap-plugin-collector-disk
$ snapctl plugin load snap-plugin-publisher-file
$ snaptel plugin load snap-plugin-collector-disk
$ snaptel plugin load snap-plugin-publisher-file
```

See all available metrics:
```
$ snapctl metric list
$ snaptel metric list
NAMESPACE VERSIONS
/intel/procfs/disk/*/io_time 3
/intel/procfs/disk/*/merged_read 3
Expand All @@ -126,17 +126,17 @@ NAMESPACE VERSIONS
Download an [example task file](https://github.com/intelsdi-x/snap-plugin-collector-disk/blob/master/examples/tasks/) and load it:
```
$ curl -sfLO https://raw.githubusercontent.com/intelsdi-x/snap-plugin-collector-disk/master/examples/tasks/diskstats-file.json
$ snapctl task create -t diskstats-file.json
$ snaptel task create -t diskstats-file.json
Using task manifest to create task
Task created
ID: 480323af-15b0-4af8-a526-eb2ca6d8ae67
Name: Task-480323af-15b0-4af8-a526-eb2ca6d8ae67
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
Watching Task (480323af-15b0-4af8-a526-eb2ca6d8ae67):
NAMESPACE DATA TIMESTAMP SOURCE
/intel/procfs/disk/sda1/time_write 0 2015-12-23 11:18:09.224143712 -0500 EST gklab-108-166
Expand Down Expand Up @@ -165,7 +165,7 @@ This data is published to a file `/tmp/published_diskstats` per task specificati

Stop task:
```
$ snapctl task stop 480323af-15b0-4af8-a526-eb2ca6d8ae67
$ snaptel task stop 480323af-15b0-4af8-a526-eb2ca6d8ae67
Task stopped:
ID: 480323af-15b0-4af8-a526-eb2ca6d8ae67
```
Expand Down
6 changes: 3 additions & 3 deletions examples/tasks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ run `mock-disk.sh`.
- [task-mock-disk.yml](task-mock-disk.yml)
- Snap task definition
- [docker-compose.yml](docker-compose.yml)
- A docker compose file which defines a snapd container
- "runner" is the container where snapd is run from. You will be dumped
- A docker compose file which defines a snapteld container
- "runner" is the container where snapteld is run from. You will be dumped
into a shell in this container after running
[run-mock-disk.sh](run-mock-disk.sh). Exiting the shell will
trigger cleaning up the containers used in the example.
- [mock-disk.sh](mock-disk.sh)
- Downloads `snapd`, `snapctl`, `snap-plugin-collector-disk`, and starts the task [task-mock-disk.yml](task-mock-disk.yml).
- Downloads `snapteld`, `snaptel`, `snap-plugin-collector-disk`, and starts the task [task-mock-disk.yml](task-mock-disk.yml).

0 comments on commit 2f58b66

Please sign in to comment.