From 7c1f933adef9a047b543db7eaedefc6903b91377 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Tue, 26 Mar 2019 11:44:44 -0600 Subject: [PATCH 1/2] task run documentation --- .../process-data/manage-tasks/create-task.md | 9 ++-- .../process-data/manage-tasks/delete-task.md | 6 +-- .../process-data/manage-tasks/export-task.md | 4 +- .../process-data/manage-tasks/run-task.md | 42 +++++++++++++++++ .../manage-tasks/task-run-history.md | 46 +++++++++++++++++++ .../process-data/manage-tasks/update-task.md | 6 +-- .../process-data/manage-tasks/view-tasks.md | 4 +- 7 files changed, 102 insertions(+), 15 deletions(-) create mode 100644 content/v2.0/process-data/manage-tasks/run-task.md create mode 100644 content/v2.0/process-data/manage-tasks/task-run-history.md diff --git a/content/v2.0/process-data/manage-tasks/create-task.md b/content/v2.0/process-data/manage-tasks/create-task.md index 13944a48f..d6b351a9c 100644 --- a/content/v2.0/process-data/manage-tasks/create-task.md +++ b/content/v2.0/process-data/manage-tasks/create-task.md @@ -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**. diff --git a/content/v2.0/process-data/manage-tasks/delete-task.md b/content/v2.0/process-data/manage-tasks/delete-task.md index 8343a727d..c4850c8b8 100644 --- a/content/v2.0/process-data/manage-tasks/delete-task.md +++ b/content/v2.0/process-data/manage-tasks/delete-task.md @@ -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 diff --git a/content/v2.0/process-data/manage-tasks/export-task.md b/content/v2.0/process-data/manage-tasks/export-task.md index 0c222ba83..604077dd3 100644 --- a/content/v2.0/process-data/manage-tasks/export-task.md +++ b/content/v2.0/process-data/manage-tasks/export-task.md @@ -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). diff --git a/content/v2.0/process-data/manage-tasks/run-task.md b/content/v2.0/process-data/manage-tasks/run-task.md new file mode 100644 index 000000000..fb10b7fbf --- /dev/null +++ b/content/v2.0/process-data/manage-tasks/run-task.md @@ -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 +``` diff --git a/content/v2.0/process-data/manage-tasks/task-run-history.md b/content/v2.0/process-data/manage-tasks/task-run-history.md new file mode 100644 index 000000000..1e67bbc53 --- /dev/null +++ b/content/v2.0/process-data/manage-tasks/task-run-history.md @@ -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 %}} diff --git a/content/v2.0/process-data/manage-tasks/update-task.md b/content/v2.0/process-data/manage-tasks/update-task.md index 4005ee51f..2d9c975a5 100644 --- a/content/v2.0/process-data/manage-tasks/update-task.md +++ b/content/v2.0/process-data/manage-tasks/update-task.md @@ -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 diff --git a/content/v2.0/process-data/manage-tasks/view-tasks.md b/content/v2.0/process-data/manage-tasks/view-tasks.md index db55b6a94..30ab0be77 100644 --- a/content/v2.0/process-data/manage-tasks/view-tasks.md +++ b/content/v2.0/process-data/manage-tasks/view-tasks.md @@ -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 From 823fa2e11870375a958e469f7e6e7e91c121f224 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Tue, 26 Mar 2019 13:29:16 -0600 Subject: [PATCH 2/2] changes to task docs based on PR feedback --- .../v2.0/process-data/manage-tasks/create-task.md | 3 +-- .../v2.0/process-data/manage-tasks/delete-task.md | 3 +-- .../v2.0/process-data/manage-tasks/export-task.md | 4 ++-- content/v2.0/process-data/manage-tasks/run-task.md | 11 +++++------ .../process-data/manage-tasks/task-run-history.md | 12 +++++------- .../v2.0/process-data/manage-tasks/update-task.md | 3 +-- content/v2.0/process-data/manage-tasks/view-tasks.md | 3 +-- 7 files changed, 16 insertions(+), 23 deletions(-) diff --git a/content/v2.0/process-data/manage-tasks/create-task.md b/content/v2.0/process-data/manage-tasks/create-task.md index d6b351a9c..b4875d73b 100644 --- a/content/v2.0/process-data/manage-tasks/create-task.md +++ b/content/v2.0/process-data/manage-tasks/create-task.md @@ -2,8 +2,7 @@ title: Create a task seotitle: Create a task for processing data in InfluxDB description: > - Create a data processing task in InfluxDB using the InfluxDB user interface or - the `influx` command line interface. + Create a data processing task in InfluxDB using the InfluxDB UI or the `influx` CLI. menu: v2_0: name: Create a task diff --git a/content/v2.0/process-data/manage-tasks/delete-task.md b/content/v2.0/process-data/manage-tasks/delete-task.md index c4850c8b8..f89b0981e 100644 --- a/content/v2.0/process-data/manage-tasks/delete-task.md +++ b/content/v2.0/process-data/manage-tasks/delete-task.md @@ -2,8 +2,7 @@ title: Delete a task seotitle: Delete a task for processing data in InfluxDB description: > - Delete a task from InfluxDB using the InfluxDB user interface or using the - `influx` command line interface. + Delete a task from InfluxDB using the InfluxDB UI or the `influx` CLI. menu: v2_0: name: Delete a task diff --git a/content/v2.0/process-data/manage-tasks/export-task.md b/content/v2.0/process-data/manage-tasks/export-task.md index 604077dd3..72fa084dd 100644 --- a/content/v2.0/process-data/manage-tasks/export-task.md +++ b/content/v2.0/process-data/manage-tasks/export-task.md @@ -1,7 +1,7 @@ --- title: Export a task seotitle: Export an InfluxDB task -description: Export a data processing task from InfluxDB using the InfluxDB user interface. +description: Export a data processing task from InfluxDB using the InfluxDB UI. menu: v2_0: name: Export a task @@ -9,7 +9,7 @@ menu: weight: 205 --- -InfluxDB allows you to export tasks from the InfluxDB user interface (UI). +InfluxDB lets you export tasks from the InfluxDB user interface (UI). Tasks are exported as downloadable JSON files. To export a task: diff --git a/content/v2.0/process-data/manage-tasks/run-task.md b/content/v2.0/process-data/manage-tasks/run-task.md index fb10b7fbf..ec975adf7 100644 --- a/content/v2.0/process-data/manage-tasks/run-task.md +++ b/content/v2.0/process-data/manage-tasks/run-task.md @@ -2,8 +2,7 @@ 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. + Run a data processing task using the InfluxDB UI or the `influx` CLI. menu: v2_0: name: Run a task @@ -12,15 +11,15 @@ 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). +however, you can manually run a task from the InfluxDB user interface (UI) or 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. +2. Hover over the task you want to run and click the **{{< icon "gear" >}}** icon. 3. Select **Run Task**. ## Run a task with the influx CLI @@ -34,7 +33,7 @@ To run a task from the `influx` CLI, the task must have already run at least onc # 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 +# Use the task ID to list previous runs of the task influx task run find --task-id=0000000000000000 # Use the task ID and run ID to retry a run diff --git a/content/v2.0/process-data/manage-tasks/task-run-history.md b/content/v2.0/process-data/manage-tasks/task-run-history.md index 1e67bbc53..ee4cae300 100644 --- a/content/v2.0/process-data/manage-tasks/task-run-history.md +++ b/content/v2.0/process-data/manage-tasks/task-run-history.md @@ -1,8 +1,7 @@ --- 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. + View task run histories and logs using the InfluxDB UI or the `influx` CLI. menu: v2_0: name: View run history @@ -10,21 +9,20 @@ menu: 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. +When an InfluxDB task runs, a "run" record is created in the task's history. +Logs associated with each run provide relevant log messages, timestamps, +and the exit status 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. +2. Hover over the task you want to run and click the **{{< icon "gear" >}}** icon. 3. Select **View Task Runs**. ### View task run logs diff --git a/content/v2.0/process-data/manage-tasks/update-task.md b/content/v2.0/process-data/manage-tasks/update-task.md index 2d9c975a5..6527c1550 100644 --- a/content/v2.0/process-data/manage-tasks/update-task.md +++ b/content/v2.0/process-data/manage-tasks/update-task.md @@ -2,8 +2,7 @@ title: Update a task seotitle: Update a task for processing data in InfluxDB description: > - Update a data processing task in InfluxDB using the InfluxDB user interface or - the `influx` command line interface. + Update a data processing task in InfluxDB using the InfluxDB UI or the `influx` CLI. menu: v2_0: name: Update a task diff --git a/content/v2.0/process-data/manage-tasks/view-tasks.md b/content/v2.0/process-data/manage-tasks/view-tasks.md index 30ab0be77..2bd3ffc38 100644 --- a/content/v2.0/process-data/manage-tasks/view-tasks.md +++ b/content/v2.0/process-data/manage-tasks/view-tasks.md @@ -2,8 +2,7 @@ title: View tasks seotitle: View created tasks that process data in InfluxDB description: > - View existing data processing tasks using the InfluxDB user interface or the - `influx` command line interface. + View existing data processing tasks using the InfluxDB UI or the `influx` CLI. menu: v2_0: name: View tasks