Geneos ["Geneos"]
["Geneos > Netprobe"]["Technical Reference"]

Uptrends

Overview

The Uptrends plugin for Geneos integrates the Synthetic Monitoring and RUM metrics from Uptrends. This plugin provides dataviews in Geneos showing details for the Monitors or Monitor group and RUM Websites configured in your Uptrends application. In Active Console, you can click from these dataviews to open the Uptrends dashboard in a browser.

The Uptrends plugin uses the Uptrends v4 APIs to get the data from the Uptrends application.

Note: The actual monitoring is done by Uptrends, therefore the configuration of the monitored items must be done in Uptrends.

Prerequisites

Java requirements

Caution: The Java installation and environment configuration is a common source of errors for users setting up Java-based components and plug-ins. It is recommended to read Configure the Java environment to help you understand your Java installation.

Uptrends API credentials

If you wish to use the Uptrends plugin, then you need the following: 

  • Uptrends API username

  • Uptrends API password

  • Uptrends account with access to RUM is only required if the Rum setting in GSE is enabled.

Note: This is different from the username for the main Uptrends account. For more information, see Uptrends API Account Authentication.

You must also be familiar with Uptrends, as well as how it is implemented in your organisation.

View

Monitor groups dataview

Shows the status of all the monitors associated with the given account.

Below is an example of the default dataview generated by the Uptrends plugin:

Table legend

Name Description
Monitor Name of the monitor.
Last Check

Date and time at which the monitor check was completed based on the signed-in operator's local time.

Error Code Numeric Uptrends error code in case of an error. Otherwise, the column value is 0.
Error Level

Describes the status of the monitor check. The following are the possible values: 

  • No Error — no error found.

  • Unconfirmed — an error was found.

  • Confirmed — an error was found and double-checked right after an Unconfirmed level.

  • Inactive — the monitor is set to not active.

Error Description

Describes the error found.

Uptime Percentage Percent of time the monitor was up.
Checkpoint Geographic location where the last monitor check was performed.
Total Time

Total amount of time it takes to complete the last monitor check.

Unit: milliseconds (ms)

Last Monitor Check Id ID of the last monitor check.

Monitor Guid

GUID of the monitor.
   

RUM dataview

Shows the list of RUM metrics for the monitored RUM websites.

Headline legend

Name Description
Aggregation Type Aggregation type used as defined in the Plugin configuration.
Preset Period

Period type used as defined in the configuration.

This will only show when the Period parameter is set to presetPeriod.

Start Time

Start time of the custom period.

This will only show if the Period parameter is set to customPeriod.

End Time

End time of the custom period.

This will only show if the Period parameter is set to customPeriod.

   

Table legend

Name Description
Website Name of the website as defined in the Plugin configuration.
Page Views Total number of page views.
Load Time

Performance standard agreed on based on the Uptrends SLA monitoring.

Unit: milliseconds (ms)

Network Duration

Combination of the redirect, DNS, and connection times.

Unit: milliseconds (ms)

Frontend Duration

Combined time for parsing and loading the Document Object Model (DOM) with the time to render the content for the page.

You can get the frontend durations based on the browser version used.

Unit: milliseconds (ms)

Backend Duration

Includes the times for sending and receiving information, but not the time to process and load the contents.

Unit: milliseconds (ms)

Download Time

Total time it takes to request, receive, process, and render the content.

The download time ends when the browser indicates that the DOM has fully loaded for the page.

Unit: milliseconds (ms)

Redirect Duration

Time it takes for the website to get redirected from one page to another.

If your site redirects user requests from one URL to another, you add time to the connection. Tracking the redirect duration can inform you of a potential problem in redirects.

Unit: milliseconds (ms)

DNS Duration

Combined time it takes to resolve the pages' URLs.

Unit: milliseconds (ms)

Connect Duration

Time it takes to complete a connection between the client and the server.

The connect duration includes the HTTPS handshake and the TCP connection.

Unit: milliseconds (ms)

Send Duration

Time that it takes to package and send data from the client to the server.

The more data that needs sending by the client the longer the send duration is.

Unit: milliseconds (ms)

Receive Duration

Time needed to send data from the server to the client.

The receive time is directly proportional to the amount of data sent and the connection speed. The slowest connection determines the total time for the receive duration.

Unit: milliseconds (ms)

DOM Duration

Amount of time it takes the browser to process the HTML (including scripts and CSS files) into a DOM.

Unit: milliseconds (ms)

Render Duration

Time it takes the browser to take the DOM content and display it on the screen.

The render duration is a direct measurement of the browser's processing speed.

Unit: milliseconds (ms)

Time To First Byte

When a user requests a resource, the time from their request until the browser receives the first byte of data is the time to first byte.

A long time to first byte is a signal that either the server’s response is slow or network latency is a problem for the user’s location and connection type.

Unit: milliseconds (ms)

Page Ready Time

Total time it takes to render the page completely including all interactive elements.

Unit: milliseconds (ms)

WebsiteID

guid of the website as defined in the Uptrends application.

   

Plugin configuration

Note: The Uptrends application performs caching. When creating a sampler for the Uptrends plugin, it is recommended to set the Sample interval to 40.

Basic configuration

Field Description
API Username

Username of your Uptrends API account.

This is different from the username for the main Uptrends account. For more information, see Uptrends API Account Authentication.

Mandatory: Yes

Password

Password of your Uptrends API account.

This is different from the password for the main Uptrends account. For more information, see Uptrends API Account Authentication.

Mandatory: Yes

Monitor groups

Specifies the monitor groups configured in the Uptrends application to be displayed in the dataview. One monitor group generates one dataview displaying all the monitors from that group.

If no monitor group is set, then all the monitors will be displayed in one dataview.

If there is a duplicate monitor group in Uptrends application, then only the first captured group generates a dataview.

Mandatory: No

Rum > Enabled

If enabled, the RUM metrics dataview will be displayed. By default, this setting is disabled because most accounts do not have RUM.

For accounts that do not have access to RUM, the samplingStatus in the RUM metrics dataview will show an error message HTTP error 403 - Forbidden.

Rum > Website filters

Specifies the list of RUM website names, defined in the Uptrends application, that you want to see in the Geneos dataview.

This can accept wildcard characters such as * and ? where * means 0 or more characters, while ? means 1 character.

Note: Uptrends RUM Website names should not contain a vertical bar (|) character. Otherwise, the website filtering will not work. This is a limitation of the Uptrends API which uses (|) as a delimiter to separate multiple filters.

Default: All websites defined in the Uptrends application

Rum > Aggregation type

Type of aggregation of RUM data to show in the dataview.

Possible values: Average, Maximum, Median, Minimum

Default: Median

Rum > Period

Time period to filter the data.

Possible values: 

  • Preset period — a list of predefined periods.

  • Custom period — user-specified start time and end time.

Default: Preset Period = Last 24 hours

   

Advanced configuration

Field Description
Timeout

Number of seconds the Uptrends plugin waits for a response from the server URL.

If the server URL takes longer than the timeout value, then the Uptrends plugin reports a timeout and displays no data in the affected dataview.

You can toggle between entering a numerical value (data) or a variable (var).

Mandatory: No

Default value: 10

Note: If no timeout is specified, then this plugin follows the default value. If the platform (for example, Windows) where the sampler is running has its own timeout setting for establishing connections, then this takes precedence over the configured timeout of the plugin.

However, if a connection to the URL has already been established, the plugin will use the configured timeout when waiting for a response from the URL.
   

Run a command

Monitor groups dataview

The View Dashboard in Uptrends command can be accessed when you right-click a cell in the dataview. This command opens the corresponding Monitor Dashboard in the Uptrends dashboard using your default browser.

Active Console dataview:

Uptrends dashboard:

The View Last Monitor Check Details command can be accessed when you right-click a cell in the dataview. This command opens the corresponding Last Monitor Check Details in the Uptrends UI using your default browser.

Active Console dataview:

Uptrends Check details window:

RUM dataview

The View RUM Details command can be accessed when you right-click a cell in the dataview. This command opens the corresponding RUM overview page in the Uptrends UI using your default browser.

Active Console dataview:

Uptrends RUM overview dashboard: