slack¶
Send the experiment report in a message to a Slack channel using a incoming webhook.
Usage Example¶
iter8 launch \
--set "tasks={http,assess,slack}" \
--set http.url=http://127.0.0.1/get \
--set assess.SLOs.upper.http/latency-mean=50 \
--set assess.SLOs.upper.http/error-count=0 \
--set slack.url=<Slack webhook> \
--set slack.method=POST \
--set runner=job
See here for a more in-depth tutorial.
Parameters¶
Name | Type | Required | Default value | Description |
---|---|---|---|---|
url | string | Yes | N/A | URL to the Slack webhook |
payloadTemplateURL | string | No | https://raw.githubusercontent.com/iter8-tools/hub/iter8-0.12.2/templates/notify/_payload-slack.tpl | URL to a payload template |
softFailure | bool | No | true | Indicates the task and experiment should not fail if the task cannot successfully send the request |
if | string | No | N/A | An if condition that can be control when the task is run in a multi-looped experiment. To learn more, see here. |
Default payload¶
The payload will determine what will be contained in the Slack message. The default payload templae of the slack
task is to send the experiment report in text form.
However, if you would like to use a different payload template, simply set a payloadTemplateURL
and Iter8 will not use the default.
if
parameter¶
The if
parameter is used to control when the task is run in a multi-looped experiment. For example, if you would like for the slack
task to run only at the 10th loop instead of every loop, you can do the following:
iter8 launch \
--set "tasks={http,assess,slack}" \
--set http.url=http://127.0.0.1/get \
--set assess.SLOs.upper.http/latency-mean=50 \
--set assess.SLOs.upper.http/error-count=0 \
--set slack.url=<Slack webhook> \
--set slack.method=POST \
+ --set github.if="Result.NumLoops == 10"
--set runner=job
You may use any field in the Result
object for your logic.