The Performance Reports Designer

If you do not have the QoS Access permission set in the ACL, you will see a "Permission Denied" message when you try to run the Performance Reports Designer application.
uim851
Graphing_QoS_Measurements
The Performance Reports Designer allows you to see a visual representation of QoS data. You select the host, QoS measurement, target, and time range, and the data is displayed as a chart. You can display multiple measurements on a single chart, and can view multiple charts at a time. You can drag charts between rows or can drag a data series from one chart to another. You can select the chart format (line, area, or column chart), and the Filters tab allows you to plot only the data that matches specified filters on the chart. You can easily change the source (host or target) of the data by using the Choose Source menu. You can save a set of charts as a report to print or to view later. The import and export features allow you to share charts with other users.
If you do not have the QoS Access permission set in the ACL, you will see a "Permission Denied" message when you try to run the Performance Reports Designer application.
Contents
Understanding Performance Data
Performance Reports Designer can use either raw (unintervalized) or intervalized data. For intervalized data, a data aggregation interval is automatically selected based on the scale of the chart you are viewing. You can also choose an aggregation interval for the chart. Possible intervals range from one minute to one day.
The unintervalized data option ("none") replaces the raw data option in Performance Reports Designer in CA UIM 8.47 and later.
 
For an automatically selected interval, the timeframe of the data and resolution of your screen affects the scale. Performance Reports Designer selects the smallest aggregation interval so that there is only one data point per pixel. If there are multiple data samples for an interval, the values are averaged. For example, if the data is sampled every 5 minutes but the Performance Reports Designer chart is displaying 15-minute intervals, there are three data samples per interval. In this case, the average of the three data samples is displayed in the chart.
You can view the minimum and maximum values used in calculating each average by selecting the
USM line chart
format (USMLineChart.png) for any data series in a chart. The shaded area above and below the line shows the range of values used in calculating the average. A pop-up tooltip appears when you hover over a data point on the line, displaying the minimum and maximum values averaged for that point.
If there are fewer data samples than intervals, Performance Reports Designer displays interpolated data. For example, if the data is sampled every 15 minutes but Performance Reports Designer is displaying 5-minute intervals, two of the three data points for each interval are interpolated. If data is interpolated, when you mouse over a data point in the chart, the data tooltip labels the number as
Estimate
rather than
Value
. If you stack multiple data series on a bar chart and one data series has fewer data samples, you see shadow columns for interpolated data: this allows you to stack a denser data series on top of a sparser one.
For bar charts, each column displays data for five times the interval for the chart. For example, if the chart is using 1-minute intervals, each column represents 5 minutes.
If data is missing, it is not estimated. The chart will display a gap where missing data occurs.
You can export either unintervalized data or intervalized data for Performance Reports to a CSV file.
Selecting a Data Aggregation Interval
You can accept the default data aggregation interval for a chart or select a different interval from a menu. On creating a new chart, the lower-left corner will show the current data aggregation interval. The default data aggregation setting is Automatic, resulting in an aggregation interval based on the report time frame and the width of the window in your browser. You can select a different interval from the pull-down menu. Options range from one minute to one day and
None
. The
None
option indicates that no aggregation is applied and all performance data is displayed in the chart.
All series in a chart and all charts in the report use the selected aggregation interval. If you change the aggregation interval for a report, all charts and data series inherit the new interval.
The following conditions apply to data aggregation intervals for a Performance Report:
  • Multiple unintervalized data series for a chart cannot be stacked (summed). The
    Stacked
    option in the
    Configuration
    (1736612.gif) menu at the upper left will be greyed out if the
    None
    intervalization option is selected.
  • A new chart in a report will inherit the existing data aggregation interval.
  • The selected data aggregation interval for charts is saved in the performance report.
  • When exporting chart data to a CSV file, you can save the unintervalized data for the report or save only data for the selected aggregation interval.
Report Scheduler honors the interval in a performance report, but you can change the interval in Report Scheduler. In this way, you can produce reports with different intervals from the same file. The resulting PDF displays the interval selected.
QoS Selection Tabs
The QoS Selection tabs are where you can select the host, QoS measurement, and target you want to view data for. There are two QoS Selection tabs: the QoS Selection by Host tab and the QoS Selection by Target tab. The two tabs function the same way, but the order in which you select hosts and targets is different.
  • QoS Selection by Host
    - Use this tab to find multiple measurements from the same host
  • QoS Selection by Target
    - Use this tab to find measurements of the same type on multiple hosts
The selection panes have the following fields:
Field
Description
Host
Host name of the computer you want to chart measurements for.
QoS
Type of QoS measurement you want to chart.
Target
Which measurement, if more than one measurement for the selected QoS type is taken. For example, for CPU usage you can select Idle, System, User, Wait, or <host name>.
Work from left to right in the selection panes. Enter text in the filter field at the top of each selection pane to display only items that contain that text.
To select a measurement for charting in the QoS Selection by Host tab, for example:
  1. In the Host pane, select the host name of the computer you want to chart measurements for. Once you select the host, the QoS measurements for tests you are running on that host are listed in the QoS pane.
  2. In the QoS pane, select a QoS measurement. Once you select a QoS measurement, the available targets are listed in the Target pane.
  3. In the Target pane, select a target, then drag it to a chart pane to display it.
    You can drag multiple targets to each chart. If the targets are measured in different units, a second y-axis is added on the right side of the chart. You can add as many targets with the units on the two y-axes as you want, but you cannot add a target with different measurement units. For example, if the left y-axis represents percent and the right y-axis represents seconds, you can add an unlimited number of targets that are measured in percent or seconds but you cannot add a target that is measured in megabytes.
Filters Tab
The Filters tab is where you can create filters to narrow the data to be charted. Once you enter your filter options, check the results with the Check Filters button to see that the results are not too broad and then drag the drag bars to a chart. Charts update dynamically at a regular interval to reflect changes in the search results.
The Filters tab has the following fields:
Field or Button
Description
Name
Enter a name for the filter.
Check Filters
Displays the items that match the filter in the pane to the right. Use this to ensure the filter is narrow enough that you do not bog down your system charting a huge amount of data.
Apply
Applies changes to the filter to the currently displayed charts.
Drag bars
1736597.gif
Drag these bars to a chart to graph the results for the filter.
Add filter
1736598.gif
Click to create a new filter.
Remove filter
1736615.gif
Deletes the current filter. Visible when you have multiple filters.
Filter options
 
Use these fields to display only data from specified hosts or targets in the chart. For example, you can filter for only hosts monitoring a certain QoS measurement, or for all hosts or targets on a specified hub.
  • (blank)/not button - Click to display all items except the specified items.
  • Criterion pull-down menu - Select the item you want to filter for, such as Source, Probe, and QoS.
  • Operator pull-down menu - Choose the appropriate operator, such as 'is', 'contains', and 'starts with'.
  • Text field - Enter the appropriate text for the criterion you chose.
Add filter row
1736600.gif
Click to add another row of filter options.
Remove filter row
1736601.gif
Click to remove the row of filter options. This icon is visible if you have more than one row of filter options.
Up/down
1736602.gif/1736603.gif
Click to move the row up or down. Filter rows are applied in sequential order. These icons are visible if you have more than one row of filter options.
The following table shows how to enter special characters for each database type.
You might need to enclose the special characters '\', '%', and '
_'
in escape characters when you use basic search or advanced search or when you apply filters in USM or in PRD. In the case of advanced search and filters, this requirement applies when the
contains
,
starts with
, or
ends with
operator is selected. The required escape character depends on the type of database. For MySQL, the backslash (\) is the escape character; for MS SQL, special characters are enclosed in square brackets ([ ]). Searching for special characters is not supported for Oracle.
Character
MySQL
Oracle
MS SQL
\
\\
Not applicable
\ (No escape character required)
%
\%
Not applicable
[%]
_ (underscore)
\_
Not applicable
[_]
User Tags
You can filter on two user-defined criteria, named User Tags, in portlets that have filters. You can also automatically create groups according to User Tag.
User Tag 1
and
User Tag 2
are text fields that are defined on the robot. You can enter any text in these fields. (Use Infrastructure Manager to open the configuration window for the robot.) Once you have done so, you can filter for these values in the Unified Service Manager, Performance Reports Designer, and List Designer portlets.
For example, you could use
User Tag 1
for geographic location (such as
Europe
or
Asia
)  and
User Tag 2
for type of server (such as
production server
or
web server
). You can then create reports for your regional systems by filtering on
User Tag 1
in the Performance Reports Designer (in the
Filters
tab) or List Designer (in the filter fields of the
New Group
pane). To do so, you would set the filter to
User Tag 1 is Europe
or
User Tag 1 is Asia
.
1938170.png
In the Unified Service Manager portlet, you can create separate groups for your production servers and for your web servers and then apply different monitoring templates to them. To create the groups, in the
Filters
section of the Edit Group dialog you would set the filter to
User Tag 2 is production server
for one group and
User Tag 2 is web server
for the other group.
2025615.PNG
User Tag 1
and
User Tag 2
can be used to filter for any system that has a robot running on it. You cannot use
User Tag 1
and
User Tag 2
to filter for network devices that do not have a robot.
Charts Pane
The charts pane is where you can view the data for the selected host, QoS, and target. You can select the chart format, maximize the display, or adjust the data range for the y-axis. Hover over a data point to display information about the data in a pop-up window. You can drag charted data to move it from one chart to another. For a line chart, for example, click on a line and drag it to another chart.
To zoom in on an area of a chart, drag the cursor to select that area. Repeat to zoom in again. Click the graph to zoom out all the way. Drag the cursor to select a portion of an axis to zoom in on the selected range.
The charts have the following fields and icons at the top and upper left:
Field or Icon
Description
Title
Double-click
Title
to enter a title for the report. Type the new title and press the Enter key.
Style
1736606.gif
Click a data series in the chart, and then click the
Style
icon to apply one the following styles or remove a data series from the chart:
  • LineChart.png - Line chart
  • USMLineChart.png - USM line chart
  • 1736608.gif - Area chart
  • 1736609.gif - Column chart
  • ReportDesignerRemoveChart.png - Removes the selected data series from the chart.
Choose Source
1742561.png
Click to chart the same set of data series for another host or target.
If you have selected multiple targets for a single host (QoS Selection by Host), click this list to display a list of hosts with the same QoS measurements and targets. This option allows you to view the same set of measurements for different hosts.
If you have selected a single target for multiple hosts (QoS Selection by Target), clicking this displays a list of targets for the selected QoS measurement. This allows you to view different measurements for the same hosts.
The menu bar displays the name of the current host or target. If there are no other corresponding hosts or targets, the combo box is not displayed.
Configure
1736612.gif
Click to display a pop-up menu with the options below.
  • Stacked
    - Stacks the data series on top of each other. This option is not available for displaying unintervalized data.
  • Legend
    - Toggles the display of the legend on and off. The legend, which appears at the bottom left of the chart, displays the host/QoS/target for each data series in the chart.
  • Title
    - Adds a title to the chart. Double-click the word Title at the top of the chart, enter your text, and press the Enter key. Change the title at any time in the same way.
  • Info text
    - Adds descriptive information to the bottom of the chart. Double-click the words Info text, then enter your text.
  • Trend Line
    - Displays a trend line for the data. If you hover over a data point on the chart, the trend value for the data point is included in the tooltip.
  • Baseline
    - Displays baseline data, if available, as a dotted stair-step line. If you hover over a data point on the chart, the baseline value for the data point is included in the tooltip.
  • Percentile
    - Adds a line marking a specified percentile to the chart. Enter the percentile in the spinner box.
  • Scale
    - Adds a scale factor to the selected data series. For example, a scale of 2 doubles the values of the series. Once you select Scale from the pop-up menu, a text box is displayed on the title bar where you can enter a number for the scale factor you want.
Pop-up tool tips present relevant information on data points in the chart. So, for instance, the tool tip shows minimum and maximum values averaged for intervalized data points, and tool tips for stacked bar charts show the value of each component and its percentage of the whole.
The charts have the following icons at the upper right:
Icon
Description
Maximize/Restore
Maximize.png/Restore.png
Click to remove the data series selection pane and maximize the chart area or to restore the data series selection pane.
Export CSV data
1821940.PNG
Click to export the chart data in CSV format.  The dialog displays the number of chart series and total data points for the chart. You can select a link to copy the csv formatted chart data to the clipboard, or select a button to download and save the data.  You have the option to select an aggregation value of “None” in order to display all data points instead of the aggregated data points displayed in the chart. Please note:
  • If no aggregation interval is selected for the charts, the only option is to export the unintervalized data as it appears on the chart.
  • If the “Automatic” data aggregation is selected for the charts, the aggregation value for export is the actual calculated interval used in the chart.
  • If a different aggregation interval is required for the CSV data export, change the aggregation setting for the charts then click the export button again.
The Chart CSV Preview dialog displays the first 10 records so that you can preview the data. From the dialog options, you can save the data to a file or copy it to the clipboard.
Only actual data samples are included; interpolated data (for intervals that are missing data) are not included in the CSV file.
Generate chart URL
1821938.PNG
Click to generate a URL that can be used to display the chart from a browser without being logged into UMP. This displays the Chart URL dialog. Click the Copy to clipboard icon to save the URL to the clipboard.
Clear
1736614.gif
Clears the selected chart of data.
Remove chart
1736615.gif
If your report contains multiple rows or charts, this option deletes the chart that you select.
: Each individual item that is created with the
Add Row
icon or the
Add Chart
icon will have its own Remove chart icon. When a report contains a single row or chart, this icon clears the report data.
The charts have the following icons at the left and right sides:
Button or Icon
Description
Data range
1736616.gif
By default, the y-axis displays the range of data values plus or minus 5 percent. For example, if the data values range from 40 to 80, the y-axis displays a range of 38 to 84. However, for some data units, such as percentages, you might prefer to see the data displayed at a different scale. Click the 1736617.gif button to set the baseline of the y-axis to zero, and click the 1736613.gif button to set the top of the y-axis to 100 percent. The buttons appear next to the left or right y-axes if appropriate for the data units. If the data unit is percent, for example, the top and bottom buttons are displayed. If the data unit is megabytes, however, only the bottom data range button is present.
Page up
1736619.gif
Displays the previous page.
Move row up/Move row to previous page
1736620.gif
Moves the row up. If the row is the top row, it moves to the previous page.
Add row
1736621.gif
Adds a row of charts.
Add chart
1736622.gif
Adds a chart to the row.
Move row down/Move row to next page
1736623.gif
Moves the row down. If the row is the bottom row, it moves to the next page.
Page down
1736624.gif
Displays the next page.
Toolbar
The toolbar at the bottom of the report allows you to select the time range to display data for, view or print a report as a PDF, save a report, or view previously saved reports.
1736626.gif
Field or Button
Description
Undo/Redo
Click to undo a change you made, or to redo it after undoing it.
Time selection
Click the back or forward icons to scroll through the time selection options:
  • Start/end date fields- Useful for charting a specific time period. Click to display a calendar, where you can select the start or end time for the data you want to chart. If the end time is the current time or is in the future, the word Now is displayed in the date box and the charts are updated at 1-minute intervals.
  • Date and time sliders - Useful for browsing the same time period on different days. Set the sliders from left to right. The slider on the left lets you select the level of granularity you want (year, month, day, or hour). Once you select, the middle slider lets you select which year, month, day, or hour you want to chart. Once that is selected, the right-hand slider lets you select a period within that year, month, day, or hour. For example, if you are viewing data for 3 to 5 p.m. for the current day and want to view data for the same time the previous day, move the middle slider to the left one increment. (If you are viewing data for a specific day, the slider on the left is already set to Day.)You cannot move the sliders beyond the increment for the current time.
  • Quick View buttons - Useful for viewing data for common time intervals:
    1742534.PNG - Previous hour
    1736629.gif - Previous day
    1736630.gif - Previous week
    1736631.gif - Previous month
    The interval is a sliding window so that as time passes new values are appended and old values are dropped.
Toolbar
  • Undo.png - Undo last action
  • Redo.png - Redo last action
  • 1736632.gif - Displays the  PDF Preferences dialog, where you can select settings for viewing the report as a PDF. The PDF can be printed or saved.
  • 1736614.gif - Clears all charts of data.
  • 1736636.gif - Opens the Open dialog box, where you can import a report, open a report, or delete a previously created report.
  • PRDSaveAs.png - Opens the Save dialog box, where you can export a report, save a report under a new name, or delete a previously created report.
  • PRDSave.png - Saves changes to the current report.
  • PRDHelp.png - Opens the documentation for this portlet in a new browser window.
PDF Preferences Dialog
The PDF Preferences dialog allows you to select settings for viewing a report as a PDF. The PDF can be printed or saved.
The PDF Preferences dialog has the following fields or buttons:
Field or Button
Description
Schedule Report (Not available from List Designer)
Opens the Create New Job dialog in the Report Scheduler portlet, where you can schedule the report to be run and delivered.
Orientation pull-down menu
Choose the page orientation for the PDF: Portrait or Landscape.
Size pull-down menu
Choose the page size for the PDF.
Quality pull-down menu
Choose the level of quality for the PDF.
OK
Closes the dialog and displays the PDF.
Cancel
Click to exit the dialog without creating a PDF.
Open Views
The Open dialog box allows you to open a template to create a report, open a previously created report/view, or delete a previously created report or view.
The Open dialog has the following fields and buttons:
The name of the template or report selected in the Reports tree. If you have created a report without selecting a template or report first, this field is blank.
Field or Button
Description
Reports tree
Folders for reports and templates and the names of templates and previously saved reports. Click the pull-down arrow to open the folders and list reports.
Reports
Delete
Deletes the selected template or report.
Import
Imports a previously exported report.
Open
Opens the selected template or report.
Cancel
Closes the dialog without taking further action.
Save View As
The Save dialog allows you to save and export reports or delete previously created reports/views.
The Save dialog has the following fields and buttons:
Field or Button
Description
Reports tree
Folders and files for templates and reports. If the current file was opened from an existing template or report, it is highlighted in this pane.
Reports
The name of a template or report that is selected in the Reports tree. You can save the current report under a new name by entering the new name here, or you can overwrite an existing template/report/view by selecting its name in the upper pane, loading its name in this field, and clicking the Save button. You can also create folders for reports by typing in the folder name and the file name, separated by a slash (/), and then click the Save button.
Account type pull-down menu
The type of account access for the report. If you are an administrator, you can assign the report to a specific account.
  • public - Users from all accounts can view the report.
  • account - Can be viewed only by users of a specific account, such as the account you are logged in as.
  • private - Only you can view the report.
Saving to an account requires the Portal Administrator ACL. The account option and its pop-up list appears only once accounts have been created.
Delete
Deletes the selected report.
Export
Exports the selected report to an XML file.
Save
Saves the report in the Reports text box.
Cancel
Closes the dialog without taking further action.
Disable Public Reports
You can block users from saving Performance Reports and List Reports as public reports. You might want to do block users if, for example, you are an MSP and you do not want your customers to be able to see reports from other UMP customers.
If saving public reports is disabled, users can save reports as either private or account reports. Users can still open public reports for viewing; they are only blocked from saving new reports as public reports.
Follow these steps:
  1. Open Infrastructure Manager.
  2. Click the robot for the primary hub in the tree view.
  3. Click the wasp probe to select it in the top right pane.
  4. Press
    CTRL
    and right-click, then select
    Raw Configure
    from the popup menu.
  5. Click the
    ump_common
    folder in the tree view of the
    Raw Configure
    window.
  6. Double-click
    allow_public_reports
    and change the value to
    false
    .
  7. Click
    OK
    , then click
    OK
    again to close the
    Raw Configure
    window.
  8. Restart the wasp probe.
Define Reports with a URL
You can use URLs with parameters to define reports from a browser without being logged into UMP. You might want to define reports without logging if you want to share reports with people who do not have UMP accounts, or to link to reports from a third-party application.
You can view reports as defined, and you can change parameters such as the source, QoS, target, or time period by specifying one in the URL. For example, if you have a report that is named "CPU that displays a series of CPU measurements, you can view the same measurements for a different computer system by specifying a different source in the URL.
You can define one or more data series for each chart, and you can have multiple charts in a row and multiple rows.
The syntax for the URL is:
http://<
ump_server
>/qoschart/jsp/standalone.jsp?user=<
user
>&password=<
pass
>&def=<
def
>
If you omit the user and password, a box prompts the user for credentials.
The def parameter
The def parameter uses the JSON syntax, using single quotes rather than double quotes. The full specification can be viewed at http://www.json.org/.
The JSON syntax is a set of key value pairs that are specified as {'key':value, 'key2':value2}.
All the options except time specifications are listed in an array to define sets of charts. Each set of charts is listed in an array to define a set of rows.
Normally the URL is specified in a single line. However, to make it easier to read these examples are broken into multiple lines.
Example - Multiple Rows
def= {'time':'-1hour','rows':[ {'charts':[ {'parms':"...", 'series':[ {'sqt':'myserver|QOS_CPU_USAGE|Total','scale':'1','color':'8000','style':'line'}, {'sqt':'myserver|QOS_CPU_USAGE|User','scale':'1','color':'800000','style':'line'} ]}, {'parms':"...", 'series':[ {'sqt':'myserver|QOS_CPU_USAGE|Total','scale':'1','color':'8000','style':'line'}, {'sqt':'myserver|QOS_CPU_USAGE|User','scale':'1','color':'800000','style':'line'} ]} ]}, {'charts':[ {'parms':"...", 'series':[ {'sqt':'myserver|QOS_CPU_USAGE|Total','scale':'1','color':'8000','style':'line'}, {'sqt':'myserver|QOS_CPU_USAGE|User','scale':'1','color':'800000','style':'line'} ]}, {'parms':"...", 'series':[ {'sqt':'myserver|QOS_CPU_USAGE|Total','scale':'1','color':'8000','style':'line'}, {'sqt':'myserver|QOS_CPU_USAGE|User','scale':'1','color':'800000','style':'line'} ]} ]} ]}
To define a single row, you can omit the 'row' option.
Example - Single Row
def= {'time':'-1hour', {'charts':[ {'parms':"...", 'series':[ {'sqt':'myserver|QOS_CPU_USAGE|Total','scale':'1','color':'8000','style':'line'}, {'sqt':'myserver|QOS_CPU_USAGE|User','scale':'1','color':'800000','style':'line'} ]}, {'parms':"...", 'series':[ {'sqt':'myserver|QOS_CPU_USAGE|Total','scale':'1','color':'8000','style':'line'}, {'sqt':'myserver|QOS_CPU_USAGE|User','scale':'1','color':'800000','style':'line'} ]} ]} }
Similarly, you can omit the charts parameter if you only have one chart.
Syntax
Strings are enclosed in single quotes.
For a URL, certain characters, including single quotes, must be properly escaped:
  • Single quotes are written as \\\' or \\'
  • The ampersand (&) is written as _amp_
  • The backslash is written as \\\\
Numbers are written in numerals.
An array is a set of JSON objects enclosed in brackets.
For <boolean> 'y', 'yes', 1, 't', 'true', true, or 'on' can be used for
true
. For
false
, you can use 'n', 'no', 0, 'f', 'false', or 'off'.
The time frame must be specified at the top level of a report definition:
  • 'time'
    - Time parameters for the report.
    • <epoch> is a specific time in seconds since epoch
    • <period> is a time period supporting the units "sec", "min", "hour", "day", "month", "year". For example, "60min" or "2hour"
    Time can be specified as follows:
    • '<epoch>-<epoch>' - start time to end time
    • '<epoch>-' - start time to now
    • '<epoch>-<period> - the <period> leading up to <epoch>
    • '<epoch>+<period> - the <period> after <epoch>
    • '-<period>' - the last <period>. For example, '-60min' shows the last 60 minutes.
You can choose a data interval for display in a graph or chart:
  • '
    aggregationInterval
    ' - Use with a value for the data interval in seconds. Valid intervals are:
    • 0 (no aggregation)
    • 60 (1 minute)
    • 300 (5 minutes)
    • 900 (15 minutes)
    • 1800 (30 minutes)
    • 3600 (1 hour)
    • 7200 (2 hours)
    • 14400 (4 hours)
    • 28800 (8 hours)
    • 43200 (12 hours)
    • 86400 (1 day)
      Any other value sets the aggregation interval to "Automatic," and the displayed data interval is determined by the chart width on loading the data. See the section
      Understanding Performance Data
      for an explanation of this function.
You can set a flag for getting the raw data:
  • 'rawData'
    - Use with a value of
    true
    to see the data in CSV format instead of a graph or chart.
    Setting the
    rawData
    parameter to
    true
    overrides any defined data aggregation interval. With
    rawData
    set to
    true
    , wildcard characters can be used to select data series for inclusion.
A report consists of some number of rows of charts. If a single row of charts is desired, the
'rows'
parameter might be omitted:
  • 'rows'
    - An array of row definitions. A row contains one or more charts.
  • 'charts'
    - An array of chart definitions. A chart contains one or more series.
The parameters for a chart are:
  • 'title'
    - Title of the report. If omitted there is no title.
  • 'info'
    - Informational text displayed at the bottom of the chart.
  • 'tref'
    - Time reference. If a time is specified, you can highlight a time or a time period.
  • '<epoch>+-<period>,[<epoch>+-<period>]
    ' - Start and stop of the highlighted period (stop is optional). "S" for epoch is the chart start time. "E" is the end time.
    Example:
    'tref':'S+10min,E-1hour' highlights the area from 10 minutes after the chart starts to 1 hour before it ends.
  • 'stacked'
    - <boolean> Stacks the series for the chart.
  • 'lmax'
    - Sets the maximum value for the left axis.
  • 'lmin'
    - Sets the minimum value for the left axis.
  • 'rmax'
    - Sets the maximum value for the right axis.
  • 'rmin'
    - Sets the minimum value for the right axis.
  • 'legend'
    - <boolean> to turn it off. Use an empty string to only show labels. Specific legend annotations can be specified and ordered.
    • 'M' - maximum value
    • 'm' - minimum value
    • 'l' - last value
    • 't' - total of all values
    • 'a' - average value
    • 'p' - show the percentile if it's turned on for the series
    Example:
    'legend':'Mpla' would show the max, percentile, last value, then average.
  • 'series'
    - An array of series definitions. Series are defined as follows:
    • 'sqt'
      - Specifies the data for the series as '||'. An asterisk (*) can be used as a wild card for a full or partial word.
    • 'scale'
      - Scales the series by this factor.
    • 'ptile'
      - Shows the specified percentile, for example 'ptile':95 shows the 95th percentile for the series.
    • 'style'
      - Series style:
      • 'line' or 'usm' - line chart
      • 'area' - area chart
      • 'col' - column chart
    • 'color'
      - Color of the series specified in RGB in hex. For example, FF0000 is red.
      There are currently no keys to include a trend line or a baseline in a URL.