diff --git a/docs/TASKS.md b/docs/TASKS.md index c99d7f264..508ae580f 100644 --- a/docs/TASKS.md +++ b/docs/TASKS.md @@ -16,16 +16,16 @@ A task can be in the following states: ![statediagram](https://cloud.githubusercontent.com/assets/11335874/23362447/0f0b9f74-fcf6-11e6-93d7-889a7ccdc45f.png) - How To | Command - ----------------------------------------|------------------------ - Create task | snaptel task create _[command options] [arguments...]_
Find more details [here](https://github.com/intelsdi-x/snap/blob/master/docs/SNAPTEL.md#task) - List | snaptel task list - Start task | snaptel task start _\_ - Stop task | snaptel task stop _\_ - Remove task | snaptel task remove _\_ - Export task | snaptel task export _\_ - Watch task | snaptel task watch _\_ - Enable task | snaptel task enable _\_ + How To | Command +----------------------------------------|---------------------------------------- + Create task | snaptel task create _[command options] [arguments...]_
Find more details [here](https://github.com/intelsdi-x/snap/blob/master/docs/SNAPTEL.md#task) + List | snaptel task list + Start task | snaptel task start _\_ + Stop task | snaptel task stop _\_ + Remove task | snaptel task remove _\_ + Export task | snaptel task export _\_ + Watch task | snaptel task watch _\_ + Enable task | snaptel task enable _\_ ## Task Manifest @@ -215,13 +215,13 @@ Metrics can be enumerated using: Declaring a metric's name exactly as it appears in the metric catalog (see `snaptel metric list`). - Metrics requested in task manifest | Collected metrics - --------------------------------------------|------------------------ - /intel/mock/foo | /intel/mock/foo - | - /intel/mock/bar | /intel/mock/bar - | - /intel/mock/\*/baz
_(dynamic metric)_ | /intel/mock/host0/baz
/intel/mock/host1/baz
/intel/mock/host2/baz
/intel/mock/host3/baz
/intel/mock/host4/baz
/intel/mock/host5/baz
/intel/mock/host6/baz
/intel/mock/host7/baz
/intel/mock/host8/baz
/intel/mock/host9/baz

_(collect metrics for all instances of the dynamic metric)_ +Metrics requested in task manifest | Collected metrics +--------------------------------------------|------------------------ +/intel/mock/foo | /intel/mock/foo +| +/intel/mock/bar | /intel/mock/bar +| +/intel/mock/\*/baz
_(dynamic metric)_ | /intel/mock/host0/baz
/intel/mock/host1/baz
/intel/mock/host2/baz
/intel/mock/host3/baz
/intel/mock/host4/baz
/intel/mock/host5/baz
/intel/mock/host6/baz
/intel/mock/host7/baz
/intel/mock/host8/baz
/intel/mock/host9/baz

_(collect metrics for all instances of the dynamic metric)_