Oracle Cloud Infrastructure Documentation

Monitoring Templates

Monitoring Templates simplify the process of managing alarm settings for systems and large numbers of resources by enabling you to define metric alarm rule settings once across all resources in a single UI. This approach saves time and ensures consistency across large-scale environments.

Note

An Enterprise Edition license is required to use Monitoring Templates.

  1. About Monitoring Templates
    1. Oracle-Certified Monitoring Templates
  2. Creating a Monitoring Template
    1. Add an alarm condition
    2. Edit an alarm condition
  3. Viewing Monitoring Templates
  4. Editing a Monitoring Template
  5. Policies
  6. Exporting and Importing Monitoring Templates

About Monitoring Templates

Monitoring Templates can be created for one or more individual resources (e.g. hosts, Database system, E-Business Suite app) or for all resources of a specified type (e.g. all hosts).

A Monitoring Template is created either through the UI or via command line interface (OCI-CLI). Once created, the appropriate OCI alarm rules will be auto-generated and used by OCI Monitoring for alarm evaluation. Stack Monitoring Administrators have FULL access on all Monitoring Templates. However, the stack-monitoring-monitoring-template policy privilege can be added to any user or group responsible for creating or updating Monitoring Templates, who may not be Stack Monitoring administrators.

As part of monitoring template functionality, the background workflow will create/update/delete alarms when the resources license in a monitoring template gets altered.

There are two resource privileges that can be granted to a user/role that allows you to create and/or view Monitoring Templates:

  • Create Monitoring Template: This privilege allows you to create a Monitoring Template.
  • View any Monitoring Template: This privilege allows you to view any Monitoring Template

A Monitoring Template includes:

  • Name: A unique name for the template. The template name must be globally unique across all compartments.
  • Description: Optional text describing the purpose of the template.
  • Alarm Summary: Human-readabile summary of alarm.
  • Resource Type(s): Resource type to which the template applies.
  • Alarm Conditions(s) : Alarm condition containing metric compartment, namespace, resource group, name, interval, statistic and when required dimension name and value.
  • Notification(s): Alarm notification details such as operator, value, trigger delay, severity, and alarm body.

Oracle-Certified Monitoring Templates

Oracle-Certified Monitoring Templates are provided for key resources types such as Oracle Database, WebLogic Server, E-Business Suite, and Host. These templates contain the recommended metrics and thresholds for these resource types. Oracle-Certified templates can be cloned to help you start monitoring quickly. Then add or remove metrics, adjust thresholds, and define the alarm rule notification settings as needed.

Example:

The template called PeopleSoft Application (Oracle-Certified). The PeopleSoft Application monitoring template contains alarm definitions capable of monitoring a complete PeopleSoft application topology including Application Server Domain, PIA, Elasticsearch, Process Monitoring, and Process Scheduler Domain. Alternatively, the template can be cloned to create your own template allowing additional metrics and thresholds to meet your business requirements.

Creating a Monitoring Template

To create a custom Monitoring Template, click Create. Begin by completing the Monitoring Template properties including name, description, and if you wish to include one or more Oracle-Certified template(s). Including an Oracle-certified template within a custom template will help jump start the creation of a custom Monitoring Template by including Oracle best practice metrics and thresholds, this reduces the time to create a Monitoring Template.

When an Oracle-certified template is chosen, the resource type(s) included in the template will automatically be added to the resource section of the Monitoring Template definition. Individual resources can be chosen in lieu of Resource Types by selecting the individual resources radio button, then choosing the specific resources from the list of resources with Enterprise Edition license.

Add an alarm condition

To add an alarm condition to a Monitoring Template, click Add condition. The steps to add an alarm condition follows the same process when defining an alarm rule condition in OCI Monitoring, with a couple exceptions. From the alarm condition slide-out, first select the resource type from the drop-down menu. The namespace will automatically be populated, however if you you wish to include a Metric Extension, select the namespace oracle_metric_extension_oracle_appmgmt.

Metric condition type can be:

  • Availability - Choose this condition when you wish to evaluate the resource as up, down, and not reporting. Stack Monitoring will then pre-populate the collection interval, as well as include for both down (0 value) and not reporting (no reported data received).
  • Fixed
Note

For operational efficiency, the number of alarm conditions in a Monitoring Template is limited at 30.

Edit an alarm condition

To edit an alarm rule click the action icon, and select Edit. From the alarm condition definition, update the condition as necessary and select update condition to save your changes.

Viewing Monitoring Templates

To view a list of all Monitoring Templates, under the Stack Monitoring menu, select Monitoring Templates under Monitoring setup.

The Monitoring Template page displays all Oracle Certified and custom created templates.

Editing a Monitoring Template

From the Monitoring Templates page, identify the Monitoring Template you wish to edit, and click the action button, and select edit. To edit a template, you must have FULL access privileges.

Note

Alarm rule definitions should always be changed within the Monitoring Template, not the individual alarm rule within the Alarm Definitions page of OCI Monitoring.

Exporting and Importing Monitoring Templates

For portability, monitoring templates can be exported to an JSON file and then imported into another compartment as an active template.

Exporting a Monintoring Template

To export a template to an XML file:

  1. From the Stack Monitoring menu, select Monitoring setup and then Monitoring Templates.
  2. Select the desired monitoring template from the table.
  3. Click Export.

Importing a Monintoring Template

To import a template from an JSON file:

  1. From the Stack Monitoring menu, select Monitoring setup and then Monitoring Templates.
  2. Click Import. The file selector displays.
  3. Specify the monitoring template JSON file you want to import.
  4. Click Import.

Policies

Users which are part of StackMonitoringAdminGrp created as part of Stack Monitoring's Easy Onboarding, have all the required permissions to do all operations related to Monitoring Templates like create, update, delete, export, apply and unapply.

The background workflows need to modify alarms created using the Monitoring Template whenever there are lifecycle or license changes to the resource in the alarm. To accomplish this, the workflows require the resource principal to interact with the Telemetry service and perform actions such as creating, updating, retrieving, or deleting alarms created by the Monitoring Template. Therefore, the following policies must be applied to the resource principal type stackmonmontemplaterp.

Monitoring Templates Event Workflow Policies:

Policy Description
ALLOW any-user TO MANAGE alarms IN COMPARTMENT <compartment_name> where request.principal.type = 'stackmonmontemplaterp' Allows resource principal to manage alarm creation in the telemetry service.
ALLOW any-user TO READ metrics IN COMPARTMENT <compartment_name> where request.principal.type = 'stackmonmontemplaterp' Allows resource principal to read metric from telemetry.
ALLOW any-user TO USE streams IN COMPARTMENT <compartment_name> where request.principal.type = 'stackmonmontemplaterp' Allows resource principal to use streams while creating alarm in the telemetry service.
ALLOW any-user TO USE ons-topics IN COMPARTMENT <compartment_name> where request.principal.type = 'stackmonmontemplaterp' Allows resource principal to use topic while creating alarm in the telemetry service.

In other cases, if you want to create a new group of users who can only apply/unapply already created Monitoring Templates from the admin group, such a user can be made part of a new group, for example, MtOperatorGroup, and can be set up by applying all the policies below.

Policies for Monitoring Template operators:

Policy Description
ALLOW GROUP MtOperatorGroup to MANAGE alarms IN COMPARTMENT <compartment_name> Allows the group MtOperatorGroup to be able to create/update/delete Alarms.
ALLOW GROUP MtOperatorGroup to READ metrics IN COMPARTMENT <compartment_name> Allows the group MtOperatorGroup to be able to create/get/update Alarms.
ALLOW GROUP MtOperatorGroup to USE ons-topics IN COMPARTMENT <compartment_name> Allows the group MtOperatorGroup to be able to create Alarms.
ALLOW GROUP MtOperatorGroup to USE streams IN COMPARTMENT <compartment_name> Allows the group MtOperatorGroup to be able to create Alarms.
ALLOW GROUP MtOperatorGroup TO USE stack-monitoring-monitoring-template IN COMPARTMENT <compartment_name> Allows the group MtOperatorGroup to be able to apply/unapply a Monitoring Template.