diff --git a/assets/styles/layouts/_inline-icons.scss b/assets/styles/layouts/_inline-icons.scss index 5816173df..c1ec8efb5 100644 --- a/assets/styles/layouts/_inline-icons.scss +++ b/assets/styles/layouts/_inline-icons.scss @@ -28,11 +28,13 @@ position: relative; width: 28px; height: 16px; - background: $b-pool; border-radius: .7rem; vertical-align: text-top; margin-top: 2px; + &.blue { background: $b-pool; } + &.green { background: $gr-viridian; } + .circle { display: inline-block; position: absolute; diff --git a/content/v2.0/cloud/account-management/billing.md b/content/v2.0/cloud/account-management/billing.md index c082b923a..4a1c4800c 100644 --- a/content/v2.0/cloud/account-management/billing.md +++ b/content/v2.0/cloud/account-management/billing.md @@ -13,7 +13,7 @@ menu: Add your payment method and view billing information in the {{< cloud-name "short" >}} user interface (UI). ## Access billing details -1. Click on the **user avatar** in the top right corner of the {{< cloud-name "short" >}} +1. Click the **user avatar** in the top right corner of the {{< cloud-name "short" >}} UI and select **Billing**. 2. Do one of the following: - If you subscribed to an InfluxDB Cloud 2.0 plan through **AWS Marketplace**, diff --git a/content/v2.0/cloud/account-management/offboarding.md b/content/v2.0/cloud/account-management/offboarding.md index 4caf5f56a..8552de710 100644 --- a/content/v2.0/cloud/account-management/offboarding.md +++ b/content/v2.0/cloud/account-management/offboarding.md @@ -43,7 +43,7 @@ For details, see [Export a dashboard](/v2.0/visualize-data/dashboards/export-das {{< nav-icon "load-data" >}} 2. Select the **Telegraf** tab. A list of existing Telegraf configurations appears. -3. Click on the name of a Telegraf configuration. +3. Click the name of a Telegraf configuration. 4. Click **Download Config** to save. #### Request a data backup diff --git a/content/v2.0/get-started.md b/content/v2.0/get-started.md index 169302a6a..095a6c35c 100644 --- a/content/v2.0/get-started.md +++ b/content/v2.0/get-started.md @@ -1,5 +1,5 @@ --- -title: Get started with InfluxDB +title: Get started with InfluxDB OSS description: Download, install, and setup InfluxDB, creating a default organization, user, and bucket. menu: v2_0: @@ -8,7 +8,7 @@ weight: 1 v2.0/tags: [get-started, install] --- -Get started with InfluxDB v2.0 by downloading InfluxDB, installing the necessary +Get started with InfluxDB OSS v2.0 by downloading InfluxDB, installing the necessary executables, and running the initial setup process. {{% cloud-msg %}} diff --git a/content/v2.0/organizations/buckets/view-buckets.md b/content/v2.0/organizations/buckets/view-buckets.md index abc9b50b4..c5129b0d5 100644 --- a/content/v2.0/organizations/buckets/view-buckets.md +++ b/content/v2.0/organizations/buckets/view-buckets.md @@ -16,7 +16,7 @@ weight: 202 {{< nav-icon "load data" >}} 2. Select **Buckets**. -3. Click on a bucket to view details. +3. Click a bucket to open it **Data Explorer**. ## View buckets using the influx CLI diff --git a/content/v2.0/organizations/members/add-member.md b/content/v2.0/organizations/members/add-member.md index 1992db240..41daffc80 100644 --- a/content/v2.0/organizations/members/add-member.md +++ b/content/v2.0/organizations/members/add-member.md @@ -21,7 +21,7 @@ Adding members is currently unavailable in {{< cloud-name >}}. {{< nav-icon "settings" >}} -2. Click on the name of an organization, then select the **Members** tab. +2. Click the name of an organization, then select the **Members** tab. _Complete content coming soon_ --> diff --git a/content/v2.0/organizations/members/view-members.md b/content/v2.0/organizations/members/view-members.md index 6752a8ea1..1cdc5b444 100644 --- a/content/v2.0/organizations/members/view-members.md +++ b/content/v2.0/organizations/members/view-members.md @@ -18,7 +18,7 @@ to view members of an organization. {{< nav-icon "settings" >}} -* Click on the name of an organization, then select the **Members** tab. The list of organization members appears. +* Click the name of an organization, then select the **Members** tab. The list of organization members appears. ## View members of organization using the influx CLI 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 dae3e5f1a..3914fb211 100644 --- a/content/v2.0/process-data/manage-tasks/create-task.md +++ b/content/v2.0/process-data/manage-tasks/create-task.md @@ -30,7 +30,7 @@ The InfluxDB UI provides multiple ways to create a task: - [Clone a task](#clone-a-task) ### Create a task from the Data Explorer -1. Click on the **Data Explorer** icon in the left navigation menu. +1. Click the **Data Explorer** icon in the left navigation menu. {{< nav-icon "data-explorer" >}} @@ -43,7 +43,7 @@ The InfluxDB UI provides multiple ways to create a task: ### Create a task in the Task UI -1. Click on the **Tasks** icon in the left navigation menu. +1. Click the **Tasks** icon in the left navigation menu. {{< nav-icon "tasks" >}} @@ -56,7 +56,7 @@ The InfluxDB UI provides multiple ways to create a task: 7. Click **Save** in the upper right. ### Import a task -1. Click on the **Tasks** icon in the left navigation menu. +1. Click the **Tasks** icon in the left navigation menu. {{< nav-icon "tasks" >}} @@ -69,7 +69,7 @@ The InfluxDB UI provides multiple ways to create a task: 5. Click **Import JSON as Task**. ### Create a task from a template -1. Click on the **Settings** icon in the left navigation menu. +1. Click the **Settings** icon in the left navigation menu. {{< nav-icon "Settings" >}} @@ -78,7 +78,7 @@ The InfluxDB UI provides multiple ways to create a task: ### Clone a task -1. Click on the **Tasks** icon in the left navigation menu. +1. Click the **Tasks** icon in the left navigation menu. {{< nav-icon "tasks" >}} 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 54dfdc324..e0d55a65c 100644 --- a/content/v2.0/process-data/manage-tasks/update-task.md +++ b/content/v2.0/process-data/manage-tasks/update-task.md @@ -17,7 +17,7 @@ To view your tasks, click the **Tasks** icon in the left navigation menu. {{< nav-icon "tasks" >}} -Click on the name of a task to update it. +Click the name of a task to update it. #### Update a task Flux script 1. In the list of tasks, click the **Name** of the task you want to update. 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 4787b4a37..fc4dd4083 100644 --- a/content/v2.0/process-data/manage-tasks/view-tasks.md +++ b/content/v2.0/process-data/manage-tasks/view-tasks.md @@ -22,7 +22,7 @@ Click the **Tasks** icon in the left navigation to view the lists of tasks. 1. Click the **Show Inactive** {{< icon "toggle" >}} toggle to include or exclude inactive tasks in the list. 2. Enter text in the **Filter tasks** field to search for tasks by name or label. -3. Click on the heading of any column to sort by that field. +3. Click the heading of any column to sort by that field. ## View tasks with the influx CLI Use the `influx task list` command to return a list of created tasks. diff --git a/content/v2.0/security/tokens/create-token.md b/content/v2.0/security/tokens/create-token.md index eb37bdc1c..748cbbe01 100644 --- a/content/v2.0/security/tokens/create-token.md +++ b/content/v2.0/security/tokens/create-token.md @@ -21,9 +21,10 @@ command line interface (CLI). {{< nav-icon "disks" >}} 2. Click **Tokens**. -3. Click the **+ Generate** dropdown in the upper right and select a token type (**Read/Write Token** or **All Access Token**). +3. Click **{{< icon "plus" >}} Generate** and select a token type + (**Read/Write Token** or **All Access Token**). 4. In the window that appears, enter a description for your token in the **Description** field. -5. If you're generating a read/write token: +5. If generating a **read/write token**: - Search for and select buckets to read from in the **Read** pane. - Search for and select buckets to write to in the **Write** pane. 5. Click **Save**. diff --git a/content/v2.0/security/tokens/update-tokens.md b/content/v2.0/security/tokens/update-tokens.md index b566c8809..ed979902f 100644 --- a/content/v2.0/security/tokens/update-tokens.md +++ b/content/v2.0/security/tokens/update-tokens.md @@ -22,3 +22,12 @@ Update an authentication token's description using the InfluxDB user interface ( 2. Click **Tokens**. All of your account's tokens appear. 3. Click the pencil icon {{< icon "pencil" >}} next to the token's name in the **Description** column. 4. Update the token description, then click anywhere else to save. + +## Enable or disable a token + +1. Click the **Load Data** icon in the navigation bar. + + {{< nav-icon "disks" >}} + +2. Click **Tokens**. All of your account's tokens appear. +3. Click the **{{< icon "toggle-green" >}} Status** toggle. diff --git a/content/v2.0/security/tokens/view-tokens.md b/content/v2.0/security/tokens/view-tokens.md index 150395965..2de383107 100644 --- a/content/v2.0/security/tokens/view-tokens.md +++ b/content/v2.0/security/tokens/view-tokens.md @@ -21,7 +21,7 @@ command line interface (CLI). {{< nav-icon "disks" >}} 2. Click **Tokens**. All of your account's tokens appear. -3. Click on a token name from the list to view the token and a summary of access permissions. +3. Click a token name from the list to view the token and a summary of access permissions. ## View tokens using the influx CLI diff --git a/content/v2.0/visualize-data/dashboards/_index.md b/content/v2.0/visualize-data/dashboards/_index.md index 163282269..947db71c5 100644 --- a/content/v2.0/visualize-data/dashboards/_index.md +++ b/content/v2.0/visualize-data/dashboards/_index.md @@ -6,7 +6,7 @@ menu: v2_0: name: Manage dashboards parent: Visualize data -weight: 101 +weight: 102 --- Create, edit, and manage dashboards from the **Dashboards** tab in the left navigation. diff --git a/content/v2.0/visualize-data/dashboards/control-dashboard.md b/content/v2.0/visualize-data/dashboards/control-dashboard.md index b863bb522..d01c99abc 100644 --- a/content/v2.0/visualize-data/dashboards/control-dashboard.md +++ b/content/v2.0/visualize-data/dashboards/control-dashboard.md @@ -16,13 +16,13 @@ Use dashboard controls in the upper right to update your dashboard. ### Add a cell -Click {{< icon "add-cell" >}} **Add Cell** to open the Data Explorer and configure a new cell for your dashboard. +Click **{{< icon "add-cell" >}} Add Cell** to open the Data Explorer and configure a new cell for your dashboard. For details on using the Data Explorer, see [Explore metrics](/v2.0/visualize-data/explore-metrics/). ### Add a note -1. Click {{< icon "note" >}} **Add Note** to add a note cell to your dashboard. +1. Click **{{< icon "note" >}} Add Note** to add a note cell to your dashboard. 2. Enter your note in Markdown in the left pane. A preview appears in the right pane. 3. Enable the **Show note when query returns no data** option to show the note only when the query displays no data. 4. Click **Save**. @@ -41,7 +41,7 @@ Select how frequently to refresh the dashboard's data. By default, refreshing is ### Manually refresh dashboard -Click the refresh button ({{< icon "refresh" >}}) to manually refresh the dashboard's data. +Click the refresh button (**{{< icon "refresh" >}}**) to manually refresh the dashboard's data. ### Select time range @@ -58,4 +58,9 @@ Click **Variables** to display variables available for your dashboard. For detai ### Presentation mode -Click the fullscreen icon ({{< icon "fullscreen" >}}) to enter presentation mode. Presentation mode allows you to view [a dashboard] in full screen, hiding the left and top navigation menus so only the cells appear. This mode might be helpful, for example, for stationary screens dedicated to monitoring visualizations. +Click the fullscreen icon (**{{< icon "fullscreen" >}}**) to enter presentation mode. Presentation mode allows you to view [a dashboard] in full screen, hiding the left and top navigation menus so only the cells appear. This mode might be helpful, for example, for stationary screens dedicated to monitoring visualizations. + +### Toggle dark mode and light mode +Click the moon or sun icons to toggle your dashboard between **dark mode** and **light mode.** + +{{< img-hd src="/img/2-0-controls-dark-light-mode.png" alt="Dark & light mode"/>}} diff --git a/content/v2.0/visualize-data/dashboards/create-dashboard.md b/content/v2.0/visualize-data/dashboards/create-dashboard.md index 14ee507a8..5f34a000e 100644 --- a/content/v2.0/visualize-data/dashboards/create-dashboard.md +++ b/content/v2.0/visualize-data/dashboards/create-dashboard.md @@ -14,12 +14,11 @@ weight: 201 ## Create a new dashboard - 1. Click the **Dashboards** icon in the navigation bar. {{< nav-icon "dashboards" >}} -2. Click the **+Create Dashboard** menu in the upper right and select **New Dashboard**. +2. Click the **{{< icon "plus" >}} Create Dashboard** menu in the upper right and select **New Dashboard**. 3. Enter a name for your dashboard in the **Name this dashboard** field in the upper left. @@ -63,20 +62,24 @@ weight: 201 ## Clone a dashboard -1. Hover over the dashboard name in the list of dashboard to show options. -2. Click **Clone**. The cloned dashboard opens. +1. Click the **Dashboards** icon in the navigation bar. + + {{< nav-icon "dashboards" >}} + +2. Hover over the dashboard and click **{{< icon "copy" >}}**. +3. Click **Clone**. The cloned dashboard opens. #### Add data to your dashboard -1. From your dashboard, click **Add Cell** (**{{< icon "add-cell" >}}**) in the upper right. The Data Explorer overlay opens. +1. From your dashboard, click **{{< icon "add-cell" >}} Add Cell**. 2. Create a query in the Data Explorer following the instructions in [Explore metrics](/v2.0/visualize-data/explore-metrics). 3. Enter a name for your cell in the upper left. 4. Click the checkmark icon (**{{< icon "checkmark" >}}**) to save the cell to your dashboard. You can also send data to your dashboard directly from the Data Explorer. For details, [Explore metrics](/v2.0/visualize-data/explore-metrics). #### Add a note to your dashboard -1. From your dashboard, click **Add Note** in the upper right. +1. From your dashboard, click **{{< icon "note" >}} 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**. diff --git a/content/v2.0/visualize-data/dashboards/delete-dashboard.md b/content/v2.0/visualize-data/dashboards/delete-dashboard.md index 1709d3175..717e36e08 100644 --- a/content/v2.0/visualize-data/dashboards/delete-dashboard.md +++ b/content/v2.0/visualize-data/dashboards/delete-dashboard.md @@ -11,9 +11,12 @@ weight: 204 To delete a dashboard from the InfluxDB user interface (UI): -1. Hover over the dashboard name in the list of dashboards to show options. -2. Click **{{< icon "trash" >}}**. -3. Click **Delete** to delete your dashboard. +1. Click the **Dashboards** icon in the navigation bar. + + {{< nav-icon "dashboards" >}} + +2. Hover over the dashboard in the list of dashboards and click **{{< icon "trash" >}}**. +3. Click **Delete**. {{% warn %}} Deleting a dashboard cannot be undone. diff --git a/content/v2.0/visualize-data/dashboards/export-dashboard.md b/content/v2.0/visualize-data/dashboards/export-dashboard.md index 5db00de75..0a2608631 100644 --- a/content/v2.0/visualize-data/dashboards/export-dashboard.md +++ b/content/v2.0/visualize-data/dashboards/export-dashboard.md @@ -19,7 +19,8 @@ InfluxDB lets you export dashboards from the InfluxDB user interface (UI). {{< nav-icon "dashboards" >}} -2. Hover over a dashboard in the list, then click the gear icon ({{< icon "gear" >}}) and select **Export**. +2. Hover over a dashboard and click the gear icon (**{{< icon "gear" >}}**), + and then select **Export**. 3. Review the JSON in the window that appears. 4. Select one of the following options: * **Download JSON**: Download the dashboard as a JSON file. diff --git a/content/v2.0/visualize-data/dashboards/update-dashboard.md b/content/v2.0/visualize-data/dashboards/update-dashboard.md deleted file mode 100644 index 92b2fbfa5..000000000 --- a/content/v2.0/visualize-data/dashboards/update-dashboard.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Update a dashboard -seotitle: Update an InfluxDB dashboard -description: Update an InfluxDB dashboard in the InfluxDB user interface (UI). -v2.0/tags: [dashboards] -menu: - v2_0: - name: Update a dashboard - parent: Manage dashboards -weight: 202 -draft: true ---- - -**Notes:** - -- Dashboard name -- Dashboard description -- Labels -- Dashboard cells -- etc. diff --git a/content/v2.0/visualize-data/explore-metrics.md b/content/v2.0/visualize-data/explore-metrics.md index e8df4cd54..833293fc6 100644 --- a/content/v2.0/visualize-data/explore-metrics.md +++ b/content/v2.0/visualize-data/explore-metrics.md @@ -38,11 +38,11 @@ See [Get started with Flux](/v2.0/query-data/get-started) to learn more about Fl 3. Alternatively, click **Script Editor** to manually edit the query. To switch back to the query builder, click **Query Builder**. Note that your updates from the Script Editor will not be saved. 4. Use the **Functions** list to review the available Flux functions. - Click on a function from the list to add it to your query. + Click a function from the list to add it to your query. 5. Click **Submit** (or press `Control+Enter`) to run your query. You can then preview your graph in the above pane. 6. To work on multiple queries at once, click the {{< icon "plus" >}} to add another tab. * Click the eye icon on a tab to hide or show a query's visualization. - * Click on the name of the query in the tab to rename it. + * Click the name of the query in the tab to rename it. ## Visualize your query diff --git a/content/v2.0/visualize-data/labels.md b/content/v2.0/visualize-data/labels.md index fc40e8470..48a260409 100644 --- a/content/v2.0/visualize-data/labels.md +++ b/content/v2.0/visualize-data/labels.md @@ -8,7 +8,7 @@ menu: v2_0: name: Manage labels parent: Visualize data -weight: 101 +weight: 104 --- Labels are a way to add visual metadata to dashboards, tasks, and other items in the InfluxDB UI. @@ -21,11 +21,11 @@ To manage labels: 2. Click **Labels**. #### Create a label -1. Click **+ Create Label**. +1. Click **{{< icon "plus" >}} Create Label**. 2. Enter a **Name** for the label. 3. Enter a description for the label _(Optional)_. 4. Select a **Color** for the label. -5. Click **Create label**. +5. Click **Create Label**. #### Edit a label 1. In the label list view, click the name of the label you would like to edit. @@ -34,8 +34,8 @@ To manage labels: 3. Click **Save Changes**. #### Delete a label -1. In the label list view, hover over the label you would like to delete. -2. Click **Delete** in the far right of the label row. +1. In the label list view, hover over the label you would like to delete and click **{{< icon "trash" >}}**. +2. Click **Delete**. ### Add labels to dashboard items 1. In the list view of dashboards, tasks, or other assets, hover over the item to which you would like to add a label. diff --git a/content/v2.0/visualize-data/sources.md b/content/v2.0/visualize-data/sources.md deleted file mode 100644 index cb08903c0..000000000 --- a/content/v2.0/visualize-data/sources.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Manage sources -description: InfluxDB offers a complete dashboard solution for visualizing your data and monitoring your infrastructure. -v2.0/tags: [sources] -menu: - v2_0: - name: Manage sources - parent: Visualize data -weight: 101 ---- - -Like dashboards and buckets, data sources are scoped by organization. When you first access the user interface, you'll be prompted to add a data source. You can also do so anytime using the steps below. - - -**To add data to a bucket**: - -1. Click the **Settings** tab in the navigation bar. - - {{< nav-icon "settings" >}} - -2. Click the **Buckets** tab. -3. Next to the name of a bucket, click **Add Data**. -4. Select **Streaming**, **Line Protocol**, or **Scraping** from the data source options. -5. Click **Continue**. -6. Follow the prompts add your data source. - -**To manage Telegraf configurations**: - -1. Click the **Settings** tab in the navigation bar. - - {{< nav-icon "settings" >}} - -2. Click the **Telegraf** tab. A list of existing Telegraf configurations appears. -3. To add a new Telegraf configuration: - * Click **Create Configuration** in the upper right. - * Select the Telegraf plugins you want to use to collect data. - * Click **Continue**. - * Follow the instructions on the **Listen for Streaming Data** page that appears to complete your configuration. -4. To delete a Telegraf configuration, hover over its name in the list and click **Delete**. -5. To view details of a Telegraf configuration, click on its name in the list. - - To save the Telegraf configuration, click **Download Config**. diff --git a/content/v2.0/visualize-data/templates/_index.md b/content/v2.0/visualize-data/templates/_index.md index f3cf470df..9f1daea05 100644 --- a/content/v2.0/visualize-data/templates/_index.md +++ b/content/v2.0/visualize-data/templates/_index.md @@ -1,14 +1,21 @@ --- -title: Manage InfluxDB templates -description: Create, edit, and manage templates in the InfluxDB user interface (UI). +title: Manage InfluxDB dashboard templates +description: Create, edit, and manage dashboard templates in the InfluxDB user interface (UI). v2.0/tags: [templates] menu: v2_0: - name: Manage templates + name: Manage dashboard templates parent: Visualize data -weight: 101 +weight: 104 --- -Templates are a way to create and share dashboards across organizations without starting from scratch. +Dashboard templates are a way to create and share dashboards across organizations +without starting from scratch. + +### Dashboard template types +The following types of templates are available: + +- **Static templates:** templates included with the InfluxDB user interface (UI). +- **User templates:** custom-built templates saved in the UI. {{< children >}} diff --git a/content/v2.0/visualize-data/templates/create-template.md b/content/v2.0/visualize-data/templates/create-template.md index 654b40608..be07b6c5e 100644 --- a/content/v2.0/visualize-data/templates/create-template.md +++ b/content/v2.0/visualize-data/templates/create-template.md @@ -1,17 +1,46 @@ --- title: Create a template -seotitle: Create an InfluxDB template -description: Create an InfluxDB template in the InfluxDB user interface (UI). +seotitle: Create an InfluxDB dashboard template +description: Create an InfluxDB dashboard template in the InfluxDB user interface (UI). v2.0/tags: [templates] menu: v2_0: name: Create a template - parent: Manage templates + parent: Manage dashboard templates weight: 201 --- -## Import a template +## Create a template from an existing dashboard + +1. Click the **Dashboards** icon in the navigation bar. + + {{< nav-icon "dashboards" >}} + +2. Hover over the dashboard you want to use to create the template and click **{{< icon "gear" >}}**. +3. Click **Export**. The dashboard JSON appears in a new window. +4. Click **Save as template**. + + +## Clone a dashboard template + +{{% note %}} +Only [user templates](/v2.0/visualize-data/templates/#dashboard-template-types) can be cloned. +{{% /note %}} + +1. Click the **Settings** icon in the left navigation. + + {{< nav-icon "settings" >}} + +2. Select the **Templates** tab. +3. Select **User Templates**. + + {{< img-hd src="/img/2-0-templates-type-select.png" alt="Select User Templates" />}} + +4. Hover over the template you want to clone and click **{{< icon "clone" >}}**. +5. Click **Clone** to confirm. The cloned template appears in your list. + +## Import an existing dashboard template 1. Click the **Settings** icon in the left navigation. @@ -23,24 +52,3 @@ weight: 201 * Select **Upload File** to drag-and-drop or select a file. * Select **Paste JSON** to paste in JSON. 5. Click **Import JSON as Template**. - - -## Create a template from an existing dashboard - -1. Click the **Dashboards** icon in the navigation bar. - - {{< nav-icon "dashboards" >}} - -2. Click the settings icon ({{< icon "gear" >}}) next to a dashboard in the list, then click **Export**. The dashboard JSON appears in a new window. -3. Click **Save as template**. - - -## Clone a template - -1. Click the **Settings** icon in the left navigation. - - {{< nav-icon "settings" >}} - -2. Select the **Templates** tab. -3. Hover over the template you want to clone, then click {{< icon "clone" >}}. -4. Click **Clone** to confirm. The cloned template appears in your list. diff --git a/content/v2.0/visualize-data/templates/delete-template.md b/content/v2.0/visualize-data/templates/delete-template.md index 4f3873b2b..d7bcf0c31 100644 --- a/content/v2.0/visualize-data/templates/delete-template.md +++ b/content/v2.0/visualize-data/templates/delete-template.md @@ -1,12 +1,12 @@ --- -title: Delete a template +title: Delete a dashboard template seotitle: Delete InfluxDB templates description: Delete templates in the InfluxDB user interface (UI). v2.0/tags: [templates] menu: v2_0: - name: Delete templates - parent: Manage templates + name: Delete a template + parent: Manage dashboard templates weight: 203 --- diff --git a/content/v2.0/visualize-data/templates/use-template.md b/content/v2.0/visualize-data/templates/use-template.md new file mode 100644 index 000000000..73398ec00 --- /dev/null +++ b/content/v2.0/visualize-data/templates/use-template.md @@ -0,0 +1,27 @@ +--- +title: Use a template +seotitle: Use an InfluxDB dashboard template +description: > + Use an InfluxDB dashboard template to create a new InfluxDB dashboard. +v2.0/tags: [templates] +menu: + v2_0: + parent: Manage dashboard templates +weight: 202 + +--- + +To create a new dashboard from an InfluxDB dashboard template: + +1. Click the **Settings** icon in the left navigation. + + {{< nav-icon "settings" >}} + +2. Select the **Templates** tab. +3. Select the [template type](/v2.0/visualize-data/templates/#dashboard-template-types). + + {{< img-hd src="/img/2-0-templates-type-select.png" alt="Select User Templates" />}} + +4. Hover over the template you want to use and click **Create**. + A notification appears confirming the dashboard was created. +5. Visit the **Dashboards** page to view the newly created dashboard. diff --git a/content/v2.0/visualize-data/templates/view-template.md b/content/v2.0/visualize-data/templates/view-template.md index 5a7346c9a..45ee9b6d3 100644 --- a/content/v2.0/visualize-data/templates/view-template.md +++ b/content/v2.0/visualize-data/templates/view-template.md @@ -6,36 +6,71 @@ v2.0/tags: [templates] menu: v2_0: name: View templates - parent: Manage templates + parent: Manage dashboard templates weight: 202 - --- -To view templates in the InfluxDB UI: + +To view templates in the InfluxDB userface (UI): 1. Click the **Settings** icon in the left navigation. {{< nav-icon "settings" >}} 2. Select the **Templates** tab. +3. Select templates to view: - - In the **Static Templates** tab, a list of pre-created templates appears. For a list of static templates, see [Static templates](#static-templates) below. - - In the **User Templates** tab, a list of custom user-created templates appears. + {{< img-hd src="/img/2-0-templates-type-select.png" alt="Select User Templates" />}} -3. Click on the name of a template to view its JSON. + - **Static Templates:** templates included with InfluxDB. + For more information, see [Static templates](#static-templates) below. + - **User Templates** custom-built templates saved in the UI. + +4. Click the name of a template to view its JSON. ## Static templates -The following Telegraf-related dashboards templates are available: +The following Telegraf-related dashboard templates are available: +- [Apache Data](#apache-data) - [Docker](#docker) - [Getting Started with Flux](#getting-started-with-flux) +- [GitHub Data](#github-data) +- [InfluxDB 2.0 OSS Metrics](#influxdb-2-0-oss-metrics) +- [JMeter](#jmeter) - [Kubernetes](#kubernetes) -- [Local Metrics](#local-metrics) - [Nginx](#nginx) - [Redis](#redis) - [System](#system) +### Apache data +The Apache data dashboard template contains an overview of Apache HTTP server metrics. +It displays the following information: + +- Apache Uptime +- CPUs +- Memory +- Memory Used +- Bytes per Second +- Requests per Second +- CPU Load (System, User) +- Load +- Workers +- Disk IO +- Network +- Scoreboard + +#### Plugins +- [`apache` plugin](/v2.0/reference/telegraf-plugins/#apache) +- [`cpu` plugin](/v2.0/reference/telegraf-plugins/#cpu) +- [`disk` plugin](/v2.0/reference/telegraf-plugins/#disk) +- [`diskio` plugin](/v2.0/reference/telegraf-plugins/#diskio) +- [`mem` plugin](/v2.0/reference/telegraf-plugins/#mem) +- [`net` plugin](/v2.0/reference/telegraf-plugins/#net) +- [`netstat` plugin](/v2.0/reference/telegraf-plugins/#netstat) +- [`system` plugin](/v2.0/reference/telegraf-plugins/#system) + ### Docker -The Docker dashboard template contains an overview of Docker metrics. It displays the following information: +The Docker dashboard template contains an overview of Docker metrics. +It displays the following information: - System Uptime - nCPUs @@ -67,7 +102,8 @@ The Docker dashboard template contains an overview of Docker metrics. It display - [`system` plugin](/v2.0/reference/telegraf-plugins/#system) ### Getting Started with Flux -This dashboard is designed to get you started with the Flux language. It contains explanations and visualizations for a series of increasingly complex example Flux queries. +This dashboard is designed to get you started with the Flux language. +It contains explanations and visualizations for a series of increasingly complex example Flux queries. - Creating your first basic Flux query - Filtering data using the `filter` function @@ -81,9 +117,62 @@ This dashboard is designed to get you started with the Flux language. It contain - [`cpu` plugin](/v2.0/reference/telegraf-plugins/#cpu) - [`disk` plugin](/v2.0/reference/telegraf-plugins/#disk) +### GitHub Data +The GitHub Data dashboard template displays data related to GitHub repositories: + +- Total Forks +- Total Size (bytes) +- Total Stars +- Total Open Issues +- Forks +- Size (bytes) +- Stars +- Issues +- Summary + +#### Plugins +- [`github` plugin](/v2.0/reference/telegraf-plugins/#github) + + +### InfluxDB 2.0 OSS Metrics +The InfluxDB 2.0 OSS Metrics dashboard shows a visual overview of some of the metrics +available from the local InfluxDB metrics endpoint located at `/metrics`. +It displays the following information: + +- Uptime +- Instance Info +- # of Orgs +- # of Users +- # of Buckets +- # of Tokens +- # of Telegraf configurations +- # of Dashboards +- # of Scrapers +- # of Tasks +- Local Object Store IO +- Memory Allocations (Bytes) +- Memory Usage (%) +- Memory Allocs & Frees (Bytes) + +### JMeter +The JMeter dashboard template provides an overview of JMeter metrics. +It displays the following information: + +- OK requests count +- Avg response time +- Max response time +- Min response time +- 99 and 95 percentile for successful requests +- KO requests count +- Thread/Virtual user count +- Number of hits +- Sent bytes +- Received bytes + ### Kubernetes -The Kubernetes dashboard gives a visual overview of Kubernetes metrics. It displays the following information: +The Kubernetes dashboard gives a visual overview of Kubernetes metrics. +It displays the following information: - Allocatable Memory - Running Pods @@ -104,26 +193,9 @@ The Kubernetes dashboard gives a visual overview of Kubernetes metrics. It displ #### Plugins - [`kubernetes` plugin](/v2.0/reference/telegraf-plugins/) -### Local Metrics -The Local Metrics dashboard shows a visual overview of some of the metrics available from the Local Metrics endpoint located at /`metrics`. It displays the following information: - -- Uptime -- Instance Info -- # of Orgs -- # of Users -- # of Buckets -- # of Tokens -- # of Telegraf configurations -- # of Dashboards -- # of Scrapers -- # of Tasks -- Local Object Store IO -- Memory Allocations (Bytes) -- Memory Usage (%) -- Memory Allocs & Frees (Bytes) - ### Nginx -The Nginx dashboard gives a visual overview of Nginx metrics. It displays the following information: +The Nginx dashboard gives a visual overview of Nginx metrics. +It displays the following information: - System Uptime - nCPUs @@ -150,7 +222,8 @@ The Nginx dashboard gives a visual overview of Nginx metrics. It displays the fo - [`system` plugin](/v2.0/reference/telegraf-plugins/#system) ### Redis -The Redis dashboard gives a visual overview of Nginx metrics. It displays the following information: +The Redis dashboard gives a visual overview of Nginx metrics. +It displays the following information: - System Uptime - nCPUs @@ -181,7 +254,8 @@ The Redis dashboard gives a visual overview of Nginx metrics. It displays the fo ### System -The System dashboard gives a visual overview of system metrics. It displays the following information: +The System dashboard gives a visual overview of system metrics. +It displays the following information: - System Uptime - nCPUs diff --git a/content/v2.0/visualize-data/variables/_index.md b/content/v2.0/visualize-data/variables/_index.md index aba1babcc..fc7bc6c76 100644 --- a/content/v2.0/visualize-data/variables/_index.md +++ b/content/v2.0/visualize-data/variables/_index.md @@ -7,8 +7,8 @@ description: > menu: v2_0: parent: Visualize data -weight: 101 -"v2.0/tags": [variables] +weight: 103 +v2.0/tags: [variables] --- Dashboard variables let you alter specific components of cells' queries without having to edit the queries, @@ -33,7 +33,7 @@ in the **Variables** tab next to the Functions tab. {{< img-hd src="/img/2-0-variables-data-explorer-view.png" />}} -Click on a variable name to add it to your query and select a value from the **Value** dropdown. +Click a variable name to add it to your query and select a value from the **Value** dropdown. ## Predefined dashboard variables The InfluxDB user interface (UI) provides the following predefined dashboard variables: diff --git a/content/v2.0/visualize-data/variables/update-variable.md b/content/v2.0/visualize-data/variables/update-variable.md index 8e000a89a..56bbf7005 100644 --- a/content/v2.0/visualize-data/variables/update-variable.md +++ b/content/v2.0/visualize-data/variables/update-variable.md @@ -18,6 +18,6 @@ Update an existing dashboard variable's name or JSON content in the InfluxDB use {{< nav-icon "settings" >}} 2. Select the **Variables** tab. -3. Click on a variable's name from the list. +3. Click a variable's name from the list. 4. Update the variable's name, type, and associated information. 5. Click **Submit**. diff --git a/content/v2.0/visualize-data/visualization-types/_index.md b/content/v2.0/visualize-data/visualization-types/_index.md index b6b713070..5af40526c 100644 --- a/content/v2.0/visualize-data/visualization-types/_index.md +++ b/content/v2.0/visualize-data/visualization-types/_index.md @@ -7,7 +7,7 @@ description: > menu: v2_0: parent: Visualize data -weight: 101 +weight: 105 --- The InfluxDB UI provides multiple visualization types to visualize your data in diff --git a/content/v2.0/visualize-data/visualization-types/gauge.md b/content/v2.0/visualize-data/visualization-types/gauge.md index d47abdd50..951cd4a77 100644 --- a/content/v2.0/visualize-data/visualization-types/gauge.md +++ b/content/v2.0/visualize-data/visualization-types/gauge.md @@ -30,8 +30,8 @@ For consistent results, the Gauge query should return a single table. {{% /note %}} ## Gauge Controls -To view **Gauge** controls, click the settings icon ({{< icon "gear" >}}) next to -the visualization dropdown in the upper right. +To view **Gauge** controls, click **{{< icon "gear" >}} Customize** next to +the visualization dropdown. - **Prefix**: Prefix to add to the gauge. - **Suffix**: Suffix to add to the gauge. diff --git a/content/v2.0/visualize-data/visualization-types/graph-single-stat.md b/content/v2.0/visualize-data/visualization-types/graph-single-stat.md index 3ef26421f..2bc556c7d 100644 --- a/content/v2.0/visualize-data/visualization-types/graph-single-stat.md +++ b/content/v2.0/visualize-data/visualization-types/graph-single-stat.md @@ -38,8 +38,8 @@ For consistent Single Stat results, the query should return a single table. {{% /note %}} ## Graph + Single Stat Controls -To view **Graph + Single Stat** controls, click the settings icon ({{< icon "gear" >}}) -next to the visualization dropdown in the upper right. +To view **Graph + Single Stat** controls, click **{{< icon "gear" >}} Customize** next to +the visualization dropdown. ###### Data - **X Column**: Select a column to display on the x-axis. diff --git a/content/v2.0/visualize-data/visualization-types/graph.md b/content/v2.0/visualize-data/visualization-types/graph.md index db0d9a1fe..c21988049 100644 --- a/content/v2.0/visualize-data/visualization-types/graph.md +++ b/content/v2.0/visualize-data/visualization-types/graph.md @@ -25,8 +25,8 @@ When multiple series are present, it automatically assigns colors based on the s When using a line graph, all points within a single table are connected. When multiple series are present, it automatically assigns colors based on the selected [Line Colors option](#options). ## Graph controls -To view **Graph** controls, click the settings icon ({{< icon "gear" >}}) next -to the visualization dropdown in the upper right. +To view **Graph** controls, click **{{< icon "gear" >}} Customize** next to +the visualization dropdown. ###### Data - **X Column**: Select a column to display on the x-axis. diff --git a/content/v2.0/visualize-data/visualization-types/heatmap.md b/content/v2.0/visualize-data/visualization-types/heatmap.md index eac4b2878..99cf8fa7a 100644 --- a/content/v2.0/visualize-data/visualization-types/heatmap.md +++ b/content/v2.0/visualize-data/visualization-types/heatmap.md @@ -29,8 +29,8 @@ The total number of points that fall within a bin determine the its value and co Warmer or brighter colors represent higher bin values or density of points within the bin. ## Heatmap Controls -To view **Heatmap** controls, click the settings icon ({{< icon "gear" >}}) -next to the visualization dropdown in the upper right. +To view **Heatmap** controls, click **{{< icon "gear" >}} Customize** next to +the visualization dropdown. ###### Data - **X Column**: Select a column to display on the x-axis. diff --git a/content/v2.0/visualize-data/visualization-types/histogram.md b/content/v2.0/visualize-data/visualization-types/histogram.md index 0c186e18c..35f0a96b5 100644 --- a/content/v2.0/visualize-data/visualization-types/histogram.md +++ b/content/v2.0/visualize-data/visualization-types/histogram.md @@ -33,8 +33,8 @@ To work properly, query results **should not** be structured as histogram data. {{% /note %}} ## Histogram Controls -To view **Histogram** controls, click the settings icon ({{< icon "gear" >}}) next -to the visualization dropdown in the upper right. +To view **Histogram** controls, click **{{< icon "gear" >}} Customize** next to +the visualization dropdown. ###### Data - **X Column**: The column to select data from. diff --git a/content/v2.0/visualize-data/visualization-types/scatter.md b/content/v2.0/visualize-data/visualization-types/scatter.md index ad54dcb0b..87c5374dc 100644 --- a/content/v2.0/visualize-data/visualization-types/scatter.md +++ b/content/v2.0/visualize-data/visualization-types/scatter.md @@ -27,8 +27,8 @@ Use the [Symbol Column](#data) and [Fill Column](#data) options to select column used to differentiate points in the visualization. ## Scatter controls -To view **Scatter** controls, click the settings icon ({{< icon "gear" >}}) next -to the visualization dropdown in the upper right. +To view **Scatter** controls, click **{{< icon "gear" >}} Customize** next to +the visualization dropdown. ###### Data - **Symbol Column**: Define a column containing values that should be differentiated with symbols. diff --git a/content/v2.0/visualize-data/visualization-types/single-stat.md b/content/v2.0/visualize-data/visualization-types/single-stat.md index 10c49e303..94ccf7bd7 100644 --- a/content/v2.0/visualize-data/visualization-types/single-stat.md +++ b/content/v2.0/visualize-data/visualization-types/single-stat.md @@ -30,8 +30,8 @@ For consistent results, the Single Stat query should return a single table. {{% /note %}} ## Single Stat Controls -To view **Single Stat** controls, click the settings icon ({{< icon "gear" >}}) -next to the visualization dropdown in the upper right. +To view **Single Stat** controls, click **{{< icon "gear" >}} Customize** next to +the visualization dropdown. - **Prefix**: Prefix to be added to the single stat. - **Suffix**: Suffix to be added to the single stat. diff --git a/content/v2.0/visualize-data/visualization-types/table.md b/content/v2.0/visualize-data/visualization-types/table.md index d38254257..f836ffcd8 100644 --- a/content/v2.0/visualize-data/visualization-types/table.md +++ b/content/v2.0/visualize-data/visualization-types/table.md @@ -27,8 +27,8 @@ Select other output tables in the far left column of the table visualization. Tables are identified by their [group key](/v2.0/query-data/get-started/#group-keys). ## Table Controls -To view **Table** controls, click the settings icon ({{< icon "gear" >}}) next to -the visualization dropdown in the upper right. +To view **Table** controls, click **{{< icon "gear" >}} Customize** next to +the visualization dropdown. - **Default Sort Field**: Select the default sort field. Default is **time**. - **Time Format**: Select the time format. Options include: diff --git a/content/v2.0/write-data/_index.md b/content/v2.0/write-data/_index.md index 76b8900ed..34ab545b4 100644 --- a/content/v2.0/write-data/_index.md +++ b/content/v2.0/write-data/_index.md @@ -82,9 +82,10 @@ To write data into InfluxDB, use one of the following methods: To quickly start writing data, use the provided user interface. 1. Do one of the following: - - _InfluxDB 2.0 OSS users_: - In your terminal, run `influxd` and then in your browser, go to the location where you're hosting the UI (by default, localhost:9999). - - _InfluxDB 2.0 Cloud users_: + - _**InfluxDB 2.0 OSS**_: + In your terminal, run `influxd` and then in your browser, go to the location + where you're hosting the UI (by default, **localhost:9999**). + - _**InfluxDB 2.0 Cloud**_: In your browser, go to https://cloud2.influxdata.com/. 2. Click **Load Data** in the navigation menu on the left. 3. Select **Buckets**. diff --git a/content/v2.0/write-data/use-telegraf/auto-config/_index.md b/content/v2.0/write-data/use-telegraf/auto-config/_index.md index 1bd83d4e5..3ef6d0a40 100644 --- a/content/v2.0/write-data/use-telegraf/auto-config/_index.md +++ b/content/v2.0/write-data/use-telegraf/auto-config/_index.md @@ -34,7 +34,7 @@ for using Telegraf with InfluxDB v2.0._ {{< nav-icon "load data" >}} -3. Select **Telegrafs**. +3. Select **Telegraf**. 4. Click **{{< icon "plus" >}} Create Configuration**. 5. In the **Bucket** dropdown, select the bucket where Telegraf will store collected data. 6. Select one or more of the available plugin groups and click **Continue**. @@ -59,7 +59,7 @@ for using Telegraf with InfluxDB v2.0._ If you plan to monitor a Windows host using the System plugin, you must complete the following steps. -1. In the list of Telegraf configurations, double-click your +1. In the list of Telegraf configurations, double-click your Telegraf configuration, and then click **Download Config**. 2. Open the downloaded Telegraf configuration file and replace the `[[inputs.processes]]` plugin with one of the following Windows plugins, depending on your Windows configuration: @@ -109,7 +109,7 @@ $env:INFLUX_TOKEN = “YourAuthenticationToken" {{% code-tab-content %}} ```sh -set INFLUX_TOKEN=YourAuthenticationToken +set INFLUX_TOKEN=YourAuthenticationToken # Make sure to include a space character at the end of this command. ``` {{% /code-tab-content %}} diff --git a/layouts/shortcodes/icon.html b/layouts/shortcodes/icon.html index 6016f819d..f8949e2ad 100644 --- a/layouts/shortcodes/icon.html +++ b/layouts/shortcodes/icon.html @@ -60,6 +60,8 @@ {{ else if eq $icon "add-label" }} -{{ else if eq $icon "toggle" }} - +{{ else if or (eq $icon "toggle") (eq $icon "toggle-blue") }} + +{{ else if eq $icon "toggle-green" }} + {{ end }} diff --git a/static/img/2-0-controls-dark-light-mode.png b/static/img/2-0-controls-dark-light-mode.png new file mode 100644 index 000000000..8e699ef57 Binary files /dev/null and b/static/img/2-0-controls-dark-light-mode.png differ diff --git a/static/img/2-0-templates-type-select.png b/static/img/2-0-templates-type-select.png new file mode 100644 index 000000000..8055e87a2 Binary files /dev/null and b/static/img/2-0-templates-type-select.png differ diff --git a/static/img/2-0-visualization-dropdown.png b/static/img/2-0-visualization-dropdown.png index 8db9705b1..5dd1ae686 100644 Binary files a/static/img/2-0-visualization-dropdown.png and b/static/img/2-0-visualization-dropdown.png differ diff --git a/static/img/2-0-visualizations-guage-pressure.png b/static/img/2-0-visualizations-guage-pressure.png index f8fc4eed0..e75c53983 100644 Binary files a/static/img/2-0-visualizations-guage-pressure.png and b/static/img/2-0-visualizations-guage-pressure.png differ diff --git a/static/img/2-0-visualizations-heatmap-correlation.png b/static/img/2-0-visualizations-heatmap-correlation.png index 077024fd3..945e678fa 100644 Binary files a/static/img/2-0-visualizations-heatmap-correlation.png and b/static/img/2-0-visualizations-heatmap-correlation.png differ diff --git a/static/img/2-0-visualizations-histogram-errors.png b/static/img/2-0-visualizations-histogram-errors.png index 230b7f17e..77055b353 100644 Binary files a/static/img/2-0-visualizations-histogram-errors.png and b/static/img/2-0-visualizations-histogram-errors.png differ diff --git a/static/img/2-0-visualizations-scatter-correlation.png b/static/img/2-0-visualizations-scatter-correlation.png index a85639260..e1b3df197 100644 Binary files a/static/img/2-0-visualizations-scatter-correlation.png and b/static/img/2-0-visualizations-scatter-correlation.png differ