From 63bfc40b79821bd326d0b4bd8ad69f074b59733a Mon Sep 17 00:00:00 2001 From: Nora Date: Mon, 14 Jan 2019 11:51:04 -0800 Subject: [PATCH 1/4] Adding steps for dashboards --- content/v2.0/UI/dashboards.md | 46 ++++++++++++++++++++++++++++++++--- 1 file changed, 43 insertions(+), 3 deletions(-) diff --git a/content/v2.0/UI/dashboards.md b/content/v2.0/UI/dashboards.md index 7a9ade28f..48065cab3 100644 --- a/content/v2.0/UI/dashboards.md +++ b/content/v2.0/UI/dashboards.md @@ -1,10 +1,50 @@ --- -title: Creating dashboards +title: Managing dashboards description: This is just an example post to show the format of new 2.0 posts menu: v2_0: - name: Creating dashboards + name: Managing dashboards weight: 1 --- -_This is just an example post._ +## Creating dashboards + +**To create a dashboard**: + +1. Click the **Dashboards** icon in the navigation bar. +2. Click the **+Create Dashboard** button in the upper right. +3. Enter a name for your dashboard in the **Name this dashboard** field in the upper left. + +**To add data to your dashboard**: + +1. From your dashboard, click **Add Cell** in the upper right. The Data Explorer overlay opens. +2. Create a query in the Data Explorer following the instructions in <>. +3. Enter a name for your cell in the upper left. +4. Click the checkmark icon to save the cell to your dashboard. + +You can also send data to your dashboard directly from the Data Explorer. For details, see <>. + +**To add a note to your dashboard**: +1. From your dashboard, click **Add Note** in the upper right. +2. Enter your note in the window that appears. You can use Markdown syntax to format your note. +3. To preview your Markdown formatting, click the **Preview** option. +4. Click **Save**. + + +## Modifying dashboards + + **To delete a dashboard**: + 1. Hover over the dashboard name in the list of dashboards to show options. + 2. Click **Delete**. + <> + 3. Click **Confirm** to continue deleting your dashboard. + +**To clone a dashboard**: +1. Hover over the dashbaord name in the list of dashboard to show options. +2. Click **Clone**. +<> +3. The cloned dashboard opens. + + +## Importing and exporting dashboards +å From fa762ea4639d22828e6a52f2a4ec9a56b2551951 Mon Sep 17 00:00:00 2001 From: Nora Date: Mon, 14 Jan 2019 13:27:12 -0800 Subject: [PATCH 2/4] Additional dashboard content --- content/v2.0/UI/dashboards.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/content/v2.0/UI/dashboards.md b/content/v2.0/UI/dashboards.md index 48065cab3..d824beee8 100644 --- a/content/v2.0/UI/dashboards.md +++ b/content/v2.0/UI/dashboards.md @@ -7,6 +7,8 @@ menu: weight: 1 --- +Create, edit, and manage dashboards from the **Dashboards** tab in the left navigation. + ## Creating dashboards **To create a dashboard**: @@ -40,11 +42,20 @@ You can also send data to your dashboard directly from the Data Explorer. For de 3. Click **Confirm** to continue deleting your dashboard. **To clone a dashboard**: -1. Hover over the dashbaord name in the list of dashboard to show options. -2. Click **Clone**. +* Hover over the dashbaord name in the list of dashboard to show options. +* Click **Clone**. <> -3. The cloned dashboard opens. + The cloned dashboard opens. ## Importing and exporting dashboards -å + +**To import a dashboard**: +1. From the **Dashboards** tab, click **Import** in the upper right. +2. Drag a file into the **Import Dashboard** window or click to manually select one. +<> +3. Click **Upload Dashboard**. + +**To export a dashboard**: +* Hover over the dashboard name in the list of dashboards to show options. +* Click **Export** to download the JSON file. From 37b5d4025bc3100411ecd4168bf9d339afc2d937 Mon Sep 17 00:00:00 2001 From: Nora Date: Mon, 14 Jan 2019 14:15:32 -0800 Subject: [PATCH 3/4] Updated Data explorer steps --- content/v2.0/UI/exploring-metrics.md | 70 ++++++---------------------- 1 file changed, 15 insertions(+), 55 deletions(-) diff --git a/content/v2.0/UI/exploring-metrics.md b/content/v2.0/UI/exploring-metrics.md index 81ecece3b..04da98f65 100644 --- a/content/v2.0/UI/exploring-metrics.md +++ b/content/v2.0/UI/exploring-metrics.md @@ -7,74 +7,34 @@ menu: weight: 1 --- -* User can rapidly build Flux scripts and see data -* User can enter "advanced mode" to edit Flux script without builder -* User can save Flux script as a dashboard cell -* User can save Flux script as a task - -Explore and visualize your data in the **Data Explorer**. For both InfluxQL and Flux, Chronograf allows you to move seamlessly between using the builder or templates and manually editing the query; when possible, the interface automatically populates the builder with the information from your raw query. Choose between [visualization types](/chronograf/latest/guides/visualization-types/) for your query. +Explore and visualize your data in the **Data Explorer**. The user interface allows you to move seamlessly between using the builder or templates and manually editing the query; when possible, the interface automatically populates the builder with the information from your raw query. Choose between [visualization types](/chronograf/latest/guides/visualization-types/) for your query. To open the **Data Explorer**, click the **Explore** icon in the navigation bar: -## Explore data with InfluxQL - -InfluxQL is a SQL-like query language you can use to interact with data in InfluxDB. For detailed tutorials and reference material, see our [InfluxQL documentation](/influxdb/latest/query_language/). - -1. Open the Data Explorer and click **Add a Query**. -2. To the right of the source dropdown above the graph placeholder, select **InfluxQL** as the source type. -3. Use the builder to select from your existing data and allow Chronograf to format the query for you. Alternatively, manually enter and edit a query. -4. You can also select from the dropdown list of **Metaquery Templates**. Metaqueries show information about a database, such as. -5. Click **Show template values** to display the calculated values in the template. - ## Explore data with Flux Flux is InfluxData's new functional data scripting language designed for querying, analyzing, and acting on time series data. To learn more about Flux, see [Getting started with Flux](/flux/v0.7/introduction/getting-started). -> ***Note:*** Flux v0.7 is a technical preview included with [InfluxDB v1.7](/influxdb/v1.7). It is still in active development and many functions provided by InfluxQL and TICKscript have yet to be implemented. - - -1. Open the Data Explorer and click **Add a Query**. -2. To the right of the source dropdown above the graph placeholder, select **Flux** as the source type. - The **Schema**, **Functions**, and **Script** panes appear. -3. Use the **Schema** pane to explore your available data. Click the **+** sign next to a bucket name to expand its content. -4. Use the **Functions** pane to view details about the available Flux functions. -5. Use the **Script** pane to enter your Flux query. - - * To get started with your query, click the **Script Wizard**. In the wizard, you can select a bucket, measurement, fields and an aggregate. - - - - For example, if you make the above selections, the wizard inserts the following script: - - ```js - from(bucket: "telegraf/autogen") - |> range(start: dashboardTime) - |> filter(fn: (r) => r._measurement == "cpu" and (r._field == "usage_system")) - |> window(every: autoInterval) - |> toFloat() - |> percentile(percentile: 0.95) - |> group(except: ["_time", "_start", "_stop", "_value"]) - ``` - * Alternatively, you can enter your entire script manually. - -6. Click **Run Script** in the top bar of the **Script** pane. You can then preview your graph in the above pane. +1. Click the **Data Explorer** icon in the sidebar. +2. Use the builder to select from your existing data and have the query automatically formatted for you. +Alternatively, click **Edit Query As Flux** to manually edit the query. To switch back to the query builder, click **Visual Query Builder**. +3. Use the **Functions** pane to review the available Flux functions. Click on a function from the list to add it to your query. +4. Click **Submit** to run your query. You can then preview your graph in the above pane. ## Visualize your query -Select the **Visualization** tab at the top of the **Data Explorer**. For details about all of the available visualization options, see [Visualization types in Chronograf](/chronograf/latest/guides/visualization-types/). +**To visualize your query**: -## Add queries to dashboards +* Select a visualization type from the dropdown menu in the upper-left. +<> +* Select the **Visualization** tab at the bottom of the **Data Explorer**. For details about all of the available visualization options, see [Visualization types](/chronograf/latest/guides/visualization-types/). -To add your query and graph to a dashboard: +## Save your query as a dashboard cell or task -1. Click **Send to Dashboard** in the upper right. -2. In the **Target Dashboard(s)** dropdown, select at least one existing dashboard to send the cell to, or select **Send to a New Dashboard**. +**To save your query**: - - -3. Enter a name for the new cell and, if you created a new dashboard, the new dashboard. -4. Click **Send to Dashboard(s)**. - - +1. Click **Save as** in the upper right. +2. Click **Dashboard Cell** to add your query to a dashboard. +3. Click **Task** to save your query as a task. From 94e27328b02d9a06c972e31cae17fa91950ee876 Mon Sep 17 00:00:00 2001 From: Nora Date: Mon, 14 Jan 2019 14:27:28 -0800 Subject: [PATCH 4/4] Update to tasks doc (remove old notes) --- content/v2.0/UI/using-tasks.md | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/content/v2.0/UI/using-tasks.md b/content/v2.0/UI/using-tasks.md index 7014b0731..b4307a97c 100644 --- a/content/v2.0/UI/using-tasks.md +++ b/content/v2.0/UI/using-tasks.md @@ -7,6 +7,7 @@ menu: weight: 1 --- + **To filter the list of tasks**: * Enable the **Show Inactive** option to include inactive tasks on the list. * Enter text in the **Filter tasks by name** field to search for tasks by name. @@ -30,15 +31,3 @@ menu: * **Retry Attempts**: The number of times the task should retry !!! 3. In the right panel, enter your task script. 4. Click **Save**. - -* User can see all tasks they have access to -* User can filter list by task name, owner, or date modified -* User can delete tasks with confirmation -* Click name of task to edit - - -## Task (/organizations/taskname/taskID) - -* Only show Flux script in Text Editor -* Updated task options should be handled from options panel in UI -* Click to edit task name in page header