Merge pull request #198 from influxdata/alpha-9-task-workflow
Updated task workflow docspull/206/head
commit
47f33f19a1
|
@ -21,6 +21,28 @@
|
||||||
padding-left: .28rem;
|
padding-left: .28rem;
|
||||||
line-height: 1.25rem;
|
line-height: 1.25rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
&.ui-toggle {
|
||||||
|
display: inline-block;
|
||||||
|
position: relative;
|
||||||
|
width: 34px;
|
||||||
|
height: 22px;
|
||||||
|
background: #1C1C21;
|
||||||
|
border: 2px solid #383846;
|
||||||
|
border-radius: .7rem;
|
||||||
|
vertical-align: text-bottom;
|
||||||
|
|
||||||
|
.circle {
|
||||||
|
display: inline-block;
|
||||||
|
position: absolute;
|
||||||
|
border-radius: 50%;
|
||||||
|
height: 12px;
|
||||||
|
width: 12px;
|
||||||
|
background: #22ADF6;
|
||||||
|
top: 3px;
|
||||||
|
right: 3px;
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.nav-icon {
|
.nav-icon {
|
||||||
|
|
|
@ -135,6 +135,7 @@
|
||||||
&:not(:last-child) {
|
&:not(:last-child) {
|
||||||
> p:only-child{ margin-bottom: 0; }
|
> p:only-child{ margin-bottom: 0; }
|
||||||
}
|
}
|
||||||
|
ul,ol { margin: -.5rem 0 1rem;}
|
||||||
}
|
}
|
||||||
|
|
||||||
//////////////////////////////////// Code ////////////////////////////////////
|
//////////////////////////////////// Code ////////////////////////////////////
|
||||||
|
|
|
@ -11,14 +11,16 @@ weight: 5
|
||||||
v2.0/tags: [tasks]
|
v2.0/tags: [tasks]
|
||||||
---
|
---
|
||||||
|
|
||||||
Process and analyze your data with tasks in the InfluxDB _**task engine**. Use tasks (scheduled Flux queries)
|
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.
|
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).
|
Discover how to create and manage tasks using the InfluxDB user interface (UI)
|
||||||
Find examples of data downsampling, anomaly detection_(Coming)_, alerting _(Coming)_, and other common tasks.
|
and the `influx` command line interface (CLI).
|
||||||
|
Find examples of data downsampling, anomaly detection _(Coming)_, alerting
|
||||||
|
_(Coming)_, and other common tasks.
|
||||||
|
|
||||||
{{% note %}}
|
{{% note %}}
|
||||||
Tasks replace InfluxDB v1.x's continuous queries.
|
Tasks replace InfluxDB v1.x continuous queries.
|
||||||
{{% /note %}}
|
{{% /note %}}
|
||||||
|
|
||||||
{{< children >}}
|
{{< children >}}
|
||||||
|
|
|
@ -1,13 +1,15 @@
|
||||||
---
|
---
|
||||||
title: Write an InfluxDB task
|
title: Get started with InfluxDB tasks
|
||||||
seotitle: Write an InfluxDB task that processes data
|
list_title: Get started with tasks
|
||||||
description: >
|
description: >
|
||||||
How to write an InfluxDB task that processes data in some way, 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.
|
such as storing the modified data in a new bucket or sending an alert.
|
||||||
|
aliases:
|
||||||
|
- /v2.0/process-data/write-a-task/
|
||||||
v2.0/tags: [tasks]
|
v2.0/tags: [tasks]
|
||||||
menu:
|
menu:
|
||||||
v2_0:
|
v2_0:
|
||||||
name: Write a task
|
name: Get started with tasks
|
||||||
parent: Process data
|
parent: Process data
|
||||||
weight: 101
|
weight: 101
|
||||||
---
|
---
|
|
@ -1,9 +1,10 @@
|
||||||
---
|
---
|
||||||
title: Manage tasks in InfluxDB
|
title: Manage tasks in InfluxDB
|
||||||
seotitle: Manage data processing tasks in InfluxDB
|
seotitle: Manage data processing tasks in InfluxDB
|
||||||
|
list_title: Manage tasks
|
||||||
description: >
|
description: >
|
||||||
InfluxDB provides options for managing the creation, reading, updating, and deletion
|
InfluxDB provides options for creating, reading, updating, and deleting tasks
|
||||||
of tasks using both the 'influx' CLI and the InfluxDB UI.
|
using both the `influx` CLI and the InfluxDB UI.
|
||||||
v2.0/tags: [tasks]
|
v2.0/tags: [tasks]
|
||||||
menu:
|
menu:
|
||||||
v2_0:
|
v2_0:
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: Create a task
|
||||||
seotitle: Create a task for processing data in InfluxDB
|
seotitle: Create a task for processing data in InfluxDB
|
||||||
description: >
|
description: >
|
||||||
How to create a task that processes data in InfluxDB using the InfluxDB user
|
How to create a task that processes data in InfluxDB using the InfluxDB user
|
||||||
interface or the 'influx' command line interface.
|
interface or the `influx` command line interface.
|
||||||
menu:
|
menu:
|
||||||
v2_0:
|
v2_0:
|
||||||
name: Create a task
|
name: Create a task
|
||||||
|
@ -14,7 +14,10 @@ weight: 201
|
||||||
InfluxDB provides multiple ways to create tasks both in the InfluxDB user interface (UI)
|
InfluxDB provides multiple ways to create tasks both in the InfluxDB user interface (UI)
|
||||||
and the `influx` command line interface (CLI).
|
and the `influx` command line interface (CLI).
|
||||||
|
|
||||||
_This article assumes you have already [written a task](/v2.0/process-data/write-a-task)._
|
_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
|
## Create a task in the InfluxDB UI
|
||||||
The InfluxDB UI provides multiple ways to create a task:
|
The InfluxDB UI provides multiple ways to create a task:
|
||||||
|
@ -22,6 +25,8 @@ The InfluxDB UI provides multiple ways to create a task:
|
||||||
- [Create a task from the Data Explorer](#create-a-task-from-the-data-explorer)
|
- [Create a task from the Data Explorer](#create-a-task-from-the-data-explorer)
|
||||||
- [Create a task in the Task UI](#create-a-task-in-the-task-ui)
|
- [Create a task in the Task UI](#create-a-task-in-the-task-ui)
|
||||||
- [Import a task](#import-a-task)
|
- [Import a task](#import-a-task)
|
||||||
|
- [Create a task from a template](#create-a-task-from-a-template)
|
||||||
|
- [Clone a task](#clone-a-task)
|
||||||
|
|
||||||
### Create a task from the Data Explorer
|
### Create a task from the Data Explorer
|
||||||
1. Click on the **Data Explorer** icon in the left navigation menu.
|
1. Click on the **Data Explorer** icon in the left navigation menu.
|
||||||
|
@ -41,11 +46,12 @@ The InfluxDB UI provides multiple ways to create a task:
|
||||||
|
|
||||||
{{< nav-icon "tasks" >}}
|
{{< nav-icon "tasks" >}}
|
||||||
|
|
||||||
2. Click **+ Create Task** in the upper right.
|
2. Click **{{< icon "plus" >}} Create Task** in the upper right.
|
||||||
3. In the left panel, specify the task options.
|
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.
|
||||||
4. In the right panel, enter your task script.
|
5. In the right panel, enter your task script.
|
||||||
5. Click **Save** in the upper right.
|
6. Click **Save** in the upper right.
|
||||||
|
|
||||||
{{< img-hd src="/img/2-0-tasks-create-edit.png" title="Create a task" />}}
|
{{< img-hd src="/img/2-0-tasks-create-edit.png" title="Create a task" />}}
|
||||||
|
|
||||||
|
@ -56,15 +62,27 @@ The InfluxDB UI provides multiple ways to create a task:
|
||||||
|
|
||||||
2. Click **+ Create Task** in the upper right.
|
2. Click **+ Create Task** in the upper right.
|
||||||
3. Select **Import Task**.
|
3. Select **Import Task**.
|
||||||
3. Drag and drop or select a file to upload.
|
4. Upload a JSON task file using one of the following options:
|
||||||
4. Click **Import JSON as Task**.
|
- 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
|
||||||
|
1. Click on the **Settings** icon in the left navigation menu.
|
||||||
|
|
||||||
|
{{< nav-icon "Settings" >}}
|
||||||
|
|
||||||
|
2. Select **Templates**.
|
||||||
|
3. Hover over the template to use to create the task and click **Create**.
|
||||||
|
|
||||||
|
|
||||||
### Clone a task
|
### Clone a task
|
||||||
1. Click on the **Tasks** icon in the left navigation menu.
|
1. Click on the **Tasks** icon in the left navigation menu.
|
||||||
|
|
||||||
{{< nav-icon "tasks" >}}
|
{{< 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**.
|
4. Click **Clone**.
|
||||||
|
|
||||||
## Create a task using the influx CLI
|
## Create a task using the influx CLI
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: Delete a task
|
||||||
seotitle: Delete a task for processing data in InfluxDB
|
seotitle: Delete a task for processing data in InfluxDB
|
||||||
description: >
|
description: >
|
||||||
How to delete a task in InfluxDB using the InfluxDB user interface or using
|
How to delete a task in InfluxDB using the InfluxDB user interface or using
|
||||||
the 'influx' command line interface.
|
the `influx` command line interface.
|
||||||
menu:
|
menu:
|
||||||
v2_0:
|
v2_0:
|
||||||
name: Delete a task
|
name: Delete a task
|
||||||
|
|
|
@ -18,9 +18,9 @@ Tasks are exported as downloadable JSON files.
|
||||||
{{< nav-icon "tasks" >}}
|
{{< nav-icon "tasks" >}}
|
||||||
|
|
||||||
2. In the list of tasks, hover over the task you would like to export and click
|
2. In the list of tasks, hover over the task you would like to export and click
|
||||||
the **{{< icon "gear" >}}** that appears.
|
the **{{< icon "gear" >}}** icon that appears.
|
||||||
3. Select **Export**.
|
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 **Download JSON** to download the exported JSON file.
|
||||||
- Click **Save as template** to save the export file as a task template.
|
- 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.
|
- Click **Copy to Clipboard** to copy the raw JSON content to your machine's clipboard.
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: Update a task
|
||||||
seotitle: Update a task for processing data in InfluxDB
|
seotitle: Update a task for processing data in InfluxDB
|
||||||
description: >
|
description: >
|
||||||
How to update a task that processes data in InfluxDB using the InfluxDB user
|
How to update a task that processes data in InfluxDB using the InfluxDB user
|
||||||
interface or the 'influx' command line interface.
|
interface or the `influx` command line interface.
|
||||||
menu:
|
menu:
|
||||||
v2_0:
|
v2_0:
|
||||||
name: Update a task
|
name: Update a task
|
||||||
|
@ -17,7 +17,7 @@ To view your tasks, click the **Tasks** icon in the left navigation menu.
|
||||||
{{< nav-icon "tasks" >}}
|
{{< nav-icon "tasks" >}}
|
||||||
|
|
||||||
#### Update a task's Flux script
|
#### 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.
|
2. In the left panel, modify the task options.
|
||||||
3. In the right panel, modify the task script.
|
3. In the right panel, modify the task script.
|
||||||
4. Click **Save** in the upper right.
|
4. Click **Save** in the upper right.
|
||||||
|
@ -25,9 +25,8 @@ To view your tasks, click the **Tasks** icon in the left navigation menu.
|
||||||
{{< img-hd src="/img/2-0-tasks-create-edit.png" alt="Update a task" />}}
|
{{< img-hd src="/img/2-0-tasks-create-edit.png" alt="Update a task" />}}
|
||||||
|
|
||||||
#### Update the status of a task
|
#### Update the status of a task
|
||||||
In the list of tasks, click the toggle in the **Active** column of the task you
|
In the list of tasks, click the {{< icon "toggle" >}} toggle to the left of the
|
||||||
would like to activate or inactivate.
|
task you want to activate or inactivate.
|
||||||
|
|
||||||
|
|
||||||
## Update a task with the influx CLI
|
## Update a task with the influx CLI
|
||||||
Use the `influx task update` command to update or change the status of an existing task.
|
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
|
#### Update a task's Flux script
|
||||||
Pass the file path of your updated Flux script to the `influx task update` command
|
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
|
Modified [task options](/v2.0/process-data/task-options) defined in the Flux
|
||||||
script are also updated.
|
script are also updated.
|
||||||
|
|
||||||
|
@ -49,7 +48,7 @@ influx task update -i 0343698431c35000 @/tasks/cq-mean-1h.flux
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Update the status of a task
|
#### 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.
|
command with the `--status` flag.
|
||||||
|
|
||||||
_Possible arguments of the `--status` flag are `active` or `inactive`._
|
_Possible arguments of the `--status` flag are `active` or `inactive`._
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: View tasks
|
||||||
seotitle: View created tasks that process data in InfluxDB
|
seotitle: View created tasks that process data in InfluxDB
|
||||||
description: >
|
description: >
|
||||||
How to view all created data processing tasks using the InfluxDB user interface
|
How to view all created data processing tasks using the InfluxDB user interface
|
||||||
or the 'influx' command line interface.
|
or the `influx` command line interface.
|
||||||
menu:
|
menu:
|
||||||
v2_0:
|
v2_0:
|
||||||
name: View tasks
|
name: View tasks
|
||||||
|
@ -18,10 +18,10 @@ Click the **Tasks** icon in the left navigation to view the lists of tasks.
|
||||||
|
|
||||||
### Filter the list of tasks
|
### Filter the list of tasks
|
||||||
|
|
||||||
1. Enable the **Show Inactive** option to include inactive tasks in the list.
|
1. Click the **Show Inactive** {{< icon "toggle" >}} toggle to include or exclude
|
||||||
2. Enter text in the **Filter tasks by name** field to search for tasks by name.
|
inactive tasks in the list.
|
||||||
3. Select an organization from the **All Organizations** dropdown to filter the list by organization.
|
2. Enter text in the **Filter tasks** field to search for tasks by name or label.
|
||||||
4. Click on the heading of any column to sort by that field.
|
3. Click on the heading of any column to sort by that field.
|
||||||
|
|
||||||
## View tasks with the influx CLI
|
## View tasks with the influx CLI
|
||||||
Use the `influx task find` command to return a list of created tasks.
|
Use the `influx task find` command to return a list of created tasks.
|
||||||
|
|
|
@ -56,4 +56,6 @@
|
||||||
<span class="inline icon-ui-chat large"></span>
|
<span class="inline icon-ui-chat large"></span>
|
||||||
{{ else if eq $icon "add-label" }}
|
{{ else if eq $icon "add-label" }}
|
||||||
<span class="inline add-btn-round"></span>
|
<span class="inline add-btn-round"></span>
|
||||||
|
{{ else if eq $icon "toggle" }}
|
||||||
|
<span class="inline ui-toggle"><span class="circle"></span></span>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
Loading…
Reference in New Issue