diff options
Diffstat (limited to 'docs/dashboard')
-rw-r--r-- | docs/dashboard/dashboards-tab.md | 96 | ||||
-rw-r--r-- | docs/dashboard/home-tab.md | 2 | ||||
-rw-r--r-- | docs/dashboard/logs-tab.md | 16 | ||||
-rw-r--r-- | docs/dashboard/metrics-tab-and-single-node-tabs.md | 25 | ||||
-rw-r--r-- | docs/dashboard/nodes-tab.md | 57 |
5 files changed, 195 insertions, 1 deletions
diff --git a/docs/dashboard/dashboards-tab.md b/docs/dashboard/dashboards-tab.md new file mode 100644 index 0000000000..b890c04d77 --- /dev/null +++ b/docs/dashboard/dashboards-tab.md @@ -0,0 +1,96 @@ +# Dashboards tab + +With Netdata Cloud, you can build **custom dashboards** that target your infrastructure's unique needs. Put key metrics from any number of distributed systems in one place for a bird's eye view of your infrastructure. + +Click on the **Dashboards** tab in any War Room to get started. + +## Create your first dashboard + +From the Dashboards tab, click on the **+** button. + +In the modal, give your custom dashboard a name, and click **+ Add**. + +- The **Add Chart** button on the top right of the interface adds your first chart card. From the dropdown, select either **All Nodes** or a specific node. + + Next, select the context. You'll see a preview of the chart before you finish adding it. In this modal you can also [interact with the chart](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md), meaning you can configure all the aspects of the [NIDL framework](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#nidl-framework) of the chart and more in detail, you can: + - define which `group by` method to use + - select the aggregation function over the data source + - select nodes + - select instances + - select dimensions + - select labels + - select the aggregation function over time + + After you are done configuring the chart, you can also change the type of the chart from the right hand side of the [Title bar](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#title-bar), and select which of the final dimensions you want to be visible and in what order, from the [Dimensions bar](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#dimensions-bar). + +- The **Add Text** button on the top right of the interface creates a new card with user-defined text, which you can use to describe or document a particular dashboard's meaning and purpose. + +> ### Important +> +> Be sure to click the **Save** button any time you make changes to your dashboard. + +## Using your dashboard + +Dashboards are designed to be interactive and flexible so you can design them to your needs. They are made from any number of charts and cards, which can contain charts or text. + +### Charts + +The charts you add to any dashboard are [fully interactive](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md), just like any other Netdata chart. You can zoom in and out, highlight timeframes, and more. + +Charts also synchronize as you interact with them, even across contexts _or_ nodes. + +### Text cards + +You can use text cards as notes to explain to other members of the [War Room](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/organize-your-infrastrucutre-invite-your-team.md#netdata-cloud-war-rooms) the purpose of the dashboard's arrangement. + +By clicking the `T` icon on the text box, you can switch between font sizes. + +### Move elements + +To move a chart or a card, click and hold on **Drag & drop** at the top right of each element and drag it to a new location. A green placeholder indicates the +new location. Once you release your mouse, other elements re-sort to the grid system automatically. + +### Resize elements + +To resize any element on a dashboard, click on the bottom-right corner and drag it to its new size. Other elements re-sort to the grid system automatically. + +### Go to chart + +Quickly jump to the location of the chart in either the [Metrics tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/metrics-tab-and-single-node-tabs.md) or if the chart refers to a single node, its single node dashboard by clicking the 3-dot icon in the corner of any chart to open a menu. Hit the **Go to Chart** item. + +You'll land directly on that chart of interest, but you can now scroll up and down to correlate your findings with other +charts. Of course, you can continue to zoom, highlight, and pan through time just as you're used to with Netdata Charts. + +### Rename a chart + +Using the 3-dot icon in the corner of any chart, you can rename it to better explain your use case or the visualization settings you've chosen for the chart. + +### Remove an individual element + +Click on the 3-dot icon in the corner of any card to open a menu. Click the **Remove** item to remove the card. + +## Managing your dashboard + +To see dashboards associated with the current War Room, click the **Dashboards** tab in any War Room. You can select dashboards and delete them using the 🗑️ icon. + +### Update/save a dashboard + +If you've made changes to a dashboard, such as adding or moving elements, the **Save** button is enabled. Click it to save your most recent changes. + +Any other members of the War Room will be able to see these changes the next time they load this dashboard. + +If multiple users attempt to make concurrent changes to the same dashboard, the second user who hits Save will be +prompted to either overwrite the dashboard or reload to see the most recent changes. + +### Delete a dashboard + +Delete any dashboard by navigating to it and clicking the **Delete** button. This will remove this entry from the +dropdown for every member of this War Room. + +### Minimum browser viewport + +Because of the visual complexity of individual charts, dashboards require a minimum browser viewport of 800px. + +## What's next? + +Once you've designed a dashboard or two, make sure to [invite your team](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/organize-your-infrastrucutre-invite-your-team.md#invite-your-team) if you haven't already. You can add these new users to the same War Room to let them see the same dashboards without any effort. diff --git a/docs/dashboard/home-tab.md b/docs/dashboard/home-tab.md index 86433e534c..6483b10721 100644 --- a/docs/dashboard/home-tab.md +++ b/docs/dashboard/home-tab.md @@ -1,4 +1,4 @@ -# Home Tab +# Home tab The Home tab allows users to see an overview of their Room. diff --git a/docs/dashboard/logs-tab.md b/docs/dashboard/logs-tab.md new file mode 100644 index 0000000000..c51822ff36 --- /dev/null +++ b/docs/dashboard/logs-tab.md @@ -0,0 +1,16 @@ +# Logs tab + +The Logs tab is using the [`systemd` journal plugin](https://github.com/netdata/netdata/blob/master/src/collectors/systemd-journal.plugin/README.md), to present a structured view into your infrastructure's `systemd` logs. + +We have a thorough section explaining how you can [work with logs](https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/logs.md), detailing how the plugin works, and what other utilities are used under the hood to provide you with the visualizations and the log entries. + +The [`systemd` journal plugin](https://github.com/netdata/netdata/blob/master/src/collectors/systemd-journal.plugin/README.md) documentation has information about: + +- [Key features the plugin provides](https://github.com/netdata/netdata/blob/master/src/collectors/systemd-journal.plugin/README.md#key-features) +- [Journal sources](https://github.com/netdata/netdata/blob/master/src/collectors/systemd-journal.plugin/README.md#journal-sources) +- [Journal fields](https://github.com/netdata/netdata/blob/master/src/collectors/systemd-journal.plugin/README.md#journal-fields) +- [Full-text search](https://github.com/netdata/netdata/blob/master/src/collectors/systemd-journal.plugin/README.md#full-text-search) +- [Query performance](https://github.com/netdata/netdata/blob/master/src/collectors/systemd-journal.plugin/README.md#query-performance) +- [Performance at scale](https://github.com/netdata/netdata/blob/master/src/collectors/systemd-journal.plugin/README.md#performance-at-scale) + +We recommend you to read through that document, to better understand how the plugin and the visualizations work. diff --git a/docs/dashboard/metrics-tab-and-single-node-tabs.md b/docs/dashboard/metrics-tab-and-single-node-tabs.md new file mode 100644 index 0000000000..95a0c215d2 --- /dev/null +++ b/docs/dashboard/metrics-tab-and-single-node-tabs.md @@ -0,0 +1,25 @@ +# Metrics tab and single node tabs + +The Metrics tab is where all the time series [charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) for all the nodes of a War Room are located. + +You can also see single-node dashboards, essentially the same dashboard the Metrics tab offers but only for one node. They are reached from most places in the UI, often by clicking the name of a node. + +From this tab, a user can also reach the Integrations tab and run [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) + +## Dashboard structure + +The dashboard consists of various charts presented in different chart types. They are categorized based on their [context](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#contexts) and at the beginning of each section, there is a predefined arrangement of charts helping you to get an overview for that particular section. + +## Chart navigation Menu + +On the right-hand side, there is a bar that: + +- Allows for quick navigation through the sections of the dashboard +- Provides a filtering mechanism that can filter charts by: + - Host labels + - Node status + - Netdata version + - Individual nodes +- Presents the active alerts for the War Room + +From this bar you can also view the maximum chart anomaly rate on each menu section by clicking the `AR%` button. diff --git a/docs/dashboard/nodes-tab.md b/docs/dashboard/nodes-tab.md new file mode 100644 index 0000000000..668af0843d --- /dev/null +++ b/docs/dashboard/nodes-tab.md @@ -0,0 +1,57 @@ +# Nodes tab + +The nodes tab provides a summarized view of your [War Room](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/organize-your-infrastrucutre-invite-your-team.md#netdata-cloud-war-rooms), allowing you to view quick information per node. + +> **Tip** +> +> Keep in mind that all configurations mentioned below are persistent and visible across all users. + +## Center information view + +The center information view consists of one row per node, and can be configured and filtered by the user. + +### Filtering and adjusting the view + +In the top right-hand corner, you can: + +- Order the nodes per status or per alert status +- Select which charts you want to be displayed as quick reference points + +### Node row + +Each node row allows you to: + +- View the node's status +- Go to a single node dashboard, by clicking the node name +- View information about the node, along with a button to display more in the right-hand sidebar +- View active alerts for the node +- View Machine Learning status +- View Functions capability status +- Add configuration (beta) +- [Add alert silencing rules](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-alert-notification-silencing-rules.md) +- View a set of key attributes collected on your node + +## Right bar + +The bar on the right-hand side provides additional information about the nodes in the War Room and allows you to filter what is displayed in the [center information view](#center-information-view). + +### Node hierarchy + +The first tab displays a hierarchy of the nodes displayed, making it easy to find a specific node by name. It follows the ordering that the user has selected. + +### Filters sub-tab + +The second tab allows you to filter which nodes are displayed, you can filter by: + +- Host labels +- Node status +- Netdata version +- Individual nodes + +### Alerts sub-tab + +The third tab displays room alerts and allows you to see additional information about each alert. + +### Info sub-tab + +The last tab presents information about a node, by clicking the `i` icon from a node's row, right next to its name. |