Index


Overview

Statseeker Reporting allows you to create reports targeting any data available to Statseeker and present that information in a tabular or graphical report. Once created, reports:

  • Can be available from the Console report list
  • Can have access to them restricted via user permissions
  • May be embedded to create custom summary reports
  • Be run and have the content exported in *.pdf or *.csv format
  • Can be scheduled to run and have the subsequent report emailed to a recipient list, see Emailing and Scheduling Reports for details

Custom reporting differs from stock reports by allowing you to edit the contents, layout, and appearance of the report to best suit your requirements. Custom reports are also used to present data from installed Custom Data Type packages.

[top]


Reporting Console

The Reports console can be accessed from the main navigator, providing access to the existing custom reports and the ability to create and edit reports. The console is broken into two sections:

  • Reports - a listing of the existing custom reports
  • Report Editor - editing and viewing of custom reports

The Reports Panel can be used in either View or Edit mode. In View mode, you can run existing reports, in Edit mode, you are able to create, edit, and view custom reports. The controls for switching between the two modes are offered at the top of the Reports panel.


[top]


Viewing an Existing Custom Report

Existing custom reports can be run from either the Console or the Reports Panel.


Viewing Custom Reports from the Console

By default, newly created custom reports are only available from the Console for users with All Groups access. To allow another user to access a custom report from the Console, you need to assign the report to a group that the user has permission to access. To do this:

  • Select Administration Tool > User Profile/Grouping
  • Select a group that the user has access to
  • Select Reports from the entities drop-down above the right-hand column
  • Select the reports you want the user to access, and click the >> button to move them to the Include column
  • Have the user refresh/reload their view

To run a custom report from the Console:

  • Select groups/devices
  • Apply filters if required
  • Select the report

Note: Custom reports can be hidden from the Console by:

  • Opening the report in Edit mode
  • Unchecking Show in NIM Console?
  • Save the report

[top]


Viewing Custom Reports from the Reports Panel

Custom reports can be run from within the Reports panel.

In View mode, simply select the report from the Reports panel.

Note: the row height used when displaying tabular reports is determined by a user-specific setting, Report Row Spacing. This setting defaults to a standard layout but can be modified to present a more compact layout, increasing the number of rows displayed in a single view. To view/edit this setting, see User Accounts > Editing Existing Users.

In Edit:

  • Either click View to view the report in the Reports panel, or mouse-over the View button and select View In New Window to launch the report in its' own window, leaving the report configuration open in the Report Editor panel

Note: when viewing the report in the Reports panel, click Edit to return to editing the report.

[top]


Interacting with Custom Reports
  • Custom reports can optionally offer display filters in the report header, allowing you modify the scope and focus of any custom report being viewed
  • Graphs can be moused over to view specific data point values, and can be zoomed (via click-and-drag) to specific time and/or value ranges
  • All custom reports can be configured to offer links through to other resources (reports, dashboards, web content and 3rd party tools)

[top]

Filtering Within Reports

Custom reports contain filter options within the report header, allowing you to assign/modify filters after the report has been launched.

Any filters specified in the report configuration are assigned as the default filters used when the report is launched and can be altered from within the report while viewing it.

[top]

Time Selector

The Time Selector functions as a filter and can be used to dynamically alter the reporting period of the report while viewing it. When opening a report containing a time filter, the time selector defaults to this value. When opening a report that does not have a time filter configured, the time selector will default to Today.

  • Favorites - offers the current content of the time filter favorites list
  • Hours - a 24hr slider with 1-hour increments
  • Days - the selector contains 'today so far', plus the previous 7 days, with 1-day increments
  • Months - the selector contains 'this month so far', plus the previous 12 months, with 1-month increments
  • Original Query - reset the report to the original/default time filter

By default, reports display the report time filter in the header (this can be disabled in the report configuration, see Creating a New Report). When using the time selector to modify the reporting period, the report header is updated to reflect your selection.

[top]

Dynamic Graphing Interval

When modifying the reporting period via the Time Selector, the Resolution (interval between plotted data points, and the size of aggregated data 'buckets') used in the report is automatically updated to best suit the scope of the report.

For example: on a graph with a reporting period of the previous 3 months, the default interval may be 15 minutes. If the reporting period is updated to the Last 8hrs, then the interval would be updated to 1 minute, giving a granular view more suited to the reporting period. Conversely, using the Time Selector to take a report looking at a single day’s data out to the previous 6 months, might update the interval from 1 minute out to 12 hours. Any slice of that 6 months history can still be viewed at 1-minute resolution when the reporting period is set accordingly.

[top]

Group and Device Filters

The Group and Device filters will reflect any group/device selections that were specified in the report configuration. This filter selection can be modified to refocus the report while viewing the report.

  • The Group filter contains all groups on the server
  • Group selections determine the content of the Device filter
  • Multiple selections can be made in both the Group and Device filters

[top]

Text Filter

The Text filter will reflect the content of the General > Text filter if any was specified in the Console prior to launching the report. This filter can be modified to refocus the report while viewing the report.

The filter:

  • Accepts either a simple string or RegEx
  • Matches that string/expression across strings within the report (entity names in graphs, string columns in tables), does not match against timeseries metric fields

When a RegExp exclusion filter is applied to tabular reports, the filter is matched against every string/date column in the report, and not against the entire row as a whole. This means that if any filtered column does not contain the exclusion string, the filter is satisfied and the row is displayed, even if other columns do feature the exclusion string.

[top]


Interacting with Graphs

The graphs presented in custom reports are fully interactive allowing you to:

  • mouse over the graph to see values at that point

  • Click and drag horizontally/vertically on the graph to zoom, double click to return to default view



[top]


Graphs displayed within Tabular Reports

Statseeker custom reports allow you to include thumbnail graphs within tabular reports as you would with any other data. When mousing over these graphs a pop-up is displayed presenting a more detailed view of the data.

In turn, these detailed views can be interacted with just like other custom reporting graphs i.e. you can mouse over the graph to display data pertaining to that point in the graph as well as zoom via click-and-drag.


[top]


Creating a New Report

To create a new custom report:

  • Switch to Edit mode
  • Select New Report

This will open a blank report template in the Custom Report Editor panel.

Field Required Description
Report Name Must be unique and consist of only alpha-numeric or the following characters -_.!~*()
Report Subtitle Any filters of the selected type/s used in the report will be detailed in the report header


An additional per-graph title can be configured for graph reports (see Graphs Section) to display any number of field values, such as displaying the 'interface title' as an identifier for the graph
Report Structure
  • Tabular Data - tabular report
  • Graphed Data - graphical report
  • Embedded Reports - summary report consisting of multiple custom reports
Report Data Type The data type to report on, additional options are included with installed Custom Data Type packages. The value set here also determines which folder a newly created report will be saved to in both the Reports panel and the Console.
Refresh Interval How frequently to refresh the report data
Results Per Page Maximum results to display per page, overrides the Console Top N setting.
Show in NIM Console? Select to display the report in the Console. Enabled by default.

Note: the report will be grouped according to the Report Data Type.
Show All? Select to include historical data for entities no longer being polled
Show Report Filters? Select the reporting filters to be displayed in the report header, these filters allow you to alter the scope and focus of the report while viewing it
Note:

  • the Report Data Type determines which folder a newly created report will be saved to in both the Reports panel and the Console
  • Once a report has been saved it can be manually relocated to another folder
  • Changing the Report Data Type after the initial save/creation will not relocate the report


  • Populate the Report Configuration fields as required

Once both Report Data Type and Report Structure have been selected, the elements of the form relevant to those selections are displayed.



Filters Section

The filters section offers a range of filters to be applied to the available data prior to display. In addition to the time and group filters that are offered through the Console there are also filters specific to the Report Data Type.

  • Select a filter Type
  • Specify the required filter Criteria

  • Click Add, to confirm the filter

Confirming the filter will both save the filter configuration and enable the option to specify additional filters.

Time Filters

Optionally specify a filter that will be supplied as the default time filter applied when running the report. This default time filter can be overridden from within the report using the in-report filter options.

  • Select an existing time filter favorite from the list provided or create a custom time filter to suit your requirements

For details on creating custom time filters and managing the time filter favorite list, see Time Filters

[top]

Group Filters

Optionally specify a group filter that will be supplied as the default when running the report. This default group filter can be overridden from within the report using the in-report filter options. When multiple groups are selected, members of any of the specified groups are included in the report content.


[top]

Device Filters

Optionally specify a device filter that will be supplied as the default when running the report. This default filter can be overridden from within the report using the in-report filter options.


[top]

Attribute Filters

Optionally specify an attribute filter that will be applied the report. Any entity satisfying the filter will be included in the report when run. The in-report filters can be used to modify this content once the report has been launched.

Attribute filters include any configuration, event or timeseries metric available from the entity specified in the Report Data Type, or the generic 'device' entity.


[top]

Entity Filters

The final filter option varies according to the Report Data Type specified in the report configuration. In the image below the Report Data Type is File System, so the last filter option allows you to filter the report to specific file systems.


[top]

Fields Section

The Fields section will be displayed when Report Structure is set to Tabular Data. This section is used to specify the columns of the report.


  • Select a field to display in the report by specifying an Attribute
  • Assign a Name to be used as the column header
  • Configure drill-down for the column values if desired
  • Click Add to confirm the field
Note: be sure to set an appropriate sort order to ensure that the important results are pushed to the top.


There are several available fields used to configure entries in the Field section. The fields displayed vary depending on the selections made during configuration, see the table below for details.

Field Required Description
Attribute The attribute to use for the field
Format Data manipulation options. Displayed when the Attribute is a time-series data metric.

Format Description
Graph Display an in-column graph of the metric
Total Total of the metric over the reporting period
Average Average of the metric over the reporting period
Minimum Minimum of the metric over the reporting period
Maximum Maximum of the metric over the reporting period
Median Median of the metric over the reporting period
95th Percentile 95th Percentile (95% of observed values lie below this point) of the metric over the reporting period
Percentile Custom percentile value of the metric over the reporting period [0-100]
0% = minimum; 50% = median; 100% = maximum
Standard Deviation The value of a single standard deviation for the metric
Start Time The start date-time for the specified reporting period for the metric
Count Number of polling points (non-null) in the specified reporting period for the metric
Anomaly Metric An integer [-100 to +100] indicating how anomalous the data in the reporting period is compared to the data history of the metric on that device/interface, and whether that data presents a higher (positive anomaly metric), or lower (negative anomaly metric) value than typically seen

Note: values between -85 and +85 are not considered statistically anomalous.
Anomaly Strength A positive integer [0 - 100] indicating how anomalous the data in the reporting period is compared to the data history of the metric on that device/interface

Note: values under 85 are not considered statistically anomalous.
Trend A range of options for displaying a trend related value for the metric

  • Daily Change: the average daily change in the metric over the reporting period
  • Change: numerical change observed over reporting period
  • Percent Change: percent change observed over reporting period
  • Strength: how closely does the trendline fit the data. A high strength means that the data points lie close to the trendline.
  • Prediction: specify a future date/time to see a predicted value for the metric based on the trendline

For each of the trendline metrics there is also the option to:

  • Disable bounds checking in trend calculations: enable to allow trendline values to range outside of the minimum and maximum values observed in the reporting period
Baseline Extract a baseline value for the metric.
Baseline Formats:

  • Average: average of the specified percentile values for the baseline history
  • Comparison: difference between the calculated baseline and the observed value

Baseline Percentile: the percentile value [0-100] to use when calculating baseline values, defaults to 50 (median value)

Forecast A range of options for displaying forecast data for the metric

  • Value: the forecast value for the metric as the specified date-time
  • Upper: the upper boundary for expected forecast data between now and the specified date-time
  • Lower: the lower boundary for expected forecast data between now and the specified date-time
  • Daily Change: average daily change in metric between now and the specified date-time

For each of the Forecast metrics there is also the option to display:

  • Total - cumulative value
  • Average - average value
Baseline History Time filter specifying the scope of historical data used when calculating Baseline, Anomaly or Forecast values.
Defaults to previous 6months (range = now - 180d to now), for details see Baselining Time Range
Name Column name
Graph Type Type of graph to be displayed in the report column. Available when Format = Graph
Graph Color Color of in-column graph. Available when Format = Graph
Time Filter Fav Time filter to be applied to in-field graph
Time Filter Query Time filter query to be used when Time Filter Fav has been set to Custom
Interval Interval to be used when collecting data for the field. Not available when Format = Graph.
Show Units? Toggle to show/hide units used for the field
Raw Values? Toggle to use raw or scaled granularity (e.g. present an interface Rx value in Bytes (raw) or GB/TB (scaled)
Precision Number of decimal places to display
Link Field To Target for a drill-down link
Report A report to link to with the drill-down
Filters Filters to pass with the linked drill-down target
URL URL to target with a drill-down
Order Report sort order
Direction Sort direction for that column

[top]

Graphs Section

The Graphs section will be displayed when Report Structure is set to Graphed Data. This section is used to specify the graph to be displayed within the report. Multiple data series can be plotted on a single graph and the graph legend will automatically update to detail the various data sources.


  • Specify the Graph Type and Resolution and Color for representing the data
  • Select a data series to graph by specifying an Attribute
  • Specify the Sort Attribute and Sort Direction to be used when more than a single graph will be presented in the report
    • Note: it is important to use the Sort Attribute and Sort Direction to ensure that the most relevant data is pushed to the top.
  • Use the Link Graph To field to configure a drill-down, if that would be useful for the report
  • Use the various options provided (see table below for details) to specify the appearance of the graph to be displayed and click Add to confirm the configuration
Note: the clickable region for Link Graph To is restricted to the title/header region above each graph.
Field Required Description
Graph Type Type of graph to be displayed (line, bar, gauge, etc.)
Graph Title An optional title to be displayed for each graph in the report

  • Default - the default graph title is {device.name} {entity.name}, for example:
    • interface report: {device.name} {port.name}
    • memory report: {device.name} {memory_module.name}
    • temperature report: {device.name} {temperature_sensor.name}
  • Device - display the value of any configuration field on the device / parent device
  • Report Data Type - display the device name followed by the value of the selected configuration field on the entity the graph is reporting on, for example:
    • interface report: {device.name} {selected interface field value)
    • memory report: {device.name} {selected memory field value)
    • temperature report: {device.name} {selected temperature field value)
  • Advanced - the device name followed by any Advanced graph title. Any combination of text, Device and Report Data Type configuration fields. The syntax to be used for each field is {{entity.field_name1}}
    Example:

    • Configuration: My Title: {{cdt_port.ifTitle}}
    • In-Report Display: London-rtr1 My Title: Link to London Core
Data Attribute The data to be graphed
Display Timeseries metrics returning counts (bytes, packets, errors, discards, etc.) offer the option to display:

  • Standard Plot - regular timeseries values
  • Cumulative Plot - cumulative values over the reporting period
Series Title Label to be applied to the data series and displayed in the legend
Color Color used to represent the graphed data
Show Baseline Display historical baseline values and expected data range
Baseline Percentile The percent baseline data range/bounds to display, defaults to 95 (i.e. display the data range that would account for 95% of the historical data values for that time of day, on that day of the week)
Baseline History Time filter specifying the scope of historical data used when calculating Baseline values.
Defaults to previous 6months (range = now - 180d to now), for details see Baselining Time Range
Show Trendline Display a trendline for this series. A trendline is a 'line of best fit' for all data points in the specified reporting period.
Show Trendline Bounds Display upper and lower bounds for the trendline, for this series
Trendline Unconstrained Allows trendlines to range outside of the minimum and maximum observed for the data series in the specified reporting period
Trendline Color Color used to represent the trendline
Show Forecast Data Display forecast data for this series

Note: requires a time filter that ranges into the future. E.g. a time filter of range= start_of_last_month to now +30d will display forecast data 30 days into the future.
Show Forecast Trendline Display a trendline for forecasted data for this series. A forecast trendline is a 'line of best fit' based on the previous 6 months data history.
Forecast History Time filter specifying the scope of historical data used when calculating forecast values.
Defaults to previous 6months (range = now - 180d to now)
Forecast Color Color used to represent the forecast data
Sort Attribute Attribute used to sort the display of graphed data (this attribute does not need to be displayed on the graph to be used as the sorting attribute)
Sort Direction Direction used to sort the graphs based on the Sort Attribute
Show Units? Toggle to display/hide units in the graph legend
Raw Values? Toggle to show raw/scaled values (e.g. present an interface Rx value in Bytes (raw) or GB/TB (scaled)
Precision Number of decimal places to be displayed when presenting values
Graph Size Specify the size of the graph (width x height) in pixels
Show X Gridlines Toggle to show/hide reference lines for values along the X axis
Show Y Gridlines Toggle to show/hide reference lines for values along the Y axis
Y Gridline Count Number of reference markers to display for values along the Y axis
Y Axis Range Set to restrict the Y axis to specific range
Show Legend Toggle to show/hide the legend
Interactive Toggle to enable/disable graph interactivity, see Interacting with Custom Reports for details
Logarithmic Scale Toggle to apply a logarithmic/linear scale to the y-axis
Calendar Toggle to display the reporting period on a single x axis or broken into calendar weeks
Link Graph To Target for a drill-down link:

Note: the drill-drown is attached to the graph header/title.
  • The Device Viewer - links through to the Device Viewer report for the selected device
  • A Related Report - links to a selected report and filters that report by the subject of the parent (e.g. if the parent report is a CPU report, then the link target will be filtered by the device and CPU of the parent; if the parent report is an interface report, then the link target will be filtered by the device and interface.)
  • Any Custom Report - link to a selected custom report, with the option to apply complex filtering
  • Any URL - link to any URL (internal\external) with optional filtering
Note: both the Any Custom Report, and Any URL link options allow you to configure additional filters to be passed with the link. These filters are advanced features, primarily intended for use by Statseeker support staff, to create specific, tailored workflows as needed. Please contact Customer Support for assistance with these filters.
Report A report to link to with the drill-down
Filters Filters to pass with the linked drill-down target
URL URL to target with a drill-down

[top]

Embedded Reports Section

The Embedded Reports section will be displayed when Report Structure is set to Embedded Reports. This section is used to create a summary report featuring existing custom reports.


  • Select a report from the drop-down and click Add
  • Repeat the process as required to build the custom summary report

Once added, a report can be replaced or removed via the Edit and Delete buttons respectively.

Note: the Edit and Delete actions do not affect the selected report, only whether it is embedded in the summary report.

Running an embedded report will present all the attached reports sequentially, each report featuring its own scrollbar to manage pagination.


[top]

Links Section

The Links section is an optional section allowing you to append customized links to the end of each row in a tabular report or to the bottom of each graph in a graphical report. By supplying these links, you can easily create a customized workflow for reviewing elements of your network or troubleshooting.

  • Provide a Title
  • Specify the Link target
  • Select an Appearance for the link


Field Required Description
Title Title to be used to reference the link (is also used when the link Style includes Text
Link To Target for the link

  • The Device Viewer - links through to the Device Viewer report for the selected device
  • A Related Report - links to a selected report and filters that report by the subject of the parent (e.g. if the parent report is a CPU report, then the link target will be filtered by the device and CPU of the parent; if the parent report is an interface report, then the link target will be filtered by the device and interface.)
  • Any Custom Report - link to a selected custom report, with the option to apply complex filtering
  • Any URL - link to any URL (internal\external) with optional filtering
Note: both the Any Custom Report, and Any URL link options allow you to configure additional filters to be passed with the link. These filters are advanced features, primarily intended for use by Statseeker support staff, to create specific, tailored workflows as needed. Please contact Customer Support for assistance with these filters.
Report A report to link to
Filters Filters to pass with the linked report
URL URL to target with the link
Appearance How the link should be represented in the report. Text, Button, and Text with Icon all use the value in the Title field as the string to display in association with the link.

[top]

Previewing and Saving the Report

At any point during creating or editing a report you can preview or save the current state of the report or branch a report by saving a copy. The actions to do this are located at the top of the Custom Report Editor panel and only apply to the currently open custom report.

These actions and their uses are described in the table below.

Action Description
Save Saves the current report under the specified Report Name
Save a Copy Saves the current report and renames it by appending Copy n (where n is an incremented number) to existing value of the Report Name field. This copy is then opened in the editor.
View Allows you to preview the report in Custom Report Editor panel but does not save any of the changes made in the current session. To return to editing the report and continue editing or to save the changes made, click Edit in the Reports panel.
View in New Window Allows you to preview the report in a new window, keeping the report open in edit mode. No changes have been saved.
Delete Delete the current report. You will be prompted to confirm the action prior to the report being deleted.
Reset Returns the report to the last saved state, or, for a previously unsaved report, to a blank state. This action is applied immediately, no confirmation is sought.
Assign Opens a modal allowing you to copy the report, in its last saved state, to another user's Reports panel. This does not affect report visibility from within the Console, see Viewing Custom Reports from the Console for more on this.

[top]

Managing Custom Reports & Folders

Depending on your needs, you may have many custom reports and Statseeker gives you the tools you will need to manage that collection. From the Reports panel, you can rename, organize, and distribute custom reports as needed.


Renaming Custom Reports

To rename a custom report:

  • Select the report in the Reports panel
  • Click Edit
  • Edit the Report Name field
  • Click Save

[top]


Report Folders

The Reports panel allows you to create folders to organize your custom report collection. These folders work just like a regular file system and are unique to a user. To create a new folder:

  • Click Edit in the Reports panel
  • Click the New Folder action at the top of the Reports panel

The Custom Report Folders panel will be displayed, containing a form for creating a new folder.

  • Specify a Folder Name and click Add Folder

The new folder will be added to the directory tree in the Reports panel.

To relocate the folder within the directory tree:

  • Click and drag the folder to the new location
Note: when relocating a folder, all sub-folders and reports will be moved with the folder you are relocating.

Folders can also be renamed by:

  • Selecting the folder and clicking Edit
  • Use the Rename Folder prompt in the Custom Report Folders panel to enter a new name and click Rename Folder

When creating a report, the Report Data Type not only determines the content options for the report, but also which folder a newly created report will be saved to in both the Reports panel and the Console. Once a report has been saved, it can be manually relocated to another folder, but changing the Report Data Type after the initial save/creation will not automatically relocate the report - this auto-categorization only occurs on the initial save of a newly created report.

[top]


Making a Report Visible to Another User

One of the actions available when editing a report is Assign. This can be used to manage the visibility of the report for other Statseeker users.

Note: this only affects report visibility from within the Reports panel and has no impact on report visibility from within the Console. See Viewing Custom Reports from the Console for more.

Likewise, unassigning a custom report from a user will only hide the report, for that user, within the Reports panel. If the user's group configurations allow the report to be displayed within the Console, then these will need to be updated to prevent the report from being displayed within the Console.

To assign a report:

  • Select the report and click Edit
  • From the actions provided at the top of the Report Editor select Assign

This will display the Assign to Users modal.

  • Use the associated checkboxes to set the visibility of the report for the various users
  • Specify a folder to contain the report in the other user's Reports panel
  • Click Save
Note: when assigning a folder to contain the report:

  • If a folder with that folder name exists, then the report will be placed inside the existing folder
  • If no folder exists with that name, then a new folder will be created
  • If no folder name is specified, then a new folder named Assigned Reports will be created to house the report
  • The creation of folders to house the copied report only occurs for other users, not the user assigning the report

[top]


Deleting a Custom Report

To delete a custom report:

  • Select the report and click Edit
  • Click Delete and confirm the action when prompted
Note:

  • If the creator/owner of the report deletes the report, then it is deleted for all users. If the report has been assigned to other users and one of those users deletes the report, then it is only removed from their account and remains visible for all other users.

[top]