influxdata / docs.influxdata.com-ARCHIVE

ARCHIVE - 1.x docs for InfluxData
https://archive.docs.influxdata.com/
MIT License
253 stars 295 forks source link

Specify in documentation that patch doesn't update the running task. It needs to be disabled and enabled. #1453

Closed EspenAlbert closed 6 years ago

EspenAlbert commented 6 years ago
URL for relevant page?

https://docs.influxdata.com/kapacitor/v1.4/working/api/#tasks

What products and version are you using?

Kapacitor 1.4

Where did you look before opening the issue?

In the docs and in the github issues.

Proposal

Add sentence: When patching a task no changes are made to the running task. The task needs to be disabled and enabled for the changes to take effect. image

Background

I am working on a smarthouse project where we use kapacitor to trigger certain rules from the sensor data. When updating these rules changes are shown when executing kapacitor list {taskname} but no changes occur to the running task until you disable and enable the running task (explained in issue 1195). This behaviour can be confusing and should be made explicit.

Evidence on the confusion can be seen by the numerous github issues: https://github.com/influxdata/kapacitor/issues/1195 https://github.com/influxdata/kapacitor/issues/1525 https://github.com/influxdata/kapacitor/issues/1510

stevebang commented 6 years ago

Thanks, @EspenAlbert, for taking the time to explain the common confusion about the PATCH method behavior when redefining tasks. Changes have also been made here: https://github.com/influxdata/kapacitor/pull/1864.

Fix is in master, and awaiting a new build.