How can I add an alert with CLI?

[mzp0514]

Describe the issue here.

Relevant URLs

• Provide relevant URLs

What products and version are you using?

[sanderson]

Thanks for the question @mzp0514. The UI for alerts is essentially a GUI for creating two tasks:

• one task that queries data and assigns a _level, then writes it to the _monitoring bucket.
• another task to read data from the _monitoring bucket and, based on the _level assigned to each point, send notifications to an endpoint.

To add a check and alert using the CLI, you'll have to create a custom check: https://docs.influxdata.com/influxdb/cloud/monitor-alert/custom-checks/#example-monitor-failed-tasks

Then create a custom notification task. We don't have this documented yet, but there is an issue for it already: https://github.com/influxdata/docs-v2/issues/1969.

You can then add both as tasks with the CLI: https://docs.influxdata.com/influxdb/cloud/process-data/manage-tasks/create-task/#create-a-task-using-the-influx-cli

Many of the parts and pieces are in the documentation, but we can definitely tie them together better. I propose the following changes to resolve this issue:

• [ ] Complete #1969
• [ ] Add a section to the Create a check documentation explaining how to manually write the task and add it via the CLI.
• [ ] Add a section to the Create a notification rule documentation explaining how to manually write the notification task and add it via the CLI
• [ ] Enhance the current Custom checks documentation to explain the process and include how to send notifications to an endpoint.
• [ ] Cross-reference all of these sections.