This is an automated email from the ASF dual-hosted git repository.
rabbah pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk.git
The following commit(s) were added to refs/heads/master by this push:
new b2f3c7e Updated documentation to reflect the new output from wsk
activation list (#4355)
b2f3c7e is described below
commit b2f3c7ec2df750479ba17c915ae21840fad38291
Author: Lars Andersson <[email protected]>
AuthorDate: Tue Mar 19 22:50:34 2019 +0100
Updated documentation to reflect the new output from wsk activation list
(#4355)
---
docs/actions-nodejs.md | 16 +++++++--------
docs/actions.md | 56 ++++++++++++++++++++++++++++++++++++++++++--------
docs/conductors.md | 26 +++++++++++------------
docs/triggers_rules.md | 12 +++++------
4 files changed, 74 insertions(+), 36 deletions(-)
diff --git a/docs/actions-nodejs.md b/docs/actions-nodejs.md
index df70294..ff6434e 100644
--- a/docs/actions-nodejs.md
+++ b/docs/actions-nodejs.md
@@ -91,19 +91,17 @@ JavaScript functions that run asynchronously may need to
return the activation r
```
wsk activation list --limit 1 asyncAction
```
+<pre>
+Datetime Activation ID Kind Start Duration
Status Entity
+2019-03-16 19:46:43 64581426b44e4b3d981426b44e3b3d19 nodejs:6 cold 2.033s
success guest/asyncAction:0.0.1
+</pre>
```
- activations
- b066ca51e68c4d3382df2d8033265db0 asyncAction
- ```
-
-
- ```
- wsk activation get b066ca51e68c4d3382df2d8033265db0
+ wsk activation get 64581426b44e4b3d981426b44e3b3d19
```
```json
{
- "start": 1455881628103,
- "end": 1455881648126,
+ "start": 1552762003015,
+ "end": 1552762005048,
...
}
```
diff --git a/docs/actions.md b/docs/actions.md
index 4fc1f78..0ea2b55 100644
--- a/docs/actions.md
+++ b/docs/actions.md
@@ -227,8 +227,55 @@ so that one may check for the result later, as with
non-blocking requests
When an action exceeds its configured time limit, the activation record will
indicate this error.
See [understanding the activation
record](#understanding-the-activation-record) for more details.
+### Working with activations
-### Understanding the activation record
+Some common CLI commands for working with activations are:
+- `wsk activation list`: lists all activations
+- `wsk activation get --last`: retrieves the most recent activation record
+- `wsk activation result <activationId>`: retrieves only the result of the
activation (or use `--last` to get the most recent result).
+- `wsk activation logs <activationId>`: retrieves only the logs of the
activation.
+- `wsk activation logs <activationId> --strip`: strips metadata from each log
line so the logs are easier to read.
+
+#### The `wsk activation list` command
+
+The `activation list` command lists all activations, or activations filtered
by namespace or name. The result set can be limited by using several flags:
+
+```
+Flags:
+ -f, --full include full activation description
+ -l, --limit LIMIT only return LIMIT number of activations from the
collection with a maximum LIMIT of 200 activations (default 30)
+ --since SINCE return activations with timestamps later than SINCE;
measured in milliseconds since Th, 01, Jan 1970
+ -s, --skip SKIP exclude the first SKIP number of activations from the
result
+ --upto UPTO return activations with timestamps earlier than UPTO;
measured in milliseconds since Th, 01, Jan 1970
+```
+
+For example, to list the last 6 activations:
+```
+wsk activation list --limit 6
+```
+<pre>
+Datetime Activation ID Kind Start Duration
Status Entity
+2019-03-16 20:03:00 8690bc9904794c9390bc9904794c930e nodejs:6 warm 2ms
success guest/tripleAndIncrement:0.0.1
+2019-03-16 20:02:59 7e76452bec32401db6452bec32001d68 nodejs:6 cold 32ms
success guest/increment:0.0.1
+2019-03-16 20:02:59 097250ad10a24e1eb250ad10a23e1e96 nodejs:6 warm 2ms
success guest/tripleAndIncrement:0.0.1
+2019-03-16 20:02:58 4991a50ed9ed4dc091a50ed9edddc0bb nodejs:6 cold 33ms
success guest/triple:0.0.1
+2019-03-16 20:02:57 aee63124f3504aefa63124f3506aef8b nodejs:6 cold 34ms
success guest/tripleAndIncrement:0.0.1
+2019-03-16 20:02:57 22da217c8e3a4b799a217c8e3a0b79c4 sequence warm 3.46s
success guest/tripleAndIncrement:0.0.1
+</pre>
+
+The meaning of the different columns in the list are:
+
+| Column | Description |
+| :--- | :--- |
+| `Datetime` | The date and time when the invocation occurred. |
+| `Activation ID` | An activation ID that can be used to retrive the result
using the `wsk activation get`, `wsk activation result` and `wsk activation
logs` commands. |
+| `Kind` | The runtime or action type |
+| `Start` | An indication of the latency, i.e. if the runtime container was
cold or warm started. |
+| `Duration` | Time taken to execute the invocation. |
+| `Status` | The outcome of the invocation. For an explanation of the various
statuses, see the description of the `statusCode` below. |
+| `Entity` | The fully qualified name of entity that was invoked. |
+
+#### Understanding the activation record
Each action invocation results in an activation record which contains the
following fields:
@@ -258,13 +305,6 @@ Each action invocation results in an activation record
which contains the follow
- `success`: Is *true* if and only if the status is *"success"*.
- `result`: A dictionary as a JSON object which contains the activation
result. If the activation was successful, this contains the value that is
returned by the action. If the activation was unsuccessful, `result` contains
the `error` key, generally with an explanation of the failure.
-Some common CLI commands for working with activations are:
-- `wsk activation list`: lists all activations
-- `wsk activation get --last`: retrieves the most recent activation record
-- `wsk activation result <activationId>`: retrieves only the result of the
activation (or use `--last` to get the most recent result).
-- `wsk activation logs <activationId>`: retrieves only the logs of the
activation.
-- `wsk activation logs <activationId> --strip`: strips metadata from each log
line so the logs are easier to read.
-
### Creating and updating your own action
Earlier we saved the code from the `greeting` action locally. We can use it to
create our own version of the action
diff --git a/docs/conductors.md b/docs/conductors.md
index 490d188..9b4a1cb 100644
--- a/docs/conductors.md
+++ b/docs/conductors.md
@@ -102,25 +102,25 @@ Blocking and non-blocking invocations are supported. As
usual, a blocking invoca
One invocation of the conductor action results in multiple activations, for
instance:
```
-wsk action invoke quadruple -p value 3
+wsk action invoke tripleAndIncrement -p value 3
```
```
-ok: invoked /_/quadruple with id 4f91f9ed0d874aaa91f9ed0d87baaa07
+ok: invoked /_/tripleAndIncrement with id 4f91f9ed0d874aaa91f9ed0d87baaa07
```
```
wsk activation list
```
-```
-activations
-fd89b99a90a1462a89b99a90a1d62a8e tripleAndIncrement
-eaec119273d94087ac119273d90087d0 increment
-3624ad829d4044afa4ad829d40e4af60 tripleAndIncrement
-a1f58ade9b1e4c26b58ade9b1e4c2614 triple
-3624ad829d4044afa4ad829d40e4af60 tripleAndIncrement
-4f91f9ed0d874aaa91f9ed0d87baaa07 tripleAndIncrement
-```
-
-There are six activation records in this example, one matching the activation
id returned on invocation (`4f91f9ed0d874aaa91f9ed0d87baaa07`) plus five
additional records for activations _caused_ by this invocation. The _primary_
activation record is the last one in the list because it has the earliest start
time.
+<pre>
+Datetime Activation ID Kind Start Duration
Status Entity
+2019-03-16 20:03:00 8690bc9904794c9390bc9904794c930e nodejs:6 warm 2ms
success guest/tripleAndIncrement:0.0.1
+2019-03-16 20:02:59 7e76452bec32401db6452bec32001d68 nodejs:6 cold 32ms
success guest/increment:0.0.1
+2019-03-16 20:02:59 097250ad10a24e1eb250ad10a23e1e96 nodejs:6 warm 2ms
success guest/tripleAndIncrement:0.0.1
+2019-03-16 20:02:58 4991a50ed9ed4dc091a50ed9edddc0bb nodejs:6 cold 33ms
success guest/triple:0.0.1
+2019-03-16 20:02:57 aee63124f3504aefa63124f3506aef8b nodejs:6 cold 34ms
success guest/tripleAndIncrement:0.0.1
+2019-03-16 20:02:57 22da217c8e3a4b799a217c8e3a0b79c4 sequence warm 3.46s
success guest/tripleAndIncrement:0.0.1
+</pre>
+
+There are six activation records in this example, one matching the activation
id returned on invocation (`22da217c8e3a4b799a217c8e3a0b79c4`) plus five
additional records for activations _caused_ by this invocation. The _primary_
activation record is the last one in the list because it has the earliest start
time.
The five additional activations are:
diff --git a/docs/triggers_rules.md b/docs/triggers_rules.md
index 295d2be..70ab660 100644
--- a/docs/triggers_rules.md
+++ b/docs/triggers_rules.md
@@ -138,7 +138,7 @@ As an example, create a rule that calls the hello action
whenever a location upd
```
```
- ok: triggered locationUpdate with id d5583d8e2d754b518a9fe6914e6ffb1e
+ ok: triggered locationUpdate with id 878998285cad448b8998285cad948b30
```
5. Verify that the action was invoked by checking the most recent activation.
@@ -146,13 +146,13 @@ As an example, create a rule that calls the hello action
whenever a location upd
$ wsk activation list --limit 1 hello
```
- ```
- activations
- 9c98a083b924426d8b26b5f41c5ebc0d hello
- ```
+<pre>
+Datetime Activation ID Kind Start Duration
Status Entity
+2019-02-18 11:51:41 0efe54d8fb96486bbe54d8fb96d86bbe nodejs:6 cold 54ms
success guest/hello:0.0.1
+</pre>
```
- $ wsk activation result 9c98a083b924426d8b26b5f41c5ebc0d
+ $ wsk activation result 0efe54d8fb96486bbe54d8fb96d86bbe
```
```
{
