updated task management docs to address PR feedback
parent
139364f570
commit
2fd9481852
|
@ -135,6 +135,7 @@
|
|||
&:not(:last-child) {
|
||||
> p:only-child{ margin-bottom: 0; }
|
||||
}
|
||||
ul,ol { margin: -.5rem 0 1rem;}
|
||||
}
|
||||
|
||||
//////////////////////////////////// Code ////////////////////////////////////
|
||||
|
|
|
@ -14,11 +14,13 @@ v2.0/tags: [tasks]
|
|||
Process and analyze your data with tasks in the InfluxDB **task engine**. Use tasks (scheduled Flux queries)
|
||||
to input a data stream and then analyze, modify, and act on the data accordingly.
|
||||
|
||||
Discover how to configure and build tasks using the InfluxDB user interface (UI) and the `influx` command line interface (CLI).
|
||||
Find examples of data downsampling, anomaly detection _(Coming)_, alerting _(Coming)_, and other common tasks.
|
||||
Discover how to create and manage tasks using the InfluxDB user interface (UI)
|
||||
and the `influx` command line interface (CLI).
|
||||
Find examples of data downsampling, anomaly detection _(Coming)_, alerting
|
||||
_(Coming)_, and other common tasks.
|
||||
|
||||
{{% note %}}
|
||||
Tasks replace InfluxDB v1.x's continuous queries.
|
||||
Tasks replace InfluxDB v1.x continuous queries.
|
||||
{{% /note %}}
|
||||
|
||||
{{< children >}}
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
title: Get started with InfluxDB tasks
|
||||
list_title: Get started with tasks
|
||||
description: >
|
||||
Learn the basics of writing an InfluxDB task that processes data and then performs an action
|
||||
Learn the basics of writing an InfluxDB task that processes data, and then performs an action,
|
||||
such as storing the modified data in a new bucket or sending an alert.
|
||||
aliases:
|
||||
- /v2.0/process-data/write-a-task/
|
||||
|
|
|
@ -3,8 +3,8 @@ title: Manage tasks in InfluxDB
|
|||
seotitle: Manage data processing tasks in InfluxDB
|
||||
list_title: Manage tasks
|
||||
description: >
|
||||
InfluxDB provides options for managing the creation, reading, updating, and deletion
|
||||
of tasks using both the `influx` CLI and the InfluxDB UI.
|
||||
InfluxDB provides options for creating, reading, updating, and deleting tasks
|
||||
using both the `influx` CLI and the InfluxDB UI.
|
||||
v2.0/tags: [tasks]
|
||||
menu:
|
||||
v2_0:
|
||||
|
|
|
@ -14,7 +14,10 @@ weight: 201
|
|||
InfluxDB provides multiple ways to create tasks both in the InfluxDB user interface (UI)
|
||||
and the `influx` command line interface (CLI).
|
||||
|
||||
_This article assumes you have already [written a task](/v2.0/process-data/get-started)._
|
||||
_Before creating a task, review the [basics criteria for writing a task](/v2.0/process-data/get-started)._
|
||||
|
||||
- [InfluxDB UI](#create-a-task-in-the-influxdb-ui)
|
||||
- [`influx` CLI](#create-a-task-using-the-influx-cli)
|
||||
|
||||
## Create a task in the InfluxDB UI
|
||||
The InfluxDB UI provides multiple ways to create a task:
|
||||
|
@ -46,7 +49,7 @@ The InfluxDB UI provides multiple ways to create a task:
|
|||
2. Click **{{< icon "plus" >}} Create Task** in the upper right.
|
||||
3. Select **New Task**.
|
||||
4. In the left panel, specify the task options.
|
||||
See [Task options](/v2.0/process-data/task-options)for detailed information about each option.
|
||||
See [Task options](/v2.0/process-data/task-options) for detailed information about each option.
|
||||
5. In the right panel, enter your task script.
|
||||
6. Click **Save** in the upper right.
|
||||
|
||||
|
@ -59,9 +62,10 @@ The InfluxDB UI provides multiple ways to create a task:
|
|||
|
||||
2. Click **+ Create Task** in the upper right.
|
||||
3. Select **Import Task**.
|
||||
4. Upload a JSON task file by either dragging and dropping it in the specified area
|
||||
or click the area to select a file to upload. Select the **JSON** option to paste
|
||||
in raw task JSON.
|
||||
4. Upload a JSON task file using one of the following options:
|
||||
- Drag and drop a JSON task file in the specified area.
|
||||
- Click to upload and the area to select the JSON task from from your file manager.
|
||||
- Select the **JSON** option and paste in raw task JSON.
|
||||
5. Click **Import JSON as Task**.
|
||||
|
||||
### Create a task from a template
|
||||
|
@ -78,7 +82,7 @@ The InfluxDB UI provides multiple ways to create a task:
|
|||
|
||||
{{< nav-icon "tasks" >}}
|
||||
|
||||
2. Hover over the task you would like to clone and click the **{{< icon "duplicate" >}}** that appears.
|
||||
2. Hover over the task you would like to clone and click the **{{< icon "duplicate" >}}** icon that appears.
|
||||
4. Click **Clone**.
|
||||
|
||||
## Create a task using the influx CLI
|
||||
|
|
|
@ -20,7 +20,7 @@ Tasks are exported as downloadable JSON files.
|
|||
2. In the list of tasks, hover over the task you would like to export and click
|
||||
the **{{< icon "gear" >}}** icon that appears.
|
||||
3. Select **Export**.
|
||||
4. There are multiple options for downloading or saving the task export file:
|
||||
4. Downloading or save the task export file using one of the following options:
|
||||
- Click **Download JSON** to download the exported JSON file.
|
||||
- Click **Save as template** to save the export file as a task template.
|
||||
- Click **Copy to Clipboard** to copy the raw JSON content to your machine's clipboard.
|
||||
|
|
|
@ -17,7 +17,7 @@ To view your tasks, click the **Tasks** icon in the left navigation menu.
|
|||
{{< nav-icon "tasks" >}}
|
||||
|
||||
#### Update a task's Flux script
|
||||
1. In the list of tasks, click the **Name** of the task you would like to update.
|
||||
1. In the list of tasks, click the **Name** of the task you want to update.
|
||||
2. In the left panel, modify the task options.
|
||||
3. In the right panel, modify the task script.
|
||||
4. Click **Save** in the upper right.
|
||||
|
@ -26,8 +26,7 @@ To view your tasks, click the **Tasks** icon in the left navigation menu.
|
|||
|
||||
#### Update the status of a task
|
||||
In the list of tasks, click the {{< icon "toggle" >}} toggle to the left of the
|
||||
task you would like to activate or inactivate.
|
||||
|
||||
task you want to activate or inactivate.
|
||||
|
||||
## Update a task with the influx CLI
|
||||
Use the `influx task update` command to update or change the status of an existing task.
|
||||
|
@ -36,7 +35,7 @@ _This command requires a task ID, which is available in the output of `influx ta
|
|||
|
||||
#### Update a task's Flux script
|
||||
Pass the file path of your updated Flux script to the `influx task update` command
|
||||
with the ID of the task you would like to update.
|
||||
with the ID of the task you want to update.
|
||||
Modified [task options](/v2.0/process-data/task-options) defined in the Flux
|
||||
script are also updated.
|
||||
|
||||
|
@ -49,7 +48,7 @@ influx task update -i 0343698431c35000 @/tasks/cq-mean-1h.flux
|
|||
```
|
||||
|
||||
#### Update the status of a task
|
||||
Pass the ID of the task you would like to update to the `influx task update`
|
||||
Pass the ID of the task you want to update to the `influx task update`
|
||||
command with the `--status` flag.
|
||||
|
||||
_Possible arguments of the `--status` flag are `active` or `inactive`._
|
||||
|
|
Loading…
Reference in New Issue