--- title: "Host Template: Opsview - Component - Orchestrator" description: "" url: "https://docs.itrsgroup.com/docs/opsview/current/opspacks/opsview-self-monitoring-opspack/opsview-component-orchestrator-host-template/index.html" ---## Overview Monitor your Opsview - Orchestrator component. This Host Template includes the following Service Checks: | Service Check Name | Description | Default Thresholds (Metric: Warning, Critical) | UOM | |:-----------------------------|:------------|:------------------------------------------------:|:---:| | Opsview - Orchestrator - Status | Monitor the status of the opsview-orchestrator component. | N/A | N/A | | Opsview - Orchestrator - Message Queue Rate | Monitors the performance of the opsview-orchestrator message queue. | N/A | mps | | Opsview - Orchestrator - Message Queue Count | Monitors the number of messages currently in the opsview-orchestrator message queue. | N/A | msgs | **Note** See details about [Monitoring Plugin thresholds here](https://www.monitoring-plugins.org/doc/guidelines.html#THRESHOLDFORMAT). ## Usage Instructions Please review the overall [Opsview - Self Monitoring Opspack](https://docs.itrsgroup.com/docs/opsview/current/opspacks/opsview-self-monitoring-opspack/opsview-self-monitoring-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 **Opsview - Component - Orchestrator** 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: - [**SELF_MONITORING_CPU_THRESHOLDS**](#self_monitoring_cpu_thresholds) - [**SELF_MONITORING_MEMORY_THRESHOLDS**](#self_monitoring_memory_thresholds) - [**SELF_MONITORING_CHILD_THRESHOLDS**](#self_monitoring_child_thresholds) - [**SELF_MONITORING_UPTIME_THRESHOLDS**](#self_monitoring_uptime_thresholds) - [**SELF_MONITORING_CONFIG**](#self_monitoring_config) - [**SELF_MONITORING_CERTIFICATES**](#ssl-certificates-self_monitoring_certificates) - [**SELF_MONITORING_PUBLISH_THRESHOLDS**](#self_monitoring_publish_thresholds) - [**SELF_MONITORING_DELIVER_THRESHOLDS**](#self_monitoring_deliver_thresholds) - [**SELF_MONITORING_RATIO_THRESHOLDS**](#self_monitoring_ratio_thresholds) - [**SELF_MONITORING_COUNT_THRESHOLDS**](#self_monitoring_count_thresholds) **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-opsview-self-monitoring-output-opsview-component-orchestrator.png) ## Available Variables ### SELF_MONITORING_CPU_THRESHOLDS The Value is not used and therefore can be set to anything. Override the arguments with your CPU thresholds. | Plugin Parameter | Position in Variable | Name | Description | |:---------------------:|:-------------------------:|:-----|:------------| | N/A (Opsview UI Only) | Value | | | | `--cpu-warning` | Arg1 | CPU usage warning threshold | Warning threshold for CPU usage check | | `--cpu-critical` | Arg2 | CPU usage critical threshold | Critical threshold for CPU usage check | ### SELF_MONITORING_MEMORY_THRESHOLDS The Value is not used and therefore can be set to anything. Override the arguments with your memory thresholds. | Plugin Parameter | Position in Variable | Name | Description | |:---------------------:|:-------------------------:|:-----|:------------| | N/A (Opsview UI Only) | Value | | | | `--mem-warning` | Arg1 | Memory usage percentage warning threshold | Warning threshold for memory usage check | | `--mem-critical` | Arg2 | Memory usage percentage critical threshold | Critical threshold for memory usage check | | `--mem-used-warning` | Arg3 | Memory used warning threshold in bytes | Warning threshold for memory used check | | `--mem-used-critical` | Arg4 | Memory used critical threshold in bytes | Critical threshold for memory used check | ### SELF_MONITORING_CHILD_THRESHOLDS The Value is not used and therefore can be set to anything. Override the arguments with your child process count thresholds. | Plugin Parameter | Position in Variable | Name | Description | |:---------------------:|:-------------------------:|:-----|:------------| | N/A (Opsview UI Only) | Value | | | | `--child-warning` | Arg1 | Child process count warning threshold | Warning threshold for child process count check | | `--child-critical` | Arg2 | Child process count critical threshold | Critical threshold for child process count check | ### SELF_MONITORING_UPTIME_THRESHOLDS The Value is not used and therefore can be set to anything. Override the arguments with your uptime thresholds. | Plugin Parameter | Position in Variable | Name | Description | |:---------------------:|:-------------------------:|:-----|:------------| | N/A (Opsview UI Only) | Value | | | | `--uptime-warning` | Arg1 | Uptime warning threshold | Warning threshold for uptime check | | `--uptime-critical` | Arg2 | Uptime critical threshold | Critical threshold for uptime check | ### SELF_MONITORING_CONFIG The Value is not used and therefore can be set to anything. Override the arguments with your configuration. | Plugin Parameter | Position in Variable | Name | Description | |:---------------------:|:-------------------------:|:-----|:------------| | N/A (Opsview UI Only) | Value | | | | `--min-message-count` | Arg1 | Minimum message count | Minimum message count for thresholds to be applied | ### SELF_MONITORING_PUBLISH_THRESHOLDS The Value is not used and therefore can be set to anything. Override the arguments with your publish thresholds. | Plugin Parameter | Position in Variable | Name | Description | |:---------------------:|:-------------------------:|:-----|:------------| | N/A (Opsview UI Only) | Value | | | | `--publish-warning` | Arg1 | Publish Rate warning threshold | Warning threshold for publish rate check | | `--publish-critical` | Arg2 | Publish Rate critical threshold | Critical threshold for publish rate check | ### SELF_MONITORING_DELIVER_THRESHOLDS The Value is not used and therefore can be set to anything. Override the arguments with your deliver thresholds. | Plugin Parameter | Position in Variable | Name | Description | |:---------------------:|:-------------------------:|:-----|:------------| | N/A (Opsview UI Only) | Value | | | | `--deliver-warning` | Arg1 | Deliver Rate warning threshold | Warning threshold for deliver rate check | | `--deliver-critical` | Arg2 | Deliver Rate critical threshold | Critical threshold for deliver rate check | ### SELF_MONITORING_RATIO_THRESHOLDS The Value is not used and therefore can be set to anything. Override the arguments with your publish/deliver ratio thresholds. | Plugin Parameter | Position in Variable | Name | Description | |:---------------------:|:-------------------------:|:-----|:------------| | N/A (Opsview UI Only) | Value | | | | `--ratio-warning` | Arg1 | Publish/Deliver ratio warning threshold | Warning threshold for ratio check | | `--ratio-critical` | Arg2 | Publish/Deliver ratio critical threshold | Critical threshold for ratio check | ### SELF_MONITORING_COUNT_THRESHOLDS The Value is not used and therefore can be set to anything. Override the arguments with your message count thresholds. | Plugin Parameter | Position in Variable | Name | Description | |:---------------------:|:-------------------------:|:-----|:------------| | N/A (Opsview UI Only) | Value | | | | `--count-warning` | Arg1 | Message count warning threshold | Warning threshold for message count check | | `--count-critical` | Arg2 | Message count critical threshold | Critical threshold for message count check | ### SSL Certificates: SELF_MONITORING_CERTIFICATES **Opsview Cloud** For Opsview Cloud customers, please contact [ITRS Support](https://www.itrsgroup.com/about/contact) for assistance with setting up certificate files, as they require Orchestrator access. Additionally, you can use the **SELF_MONITORING_CERTIFICATES** variable to pass in your SSL certificates for use when connecting to the service provider to gather metrics: | Parameter | Position in Variable | Name | Description | |:---------:|:--------------------:|:-----|:------------| | `--ca-path` | Arg1 | CA Certificate Path | Path to the CA Certificate | | `--client-cert` | Arg2 | Client Certificate Path | Path to the Client Certificate | | `--client-key` | Arg3 | Client Key Path | Path to the Client Key | ## Plugin help Plugin: `check_opsview` **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 ` flags. This will list the required and optional Variable Arguments for that mode. The appropriate mode for each Service Check is listed here: | Service Check Name | Mode | |:-----------------------------|:-----| | Opsview - Orchestrator - Status | `SM.Orchestrator.Status` | | Opsview - Orchestrator - Message Queue Rate | `SM.Orchestrator.MQ.Rate` | | Opsview - Orchestrator - Message Queue Count | `SM.Orchestrator.MQ.Count` |