task run documentation

pull/106/head
Scott Anderson 2019-03-26 11:44:44 -06:00
parent 62611632b5
commit 7c1f933ade
7 changed files with 102 additions and 15 deletions

View File

@ -2,8 +2,8 @@
title: Create a task
seotitle: Create a task for processing data in InfluxDB
description: >
How to create a task that processes data in InfluxDB using the InfluxDB user
interface or the 'influx' command line interface.
Create a data processing task in InfluxDB using the InfluxDB user interface or
the `influx` command line interface.
menu:
v2_0:
name: Create a task
@ -41,7 +41,7 @@ The InfluxDB UI provides multiple ways to create a task:
{{< nav-icon "tasks" >}}
2. Click **+ Create Task** in the upper right.
2. Click **+ Create Task** in the upper right and select **New Task**.
3. In the left panel, specify the task options.
See [Task options](/v2.0/process-data/task-options)for detailed information about each option.
4. In the right panel, enter your task script.
@ -54,8 +54,7 @@ The InfluxDB UI provides multiple ways to create a task:
{{< nav-icon "tasks" >}}
2. Click **+ Create Task** in the upper right.
3. Select **Import Task**.
2. Click **+ Create Task** in the upper right and select **Import Task**.
3. Drag and drop or select a file to upload.
4. Click **Import JSON as Task**.

View File

@ -2,13 +2,13 @@
title: Delete a task
seotitle: Delete a task for processing data in InfluxDB
description: >
How to delete a task in InfluxDB using the InfluxDB user interface or using
the 'influx' command line interface.
Delete a task from InfluxDB using the InfluxDB user interface or using the
`influx` command line interface.
menu:
v2_0:
name: Delete a task
parent: Manage tasks
weight: 205
weight: 206
---
## Delete a task in the InfluxDB UI

View File

@ -1,12 +1,12 @@
---
title: Export a task
seotitle: Export an InfluxDB task
description: How to export a data processing task from InfluxDB using the InfluxDB user interface.
description: Export a data processing task from InfluxDB using the InfluxDB user interface.
menu:
v2_0:
name: Export a task
parent: Manage tasks
weight: 204
weight: 205
---
InfluxDB allows you to export tasks from the InfluxDB user interface (UI).

View File

@ -0,0 +1,42 @@
---
title: Run a task
seotitle: Run an InfluxDB task
description: >
Run a data processing task using the InfluxDB user interface or the `influx`
command line interface.
menu:
v2_0:
name: Run a task
parent: Manage tasks
weight: 203
---
InfluxDB data processing tasks generally run in defined intervals or at a specific time,
however you can manually run a task from the InfluxDB user interface (UI) or with
the `influx` command line interface (CLI).
## Run a task from the InfluxDB UI
1. Click the **Tasks** icon in the left navigation to view the lists of tasks.
{{< nav-icon "tasks" >}}
2. Hover over the task you would like to run and click the **{{< icon "gear" >}}** icon.
3. Select **Run Task**.
## Run a task with the influx CLI
Use the `influx task run retry` command to run a task.
{{% note %}}
To run a task from the `influx` CLI, the task must have already run at least once.
{{% /note %}}
```sh
# List all tasks to find the ID of the task to run
influx task find
# Use the task ID to list all the previous runs of the task
influx task run find --task-id=0000000000000000
# Use the task ID and run ID to retry a run
influx task run retry --task-id=0000000000000000 --run-id=0000000000000000
```

View File

@ -0,0 +1,46 @@
---
title: View task run history and logs
description: >
View task run histories and logs using the InfluxDB user interface or the
`influx` command line interface.
menu:
v2_0:
name: View run history
parent: Manage tasks
weight: 203
---
Each time an InfluxDB task runs, it creates a "run" record in the task's run history.
Logs associated with each run provide relevant timestamps, messages,
and the final state of the run attempt.
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
to view task run histories and associated logs.
## View a task's run history in the InfluxDB UI
1. Click the **Tasks** icon in the left navigation to view the lists of tasks.
{{< nav-icon "tasks" >}}
2. Hover over the task you would like to run and click the **{{< icon "gear" >}}** icon.
3. Select **View Task Runs**.
### View task run logs
To view logs associated with a run, click **View Logs** next to the run in the task's run history.
## View a task's run history with the influx CLI
Use the `influx task run find` command to view a task's run history.
```sh
# List all tasks to find the ID of the task to run
influx task find
# Use the task ID to view the run history of a task
influx task run find --task-id=0000000000000000
```
{{% note %}}
Detailed run logs are not currently available in the `influx` CLI.
{{% /note %}}

View File

@ -2,13 +2,13 @@
title: Update a task
seotitle: Update a task for processing data in InfluxDB
description: >
How to update a task that processes data in InfluxDB using the InfluxDB user
interface or the 'influx' command line interface.
Update a data processing task in InfluxDB using the InfluxDB user interface or
the `influx` command line interface.
menu:
v2_0:
name: Update a task
parent: Manage tasks
weight: 203
weight: 204
---
## Update a task in the InfluxDB UI

View File

@ -2,8 +2,8 @@
title: View tasks
seotitle: View created tasks that process data in InfluxDB
description: >
How to view all created data processing tasks using the InfluxDB user interface
or the 'influx' command line interface.
View existing data processing tasks using the InfluxDB user interface or the
`influx` command line interface.
menu:
v2_0:
name: View tasks