Dashboard Charts

Introduction

The Panel platform dashboard allows you to create multiple dashboards and assign them to roles. If a user is a member of multiple roles their dashboard modules will be concatenated on the page. Dashboard modules have customizable settings based on the module type. Most dashboard types can also be customized to display in half the page width or full-width.

Often a dashboard will have a single module type repeated multiple times with different configurations. e.g. History charting might be used once to show recent sync errors, and again to show password reset history. Because most dashboard types use long-polling to refresh themselves, it is a good idea to keep the number of dashboard modules per role down to a moderate number (such as ten or fewer), to reduce server load.

Dashboard

The following dashboard modules are available:

Chart Module

The History Charts Display module allows is a highly customizable charting module which aggregates history counters. Examples of chartable events include sync operations, like adds, updates, deletes, and errors, attribute changes, workflow and health check operations, password resets, etc.

Chart

Chart Interactivity

Each datapoint on a chart is hover-able and clickable. Hovering over a point displays the name of the data series, the exact count, and the time span the count aggregates across. Clicking on a datapoint will open the History panel in a new tab. The History panel will be pre-filtered to the exact run history records that were aggregated to produce the chart datapoint.

The chart module does not auto-refresh it's results. To update the chart you must refresh the page.

Editing

Chart settings are divided into three sections:

Filtering

Use the filtering options to select the history records to aggregate in your chart. The Provider, History Type, Argument, and Result filters offer the same options as History display, which lets you preview the types of results which will be included.

Time Range

The time range gives the interval per data point, and the overall range of the chart.

The Interval, From, and To times all include both a quantity and a unit.

You may leave the interval blank and one will be calculated which is appropriate for the time range.

The From and To times are calculated as an offset from the present. If the From time is more than a week in the past, the time will be rounded to the beginning of the day.

If you leave the To field blank, the current time will be used.

Series The data series choice should have one entry for each line on the chart. The data series must be given a name and a color, and should have one or more chart counters selected. If you put multiple counters in one line, they will be summed together.

Additional Notes

Due to the range of possible options, creating a useful chart requires some thought. Here are some additional considerations:

  • If the chart is intended to show trend data the time range must show enough history to be meaningful, and the aggregation interval must be large enough to smooth out the spikes from your schedule interval (typically at least a day). If the time interval is less than 24 hours and covers more than a week or two, the chart is usually too jagged to be helpful. Shorter intervals can still be helpful, but typically only for charts that show the most recent couple days, and are intended to reveal sudden spikes in change counts.
  • Counters should be selected so that different data-series in the same chart have appropriate magnitudes. For example, if your environment typically has several hundred updates per day, and only few couple errors, then if both updates and errors are placed in the same chart, the error series will just look like a flat line at the bottom.
  • In most cases relative dates will be more useful than absolute dates for charts. An absolute dates chart may be created as a reference, e.g. to compare change counts in different months or quarters.
  • The distinction between Full and Half size charts disappears on many mobile devices. Below a certain screen or browser size all charts are displayed full-width.
  • When using relative time offsets, the browser calculates the offset relative to the current time (e.g. 3 weeks ago at 2:31:05 PM). On the server, if the offset is more than a week in the past, the server will justify the timestamp to 12:00 AM local time.

History Module

The history module lets you configure a pre-filtered history table to show recent operations.

History Dashboard Module

The history module supports essentially the same filtering settings as a history health check, or the history browser interface. This includes:

  • Provider
  • History Type
  • Argument
  • Result
  • Counters

The history module always displays the most recent ten entries matching the provided filters. The history module auto-refreshes itself every 30 seconds.

Health Check Module

The health check module displays the most recent health check results. It auto-refreshes itself once per minute.

Health Check Module

To create a health check module you must select the name of the configured health check. The health check will not be available to select unless it has been executed by Panel Service at least once.

Panel Tools Module

The Panel Tools module shows the last 24 hours of console output from Panel Tools and Panel Service. The Panel Tools module uses long-polling to refresh in real-time. To view output from multiple servers, you may create multiple instances of the module, or combine multiple servers into a single instance.

Panel Tools Module

After adding the Panel Tools module, you must give the instance a name, and must expand the strip to select which server(s) to show output from.

Panel Tools Settings

Schedules Module

The Schedules module shows the current status of operating schedules, may be used to pause and continue running schedules, and may be used to add schedules to the queue. See Scheduler

Schedule Module

The only required configuration is a header name.

Copyright © SoftwareIDM

Table of Contents