Host Template: Cloud - Azure - Elastic Pool
Overview Copied
The Elastic database features of Azure SQL Database are designed to simplify data tier development and management, especially for Software as a Service (SaaS) developers, where large numbers of databases are used to support a dynamic end-customer base.
This Host Template includes the following Service Checks:
Service Check Name | Description | Default Thresholds (Metric: Warning, Critical) | UOM |
---|---|---|---|
Azure - EP - Allocated Storage | The allocated data storage [Default Timespan = 5mins, Default Check Interval = 5mins] |
N/A | B |
Azure - EP - Allocated Storage Percent | The percentage of storage allocated [Default Timespan = 5mins, Default Check Interval = 5mins] |
allocated_data_storage_percent: |
% |
Azure - EP - CPU Usage | The percentage of CPU being used [Default Timespan = 5mins, Default Check Interval = 5mins] |
cpu_percent: |
% |
Azure - EP - CPU Used | The CPU limit and number of CPUs used for the elastic pool [Default Timespan = 5mins, Default Check Interval = 5mins] |
N/A | N/A |
Azure - EP - Data IO Percent | The data IO percentage [Default Timespan = 5mins, Default Check Interval = 5mins] |
physical_data_read_percent: |
% |
Azure - EP - eDTU Usage Percent | The eDTU percentage used for the elastic pool [Default Timespan = 5mins, Default Check Interval = 5mins] |
edtu_usage_percent: |
% |
Azure - EP - eDTU Used | The eDTU limit and eDTU used for the elastic pool [Default Timespan = 5mins, Default Check Interval = 5mins] |
N/A | N/A |
Azure - EP - Log IO Percent | The log IO percentage [Default Timespan = 5mins, Default Check Interval = 5mins] |
log_write_percent: |
% |
Azure - EP - Process CPU Usage | CPU usage of the SQL DB process as a percentage [Default Timespan = 5mins, Default Check Interval = 5mins] |
sqlserver_process_core_percent: |
% |
Azure - EP - Process Memory Usage | Memory usage of the SQL DB process as a percentage [Default Timespan = 5mins, Default Check Interval = 5mins] |
sqlserver_process_memory_percent: |
% |
Azure - EP - Sessions Percent | The percentage of sessions used [Default Timespan = 5mins, Default Check Interval = 5mins] |
sessions_percent: |
% |
Azure - EP - Storage Usage | The percentage of storage used [Default Timespan = 5mins, Default Check Interval = 5mins] |
storage_percent: |
% |
Azure - EP - Storage Used | The amount of data space used [Default Timespan = 5mins, Default Check Interval = 5mins] |
N/A | B |
Azure - EP - Tempdb Percent | The Tempdb log used percentage [Default Timespan = 5mins, Default Check Interval = 5mins] |
tempdb_log_used_percent: |
% |
Azure - EP - Tempdb Used | The Tempdb data size and log size [Default Timespan = 5mins, Default Check Interval = 5mins] |
N/A | B |
Azure - EP - Workers Percent | The percentage of workers [Default Timespan = 5mins, Default Check Interval = 5mins] |
workers_percent: |
% |
Azure - EP - XTP Storage Percent | The percentage of XTP (in-memory OLTP) storage used [Default Timespan = 5mins, Default Check Interval = 5mins] |
xtp_storage_percent: |
% |
Note
The “Default Timespan” given for these Service Checks refers to the time period we use when retrieving metrics from Azure.
Note
See details about Monitoring Plugin thresholds here.
Dynamic Thresholds Support Copied
Some Service Checks within this Host Template support Dynamic Thresholds for Opsview Enterprise.
Prerequisites for monitoring Copied
Provide Subscription Access Copied
To use this Host Template you will need to provide access to the subscription you wish to monitor. Navigate to the Subscriptions section and select your Subscription.
In the Subscription to be monitored, click Access Control (IAM).
Then click the Add button, select the required role and select the application, once for each of the following roles:
- Reader
Repeat these steps for each subscription you wish to monitor.
Usage Instructions Copied
Please review the overall Cloud - Azure Opspack documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.
Add this Host Template Copied
Add the Cloud - Azure - Elastic Pool 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.
Add and configure Variables Copied
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:
Note
For more information, refer to the documentation on Adding Variables to Hosts.
Apply Changes Copied
Apply Changes and the system will now be monitored:
Additional Information Copied
Note:
Unlike in other Azure Host Templates, the Resource Name field (Arg2) of the AZURE_RESOURCE_DETAILS variable should be set to the name of the SQL Server while the Elastic Pool Name field (Arg1) of the AZURE_EP_SETTINGS variable should be set to the name of the Elastic Pool (See ‘Add and configure variables’ for further details).
Here the SQL Server name is shown in red while the Elastic Pool name is shown in blue.
The following Service Checks will return UNKNOWN
if they are not applicable to your Elastic Pool type:
- Azure - EP - CPU Used: only supports vCore-based Elastic Pools.
- Azure - EP - eDTU Usage Percent: only supports DTU-based Elastic Pools.
- Azure - EP - eDTU Used: only supports DTU-based Elastic Pools.
Use the Elastic Pool Type field (Arg2) of the AZURE_EP_SETTINGS variable to specify the Elastic Pool type.
Available Variables Copied
AZURE_CREDENTIALS Copied
The Value is not used and therefore can be set to anything. Override the arguments with your Azure Credentials.
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
N/A (Opsview UI Only) | Value | Credentials | The credentials for your Azure Subscription |
--subscription-id |
Arg1 | Subscription ID | The Subscription ID of your Azure Subscription |
--client-id |
Arg2 | Client ID | The Client ID of your Azure Subscription |
--secret-key |
Arg3 | Secret Key | The Secret Key of your Azure Subscription |
--tenant-id |
Arg4 | Tenant ID | The Tenant ID of your Azure Subscription |
AZURE_RESOURCE_DETAILS Copied
The Value is not used and therefore can be set to anything. Override the arguments with your Azure Resource Details.
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
N/A (Opsview UI Only) | Value | Resource Details | The details of your Azure Resource |
--resource-group |
Arg1 | Resource Group | Name of the Azure resource group of your resource |
--resource-name |
Arg2 | Resource Name | Name of the Azure resource to be monitored |
AZURE_EP_SETTINGS Copied
The Value is not used and therefore can be set to anything. Override the arguments with your Azure Elastic Pool details.
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
N/A (Opsview UI Only) | Value | Elastic Pool Settings | The settings for Azure Elastic Pool |
--ep-name |
Arg1 | Elastic Pool Name | The name of your Azure Elastic Pool |
--ep-type |
Arg2 | Elastic Pool Type | The type of your Azure Elastic Pool (valid types are 'DTU' or 'vCore', defaults to 'DTU') |
Plugin help Copied
Plugin: check_azure
Secure Args
This plugin uses the Secure Args 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 Check Name | Mode |
---|---|
Azure - EP - Allocated Storage | EP.Allocated.Storage |
Azure - EP - Allocated Storage Percent | EP.Allocated.Percent |
Azure - EP - CPU Usage | EP.CPU.Percent |
Azure - EP - CPU Used | EP.CPU.Used |
Azure - EP - Data IO Percent | EP.Data.IO.Percent |
Azure - EP - eDTU Usage Percent | EP.eDTU.Usage.Percent |
Azure - EP - eDTU Used | EP.eDTU.Used |
Azure - EP - Log IO Percent | EP.Log.Io.Percent |
Azure - EP - Process CPU Usage | EP.CPU.Usage |
Azure - EP - Process Memory Usage | EP.Memory.Percent |
Azure - EP - Sessions Percent | EP.Sessions.Percent |
Azure - EP - Storage Usage | EP.Storage.Usage |
Azure - EP - Storage Used | EP.Storage.Used |
Azure - EP - Tempdb Percent | EP.Tempdb.Percent |
Azure - EP - Tempdb Used | EP.Tempdb.Used |
Azure - EP - Workers Percent | EP.Workers.Percent |
Azure - EP - XTP Storage Percent | EP.XTP.Storage.Percent |