Legacy Documentation for Statseeker version 5.5.4

Index

Overview

The Statseeker Dashboard Home page is the default view when accessing Statseeker via the web interface. This page offers access to the existing dashboards that the user has permission to view, as well as the ability to create new dashboards, and edit exiting dashboard configurations. Dashboards are an editable view comprised of one or more 'panels', each panel containing a Statseeker report (graph, table, gauge, etc.).

The panels are individually configured and can be moved around and resized within a dashboard, as well as copied to other dashboards. Statseeker offers a range of panel types:

  • Graph - a graph or one or more monitored metrics
  • Singlestat - a single summary value for a data series (min, max, average, sum, etc.), which can optionally be represented as a gauge
  • Table - a data table
  • Pie Chart - can be used to present timeseries, configuration or asset data
  • Worldmap - display data related to geographical locations on a configurable background
  • Image Map - place nodes over a custom background image, and have those nodes display configuration, state or timeseries data
  • Text/HTML - text which can be static or dashboard variable driven. This panel can also be used to house imported content such as Statseeker reports or 3rd-party web content.
  • Clock - a clock displaying server time, or countdown to a marked deadline
  • Row - a collapsible row used to manage panel layout within your dashboard

The dashboards can be themed to target a particular aspect of Statseeker monitoring, configured to broadly encompass your entire network, or be as finely tuned and specific in scope as needed.

All dashboard panels can be configured to offer links to:

  • Other dashboards
  • Statseeker reports
  • Any external web content

This linking ability enables you to use the dashboards to highlight potential hotspots, and then investigate issues with a single click.

[top]

Dashboards Home

The Dashboard Home page contains sections listing your favorite dashboards, recently viewed dashboards and the Statseeker default dashboards. The homepage also contains a news panel detailing recent updates with links to associated documentation and videos.

From the dashboard homepage, you can jump to the dashboard of your choice, search your dashboard collection, and create new dashboards.


[top]

Default Dashboards

Every Statseeker install contains several default dashboards, located in the Default folder, and available to all users. These non-editable dashboards are created and maintained by Statseeker, with updates and additions being made available from the Dashboard Home page. The current default dashboards are:

  • Network Summary - a high level summary of the current state of the network with details on down devices and device-level events, ping statistics highlighting latency issues, and identifying potential interface and link congestion. The dashboard features drill-down links to events-based reports, as well as the Device and Interface Overview dashboards
  • Device Overview - provides details on a selected device including current state, availability, latency, interface usage and traffic volume, event records (device events, threshold breaches, syslog and trap messages) and basic device health metrics such as temperature, CPU and memory load. The dashboard features drill-down links to events-based reports, interface utilization baseline reports, and the Interface Overview dashboard.
  • Interface Overview - offers a detailed look at the interfaces of the selected devices, detailing interface configuration, utilization, traffic volume and rate, and errors and discards. The dashboard also offers links to the Device Overview and drilldowns to an interface events report.
  • Asset Overview - an overview of the infrastructure makeup of your network, providing details on device and interface counts, MAC/IP configuration, and operational status. Most panels in the dashboard feature drill-down links to breakdowns of this data.
  • MAC-IP-Switchport Overview - an overview of the network's MAC/IP/Switchport configuration with breakdowns by VLAN, device, interface, and ARP Router
  • Syslog Overview - Syslog counts and message details broken down by group, device, and source. The dashboard features drill-down links to detailed syslog reports, and the Device Overview dashboard.
  • Server Overview - A single device overview providing current state and historical records for a range of server health metrics including ping, CPU load, memory and disk usage, traffic volumes, as well as event and outgoing syslog counts. The dashboard features drill-down links to detailed device event and syslog reports, and the Interface Overview dashboard.

These default dashboards are maintained by Statseeker and are not editable. If you would like to edit any aspect of the default dashboards you will need to create an editable copy of the dashboard, see Working with Dashboards for details on how to achieve this.

Dashboard Manager

The Dashboard Manager is available from the Dashboards option in the main navigator.

The Manage Dashboards option allows users to:

  • Create folders and populate them with dashboards
  • Create and edit dashboard playlists
  • Create and share dashboard snapshots
  • Edit user-specific preferences

Statseeker user accounts with the Admin can perform these actions with respect to all dashboard content on the server. By default, non-admin users are limited in their ability to manage or interact with dashboard content, but permissions can be assigned (by the content owner or any admin account) as needed.

[top]

Users and Dashboard Permissions

All dashboards have set of permissions detailing which users can view, edit, move, and delete the dashboard. These permissions may be inherited from the folder that contains the dashboard or may be set against the dashboard specifically.

New folders and dashboards can be edited by their creator and by all admin accounts but won't be visible to any other user until permissions are set against the folder/dashboard. Folder and dashboard permissions can be set by specifying the level of access for all user accounts with a specific role (editor/viewer), or for specified user accounts. When conflicting permissions are set against a dashboard or folder, the highest level of access is used.

Roles: Admin, Editor and Viewer

By default, every non-admin account is set as a Dashboard Viewer. The default role applied to new accounts can be set in the Admin Tool, and individual accounts can be set to viewer/editor, see User Accounts: Default Settings.

In addition, these roles can be over-ruled by permissions set against individual folders or dashboards. For example, a folder can be created, and folder-specific permissions set, to give editor rights to all dashboard viewers.

Viewer
  • Can view the General and Default Dashboards folders, and their content
  • Can view, but cannot create or edit dashboards
  • Cannot create or edit dashboard folders
  • Can run playlists, but cannot create or edit playlists
  • If a playlist contains a dashboard that the viewer does not have permission to view, then they will be presented with an alert message highlighting the issue for the period that the dashboard would be displayed. All other dashboards in the playlist are unaffected.
Editor
  • Can create folders (where they are automatically given editor permissions) for personal use, but cannot edit the folder permissions to give access to other users
  • Can view, create, edit, and delete dashboards
  • Can create or edit playlists
  • Can move dashboards from their own folders into the General folder
  • Cannot edit the Default Dashboards folder or its contents
  • Image Map Images:
    • Can upload images for use in Image Map panels
    • Can see shared images that have been uploaded by other users
    • Can not share images (sharing an image requires the admin role)
    • Can delete own uploaded images
Admin

Statseeker users with the admin role:

  • Cannot edit the Default Dashboards folder or its contents
  • Can create and edit folders and playlists
  • Can view, create, edit, move, and delete dashboards
  • Can manage permissions on dashboards and folders
  • Image Map Images:
    • Can upload images for use in Image Map panels
    • Can share uploaded images for use by non-admin users
    • Can see and delete any uploaded image

[top]

Network Visibility

Regardless of the dashboard content and configuration, the current user will only see data relating to those devices that they have visibility of in the Console. For example, if a dashboard panel is configured to display data from a specific device (or group of devices) and the user does not have access in the console to view those devices, then the panel will display 'no data'. For more information on managing user account network visibility, see Users and Grouping.

Note: a user (including the Admin user) can create dashboard snapshots which present the dashboard exactly as they see it. Snapshots can be shared with any other Statseeker user, presenting the viewer with the exact same view of the data, regardless of their normal permissions. See Snapshots for more information.

[top]

Folders and Permissions

Statseeker comes with two dashboard folders, Default Dashboards and General. Accounts with the Admin role can create additional folders, and set permissions for those folders, allowing Statseeker users to share dashboard content, regardless of the creator.

The folders feature the basic permissions of Edit and View, which can be set for users as needed, and the folder content will inherit those permissions. These permissions can be edited in Folder Settings.

[top]

Folder Settings

Folder Permissions are configured from the Dashboard Manager:

  • Hover over the folder to expose the folder settings button



Dashboards Tab

Presents the current folder content, tools to filter this content, and options to add to the folder content by creating or importing dashboards.



Permissions Tab

Folder permissions are inherited by all dashboards housed within the folder. Existing permissions can be edited, new permissions can be added, and permissions can be assigned against either a user or user role (viewer, editor).

Note: when assigning permissions on a per-user basis, the dropdown will only display 10 users. Typing in the field will display a filtered list of up to 10 users.


Settings Tab

The folder can be renamed in the Settings tab.




[top]

Statseeker Default Folders

There are two default server-level folders:

  • Default Dashboards - contains non-editable, default dashboards created by Statseeker
  • General - all users have access to view the content of the General folder, editors can add dashboards to the General folder, and Admin users can edit and manage the contents of the folder
Note: while the dashboards in the Default Dashboards folder cannot be edited, admin users can copy (export to file, then import as new) the dashboard and alter permissions on the copy. See Working with Dashboards: Importing for details, or checkout the Videos section of the Statseeker Documentation homepage.

[top]

Create and Configure a Dashboard User

The process required to create a dashboard user varies a little between admin users, editors, and viewers.


Admin User
  • Create the Statseeker user account if it doesn't already exist, see Creating New Users for details
  • Assign the user the Is Admin role, and Save the user configuration
  • Associate the user account with the All Groups group, or a selection of groups as necessary, see Users and Grouping for details

The user account now has admin access within the dashboard module, nothing further is needed.

[top]

Dashboard Editor
  • Create the Statseeker user account if it doesn't already exist, see Creating New Users for details
  • Associate the user account with the All Groups group, or a selection of groups as necessary, see Users and Grouping for details

The user will now be able to:

  • View content in the Default Dashboards and General folders
  • View content in any folder with a Viewer role-level permission set and any folder with an appropriate user-level permission
  • View playlists

To provide Editor access:

The user will now be able to:

  • Create their own folders in order to provide a space to create and test dashboards outside of the General folder
  • Edit content in the General folder, any folder with an Editor role level permission set and any folder with an appropriate user-level permission
  • Move content from any folder where they have edit permission to the General folder
  • Create and edit playlists

[top]

Dashboard Viewer
  • Create the Statseeker user account if it doesn't already exist, see Creating New Users for details
  • Associate the user account with the All Groups group, or a selection of groups as necessary, see Users and Grouping for details

The user will now be able to:

  • View content in the Default Dashboards and General folders
  • View content in any folder with a Viewer role-level permission set and any folder with an appropriate user-level permission
  • View playlists

[top]

Manage

The Manage tab contains the basic Dashboard Manager actions:

  • New Dashboard
  • New Folder
  • Import
  • Move
  • Delete

New Dashboard

The new dashboard button creates a new dashboard and switches the view to that dashboard in edit mode.

New Folder

Click to create a new folder. Once created you can configure the folder permissions and populate the fold as required.

Import

You can create a new dashboard by importing the configuration of an existing dashboard. The existing dashboard configuration can be exported to a file and uploaded to your Statseeker server. Alternatively, you can view the dashboard's configuration in JSON format, copy this to your clipboard and paste it directly into the Import Dashboard text box.

Note: overwriting a default dashboard may lead to the loss of your changes on upgrade of your Statseeker server. To prevent this, always provide a new UID when copying a default dashboard. It is also recommended that the dashboard titles be unique to avoid confusion that may lead to unintentionally overwriting existing dashboards. A walk-through of the process required to copy a default dashboard in order to make an editable version is available in the Videos section of the Statseeker Documentation homepage.
Move
  • Use the checkboxes to select the dashboards, selecting a folder will select all dashboards in that folder
  • Click Move
  • Select the destination folder, or opt to create a new folder to set as the destination
Delete
  • Use the checkboxes to select the dashboards, selecting a folder will select the folder and all dashboards in that folder
  • Click Delete

[top]

Playlists

A dashboard playlist allows you automatically rotate through the display of selected dashboards. Once a playlist is running the dashboard header includes playlist controls allowing you to skip through dashboards or stop the playlist.

Creating a Playlist
  • Name the playlist
  • Set the rotation interval
  • Populate the playlist and edit the playlist order as needed

Playlist Options
  • Normal Mode - presents playlist within the standard Statseeker dashboard panel
  • TV Mode - hides playlist controls after 1min of inactivity. Any mouse/keyboard activity will show these controls again.
  • Fullscreen Mode - collapse the main navigator and hide the playlist controls. Click the display header to exit.

[top]

Snapshots

A snapshot is a canned view of a dashboard, including all data and filter settings as at the time the snapshot was taken. Snapshots can be shared with anyone that has access to the Statseeker server, allowing them to view the snapshotted data, regardless of any permissions that would normally prevent them from viewing it.

While the Snapshots tab in the Dashboard Manager allows every Statseeker user to view and access the server's snapshots, the snapshots themselves are created from within the dashboard itself. See Exporting and Sharing Dashboards for details.

[top]

Preferences

The Preferences tab allows you to:

  • Set the theme (light/dark) used when displaying dashboards
  • Set the default landing page when selecting Dashboards from the main navigator
  • Enable access to the advanced query type - this will require Statseeker support assistance to configure
  • Specify the tile map provider service for dashboard Worldmap panels

[top]

User Preferences

These settings are user specific.

UI Theme

Assign the UI color theme.

Default Dashboard

You can select a dashboard as the landing page for when the Dashboard link in the main navigator is clicked. By default, this landing page is Dashboard Home, but you can specify one of your 'starred' dashboards from the Dashboard Manager > Preferences page.



To specify the dashboard landing page:

  • Select Dashboard Manager > Preferences
  • Select a 'starred' dashboard from the list and click Save



The list content is the Dashboard Home page, and every dashboard that you have 'starred' to flag as a dashboard favorite. Dashboards can be starred from Dashboard Home or the dashboard itself.

Star/Favorite a Dashboard from Dashboard Home



Star/Favorite a Dashboard from within a Dashboard


[top]

Global Preferences

Allow Advanced Queries - toggle access to the Advanced query type for panel configurations. The Advanced query type is typically reserved for Statseeker Support to provide assistance with troubleshooting and complex panel configurations. Customer use of the Advanced query type is not supported by Statseeker.

Worldmap Preferences

The Worldmap Preferences section allows you to assign a global/default map tile provider to be used with the dashboard worldmap panel. This provider is a 3rd party service providing a dynamic, scalable map resource. There are a range of commercial and open-source tile providers available offering a hosted/online service or providing the framework for deploying and hosting your own internal tile server.

  • Default Map Provider URL - specify the URL used to access your default tile map service. The URLs for these services feature a number of notable parameters to identify the resource being displayed, these parameters are:
    • {s} - (optional) a random single-character subdomain, typically used by externally hosted services to spread the request load across multiple resources
    • {x} - the X-coordinate of the map tile
    • {y} - the Y-coordinate of the map tile
    • {z} - the zoom level of the map

    The order and location of these parameters within the URL may vary between providers. Refer to your map service provider's documentation for the appropriate URL, or utilize one of the example configurations provided below.

    Note: Statseeker requires that the {x}, {y} and {z} parameters are specified in lower-case.

    • If your provider documentation specifies the server URL as: https://maps-for-free.com/layer/relief/z{Z}/row{Y}/{Z}_{X}-{Y}.jpg
    • Statseeker requires the URL to be specified as: https://maps-for-free.com/layer/relief/z{z}/row{y}/{z}_{x}-{y}.jpg
  • Default Map Provider Subdomains - optionally, list the map provider subdomains to use. Each character in this string will be considered a valid value for the {s} parameter in the Default Map Provider URL. This is a single string, no spaces. See your map service provider's documentation for requirements.

    Example: abc

  • Default Map Provider Attribution - enter any licensing attribution content required by your map service provider, see your map service provider's documentation for requirements
  • Allow Custom Map Providers - grant/deny permission for your dashboard editors to specify an alternate, panel-specific, map provider in the Worldmap panel configuration

Example Service Provider URL Configurations
Map Default Map Provider URL Default Map Provider Attribution Subdomains
OpenStreet:Default http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png © OpenStreetMap abc
ArcGIS:NatGeo https://services.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer/tile/{z}/{y}/{x} Sources: National Geographic, Esri, DeLorme, HERE, UNEP-WCMC, USGS, NASA, ESA, METI, NRCAN, GEBCO, NOAA, iPC
maps-for-free https://maps-for-free.com/layer/relief/z{z}/row{y}/{z}_{x}-{y}.jpg © OpenStreetMap contributors
Esri:Topo https://services.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer/tile/{z}/{y}/{x}.jpg Sources: Esri, HERE, Garmin, Intermap, increment P Corp., GEBCO, USGS, FAO, NPS, NRCAN, GeoBase, IGN, Kadaster NL, Ordnance Survey, Esri Japan, METI, Esri China (Hong Kong), (c) OpenStreetMap contributors, and the GIS User Community
OpenTopo https://{s}.tile.opentopomap.org/{z}/{x}/{y}.png map data: © OpenStreetMap contributors, SRTM | map style: © OpenTopoMap (CC-BY-SA) abc
CartoDB Positron - light theme https://{s}.basemaps.cartocdn.com/rastertiles/light_all/{z}/{x}/{y}.png © OpenStreetMap © CartoDB abcd
CartoDB Positron - dark theme https://{s}.basemaps.cartocdn.com/rastertiles/dark_all/{z}/{x}/{y}.png © OpenStreetMap © CartoDB abcd

[top]