---
title: "Host Template: Cloud - Uptrends - Synthetics"
description: ""
url: "https://docs.itrsgroup.com/docs/opsview/current/opspacks/cloud-uptrends-opspack/cloud-uptrends-synthetics-host-template/index.html"
---## Overview

Monitor the uptime, performance, and accuracy of your websites, APIs, web applications, and servers.

This Host Template includes the following Service Checks:

| Service&nbsp;Check&nbsp;Name | Description | Default&nbsp;Thresholds (Metric:&nbsp;Warning,&nbsp;Critical) | UOM |
|:-----------------------------|:------------|:------------------------------------------------:|:---:|
| Uptrends - Synthetics - Status | The HTTP status of the monitor check | N/A | N/A |
| Uptrends - Synthetics - Load Time | The time taken to run the monitor check | N/A | ms |
| Uptrends - Synthetics - Total Bytes | The total bytes loaded running the monitor check | N/A | B |
| Uptrends - Synthetics - Uptime | The percentage uptime | uptime: &#8203;`90:`,`70:` | % |
| Uptrends - Synthetics - Alerts | The number of alerts raised | N/A | N/A |
| Uptrends - Synthetics - Errors | The number of confirmed and unconfirmed errors | N/A | N/A |


**Note**


See details about [Monitoring Plugin thresholds here](https://www.monitoring-plugins.org/doc/guidelines.html#THRESHOLDFORMAT).



## Usage Instructions

Please review the overall [Cloud - Uptrends Opspack](https://docs.itrsgroup.com/docs/opsview/current/opspacks/cloud-uptrends-opspack/cloud-uptrends-opspack/index.html) documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.

### Add this Host Template

Add the **Cloud - Uptrends - Synthetics** Host Template to your Opsview Monitor host.
If the resource you're monitoring has no hostname or public IP, then open the **Advanced** settings pane and change **Host Check Command** to **Always assumed to be UP**.


**Note**


For more information, refer to the documentation on [Adding Host Templates to Hosts](https://docs.itrsgroup.com/docs/opsview/current/host/index.html#host-templates).



### Add and configure Variables

The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance alongside the Host Template:

- [**UPTRENDS_CREDENTIALS**](#uptrends_credentials)
- [**UPTRENDS_MONITOR_GUID**](#uptrends_monitor_guid)
- [**UPTRENDS_CHECK_DETAILS**](#uptrends_check_details)


**Note**


For more information, refer to the documentation on [Adding Variables to Hosts](https://docs.itrsgroup.com/docs/opsview/current/adding-a-new-variable/index.html#adding-a-variable-to-a-host).



### Apply Changes

Apply Changes and the system will now be monitored:

![View Output](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-uptrends-output-cloud-uptrends-synthetics.png)

## Available Variables

### UPTRENDS_CREDENTIALS

The Value is not used and therefore can be set to anything. Override the arguments with your Uptrends API account credentials.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| N/A (Opsview UI Only) | Value | Credentials | The credentials for your Uptrends API account |
| `--username` | Arg1 | Username | The username for your Uptrends API account |
| `--password` | Arg2 | Password | The password for your Uptrends API account |

### UPTRENDS_MONITOR_GUID

Set this value to the GUID of your Uptrends Monitor. You can retrieve this value from the URL of your Uptrends Monitor dashboard.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| `--monitor-guid` | Value | Monitor GUID | The GUID of the Uptrends monitor |

### UPTRENDS_CHECK_DETAILS

The Value is not used and therefore can be set to anything. Override the Time Period with one of:

- CurrentDay
- CurrentWeek
- CurrentMonth
- CurrentQuarter
- CurrentYear
- PreviousDay
- PreviousWeek
- PreviousMonth
- PreviousQuarter
- PreviousYear
- Last2Hours
- Last6Hours
- Last12Hours
- Last24Hours
- Last48Hours
- Last7Days
- Last30Days
- Last60Days
- Last90Days
- Last365Days
- Last3Months
- Last6Months
- Last12Months
- Last24Months
- All

Default: Last24Hours

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| N/A (Opsview UI Only) | Value | Details | The details for your Uptrends checks |
| `--time-period` | Arg1 | Time Period | The requested time period for the Uptrends check |

## Plugin help

Plugin: `check_uptrends`


**Secure Args**


This plugin uses the [Secure Args](https://docs.itrsgroup.com/docs/opsview/current/configuration/secure-arguments/index.html) feature for argument passing.



For mode-specific help, run the plugin with the `-h -m <mode>` flags. This will list the required and optional Variable Arguments for that mode.
The appropriate mode for each Service Check is listed here:

| Service&nbsp;Check&nbsp;Name | Mode |
|:-----------------------------|:-----|
| Uptrends - Synthetics - Status | `Uptrends.Synthetics.Status` |
| Uptrends - Synthetics - Load Time | `Uptrends.Synthetics.Load.Time` |
| Uptrends - Synthetics - Total Bytes | `Uptrends.Synthetics.Total.Bytes` |
| Uptrends - Synthetics - Uptime | `Uptrends.Synthetics.Uptime` |
| Uptrends - Synthetics - Alerts | `Uptrends.Synthetics.Alerts` |
| Uptrends - Synthetics - Errors | `Uptrends.Synthetics.Errors` |


