This the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

  • 1:
    • 2:
      • 2.1:
        • 2.2:
          • 2.3:
            • 2.4:
              • 2.5:
                • 2.6:
                • 3:
                  • 3.1:
                    • 3.2:
                      • 3.3:
                        • 3.4:
                          • 3.5:

                          Configure Panels

                          Learn more about types, creating, and managing panels in the following sections:

                          1 -

                          Create a New Panel

                          Sysdig Monitor supports both form-based and PromQL-based queries. You simply run a query and Sysdig Monitor builds a Dashboard that you can customize according to your preferences.

                          To create a new panel, you can do one of the following:

                          • Create a new dashboard.

                            When you create a new dashboard, it opens to a pre-built panel. You can run a new query and build the dashboard.

                          • Use a dashboard template.

                            Dashboard templates are essentially immutable dashboards that can’t be edited, and the scope is fixed. You can copy them and customize as desired. See Dashboard Templates.

                          • Add a new panel to an existing dashboard.

                          To create a new panel:

                          1. On the Dashboard tab, select the relevant dashboard from the drop-down.

                          2. Click the Add Panel icon.

                            The default panel editor opens up.

                          3. Set up the panel:

                            1. Build either a form-based query or a PromQL-based query.

                            2. Define right and left Y-axes.

                            3. Define the legend.

                            4. Set up Panel title and description.

                          4. Click Save to save the changes.

                          Building a Form-Based Query

                          Each type of visualization has different settings and the query fields are determined by the type. For demonstration purposes, this topic explains the steps to create a Line chart.

                          1. On the Dashboards tab, click Add dashboard.

                            Clicking the (+) icon opens a default panel editor.

                          2. Select a visualization type.

                            1. Click the Timechart tab and open the Select Visualization page.

                            2. Click the desired visualization type.

                            For more information on types of visualization, see Types of Panels.

                          3. Select the appropriate time presets from the time navigation.

                          4. Select a metric from the drop-down as follows:

                            You can either scroll down or type the first few letters of the metrics. As you enter the first few letters the drop-down lists the matching entries.

                          5. Specify Time Aggregation and Group Rollup.

                          6. Specify the display text in the Display field.

                            The text appears as a title for the legend:

                          7. Specify an appropriate segmentation:

                            You can enter the number of entities and the order in which they are displayed in the legend.

                            Not applicable to Number panels.

                          8. Specify the scope for the panel you are creating.

                            You can either choose to inherit the dashboard scope as it is or apply the scope to one or all the queries.

                          9. Specify the unit of scale and the display format for Y-Axis.

                            Applicable only to Timeseries panels.

                          10. Determine how to display null data on the dashboard.

                            You can display no data as a gap, a zero value, a dotted line, or a solid line in the graph. See Display Missing Data.

                          11. Optionally, compare the data against historical data.

                            When segmentation is applied, comparing metrics against historical data is not supported.

                          Building a PromQL Query

                          To run a PromQL query:

                          1. Do one of the following:

                            • Click Add Dashboard if you are creating a new dashboard.

                            • Click Add Panel if you are adding a new panel to an existing Dashboard.

                          2. Click the PromQL button.

                            The PromQL panel appears.

                          3. Enter the query in the PromQL field as follows:

                            In this example, the rate of memory heaps released in bytes in an interval of 5 minutes is calculated and then the total rate is calculated in each Kubernetes cluster.

                          4. Select the desired time window.

                          5. Specify a descriptive title for the legend and a name for the time series.

                            You can specify a variable as shown in the image. The variable name is replaced with the Kubernetes cluster names in the legend.

                          6. Specify the unit for incoming data and how it should be displayed.

                            For example, you can specify the incoming data to be gathered in kilobytes and displayed as megabytes.

                            Also, determine the location of the Y-Axis on the graph. When you have additional queries, the flexibility to place an additional Y-axis on the graph comes in handy.

                          7. Determine how to display null data on the dashboard.

                            You can display no data as a gap, a zero value, a dotted line, or a solid line in the graph. See Display Missing Data.

                          8. Click Save to save the changes.

                          2 -

                          Types of Panels

                          This topic introduces you to the types of panels in the New Dashboard.

                          2.1 -

                          Timechart Panel

                          A Timechart is a graph produced by applying statistical aggregation to a label over an interval. The X-axis of a timechart will always be time.

                          Timecharts allow you to see the change in metric value over time. The amount of data visualized on a graph is dependent on the time selection selected within the Dashboard. You can aggregate metrics from multiple sources into a single line, or graph a line per combination of segment labels.

                          Time aggregation: For example, the average value of cpu.used.percent metric is computed for each entity over 1 hour at 1-minute intervals.

                          Group Rollup: For each host.hostName the values from time aggregation are averaged over the scope and the top 10 segments are shown on the chart.

                          The only supported panel type now in time series is the Line chart.

                          Line Chart

                          The Line panel show change over time in a selected window. Time is plotted on the horizontal axis and the change that is measured is plotted on the vertical axis.

                          The image below shows the trend of resource consumption of top resource-hogging hosts in the last one hour.

                          Configure Line Chart

                          For information on configuring a chart, see Create a New Panel.

                          Stacked Area

                          An area chart is distinguished from a line chart by the addition of shading between lines.

                          For information on configuring a chart, see Create a New Panel.

                          2.2 -

                          Number Panel

                          Number panels allow you to view a single value for a given entity, along with optionally comparing the current value to historical values. Use the Number panel when the number is the most important aspect of the metric you’re trying to display, such as unique visitors to a website.

                          Do not use this panel to see a trend, rather use it when you need to see the average of a value over the given time range. This is also useful for counting entities, such as the number of nodes in a cluster.

                          For information on configuring a panel, see Create a New Panel.

                          Major Features

                          • The default preset for the Number visualization is 1 hour.

                          • The global default values for the threshold are overridable. The new value can be reset back to the global default.

                          • A comparison between two threshold values determines color-coding directions.

                          • Use the No Data Display text box under the Options menu to set a custom no data text.

                          • The Compare To functionality can be toggled between enabled and disabled.

                          • When the Compare To value is set, the preview is updated accordingly showing the comparison value and an arrow denoting the metric has increased or decreased.

                          • The unit displayed for Thresholds is determined by the query.

                          2.3 -

                          Table Panel

                          The Table panel displays metric data in tabular form. In this view, you can review metric values and their associated labels in a single view. Use Table panels for such quantitative analysis where you can see actual values instead of visual representations. Similar to a spreadsheet, you can look at a combination of metric values and their segments. This is useful when you don’t necessarily care about the change in metric over time, or want to run reports to download as CSV/JSON for offline analysis.

                          The panel displays the value returned by the metric query specified in the Query tab. The value is determined by the data source and the query. Each datapoint will have an associated raw and an option to add columns for additional metric values.

                          Configuring Table Panel

                          Major features include but not limited to :

                          • Queries

                            • The first query you build cannot be removed.

                            • With subsequent queries are built, you cannot remove all the queries except the first one.

                            • Changing the unit of the query changes the unit in the table as well.

                            • Changing the display format on the query reflects on the row values.

                          • Segmentation

                            • The segmentation label determines the column name.

                            • The segmentation in conjunction with metric values determines the values displayed on the rows.

                          • Scope

                            • The selected scope determines the values displayed on the table.
                          • Metric / Labels Columns

                            • Adding a new query insert a new column with the name of the metric as the column heading.

                            • Metric values in conjunction with segmentation determine the values displayed on the rows.

                          • Sorting

                            • Column sorting is based on the selected column header and the type of sorting (ascending and descending).

                            • When another column is sorted, the table is resorted by that column, resetting the previous sorting.

                          • Resizing

                            • Grab the header column by the borderline to resize the columns.

                            • Browser window resizes shouldn’t reset the resize of the columns if you have resized any columns.

                            • When resizing the browser window, table columns are resized to cover the full width. An exception is when you have already resized columns. In such cases, other columns that you have not resized are resized on browser window resize.

                            • The last column in the table is not resizable.

                          • Export

                            • The table by default shows a maximum of 50 rows.

                            • Clicking on Export all results… below the table opens the Export Data window.

                            • Export data in either JSON or CVS format to a file. The default name of the file is the panel name. Renaming the default filename is permissible.

                          For information on configuring a chart, see Create a New Panel.

                          2.4 -

                          Text

                          The example below uses a text panel as a reminder list of the testing steps for a procedure.

                          Text Panel Markdown

                          Headers

                          # H1
                          ## H2
                          ### H3
                          #### H4
                          ##### H5
                          ###### H6
                          
                          H1
                          ======
                          H2
                          ------
                          

                          Emphasis

                          *italics* or _italics_
                          **bold** or __bold__
                          **combined _emphasis_**
                          ~~strikethrough~~
                          

                          Lists

                          1. First ordered list item
                          2. Second item
                            * Unordered sub-list.
                              Sub-paragraph within the list item.
                          1. Third item
                            8. First ordered sub-list item.
                          103. Fourth item
                          

                          General guidelines:

                          • The list item number does not matter. As shown in the example below, the formatting defines the lists.

                          • List items can contain properly indented paragraphs, using white space.

                          • Unordered list can use: *, -, or +.

                          Linebreaks

                          This is the first sentence.
                          
                          This line is separated from the one above by two newlines, so it will be a *separate paragraph*.
                          
                          This line is also a separate paragraph.
                          This line is only separated by a single newline, so it's a separate line in the *same paragraph*.
                          

                          Trailing spaces can be used for line-breaks without creating a new paragraph. This behavior is contrary to the typical GFM line break behavior, where trailing spaces are not required.

                          2.5 -

                          Toplist

                          A Toplist chart displays the specified number of entities, such as containers, with the most or least of any metric value. This is useful for “ranking” metric values in order, for example, considering hosts that have the highest amount of pods running or the highest consumers of CPU or memory in your infrastructure.

                          The following types of metric segmentation are supported:

                          Major Features

                          • Toplist supports executing only one query, however, adding a new one and deleting the existing one is allowed.

                          • Segmentation is not supported for multiple metrics.

                          • Text displayed on the bars in the chart is based on metrics and segmentation.

                            • If a single metric is selected, segmentation text is displayed.

                            • If multiple segmentations are selected, segmentation texts separated by > sign are displayed.

                            • If multiple metrics are selected, the metric name is displayed.

                          Segmentation

                          The following types of metric segmentation are supported:

                          Multi-Segmenting Single Metrics

                          You can use multiple objects to simultaneously segment a single metric. For example, cpu.used.percent segmented by kubernetes.cluster.name, kubernetes.namespace.name, and kubernetes.deployment.name.

                          In this example, deployments are sequentially listed in the order of resource consumption. Use Display to toggle between descending (Top) and ascending order (Bottom).

                          Multi-Metrics Without Segmentation

                          You can add multiple metrics to view the Toplist chart. However, segmentation is disabled for multi-metric selection.

                          For information on configuring a chart, see Create a New Panel.

                          2.6 -

                          Histogram

                          Sysdig Monitor handles three types of Histograms:

                          • Histogram panel type on the Dashboard: Histogram panels allow you to visualize the distribution of metric values for large data collection. You should select a segmentation, and optionally, the number of buckets.

                            Use Histogram for any metric, Sysdig native or custom, counter or gauge, segmented by a dimension/label. The histogram panel helps understand value across different segments. For example, CPU usage percent by pods across your cluster gives you the aggregated value across the selected time.

                          • Legacy Prometheus histogram collection: This implementation of legacy Prometheus Histograms is deprecated in SaaS 3.2.6 release.

                            To create a Histogram, use the Prometheus integration to collect histogram metrics and use the PromQL panel with the histogram_quantile function.

                          • Prometheus histograms (collected as raw metrics): The legacy Prometheus histogram collection is replaced by the new Prometheus histogram. You can natively collect histogram metrics, and for visualization, use timechart:

                            For example, run the following query to build a timechart:

                            sum(histogram_metrics_bucket{kubernetes_cluster_name="prod"}) by (le)
                            
                            

                          3.1 -

                          Create Panel Alerts

                          Alerts can be created directly from a form-based panel in a New Dashboard. If the panel has more than one query, you must select the query to use as the base for the alert.

                          To create an alert:

                          1. Click the More Options (three dots) icon.

                          2. Select Create Alert.

                          3. Configure the alert, and click the **Create **button.

                          3.2 -

                          Export Panel Data

                          Table and Timechart panels in New Dashboard allow exporting data to a CSV or JSON file. This file could serve as a backup of your data or for programmatical use.

                          You can export data using the following:

                          • Panel menu in the New Dashboard

                          • Table panel

                          To export while creating or editing a Table panel:

                          1. Select Table from the Visualization type.

                            The panel opens to the Columns tab.

                          2. Below the table, click Export all results….

                            The Export Data window is displayed.

                          3. Select the format.

                          4. Specify a filename.

                            The default name of the file is the panel name. You can rename the file that you are about to download.

                          5. Click Export to save the data into the file.

                            Exporting might take several minutes to complete.

                          3.3 -

                          Copy Panels to a Different Dashboards

                          Copy a Single Panel

                          To copy a single panel to a different dashboard:

                          1. From the Explore tab, select the desired drill-down view.

                          2. Hover over the desired panel, select the Settings (ellipsis) icon, and select Copy Panel.

                          3. Open the drop-down menu and select the desired dashboard, or use the text-field to search through existing dashboards.

                            To copy the panel to a new dashboard, enter a name for the new dashboard in the text-field instead.

                          4. Click the Copy and Open button to save the changes and navigate to the configured dashboard.

                          Copy All Panels

                          To copy all panels in a drill-down view to a dashboard:

                          1. From the Explore tab, select the desired drill-down view.

                          2. Select the More Options (three dots) icon.

                          3. Select Copy to Dashboard:

                          4. Open the drop-down menu and select the desired dashboard, or use the text-field to search through existing dashboards.

                            To copy the panel to a new dashboard, enter a name for the new dashboard in the text-field instead.

                          5. Click the Copy and Open button to save the changes and navigate to the configured dashboard.

                          Create a Panel Alert

                          Alerts can be created directly from a dashboard panel:

                          1. Click the More Options (three dots) icon.

                          2. Select CreateAlert.

                          3. Configure the alert, and click the Create button.

                          3.4 -

                          Duplicate a Panel

                          Hover over the desired panel, click the Settings (ellipsis) icon, and select Duplicate Panel.

                          3.5 -

                          Delete an Existing Panel

                          To delete a panel from a dashboard:

                          1. Hover over the desired panel, click the Settings (ellipsis) icon, and select Delete Panel.

                          2. Click the Yes, delete panel button to confirm, or the Cancel button to keep the panel.