Enabling Oracle Database Monitoring for Siebel CRM

This section explains how to enable Oracle Database monitoring during a new Siebel CRM deployment or for an existing Siebel CRM environment. It includes the following subsections:

• Enabling Oracle Database Monitoring during Siebel CRM Deployment
• Enabling Oracle Database Monitoring on an Existing Siebel CRM Deployment
• Enabling Oracle Database Monitoring on an Existing Siebel CRM Deployment with Siebel Monitoring Enabled

Enabling Oracle Database Monitoring during Siebel CRM Deployment

To enable Oracle Database monitoring during Siebel CRM deployment, you must update the Siebel CRM deployment payload as follows:

• Set the enable_oracle_db_monitoring parameter to true.
• Configure the auth_info section based on the database type.

The following observability section snippet shows how to enable database monitoring when the database type is set to ATP or DBCS_VM:

{
   <Siebel deployment payload>
   "observability":
   {
      "siebel_monitoring": true,  
      "enable_oracle_db_monitoring": "true",
      "auth_info": { 
         "db_metrics_exporter_password": "<metrics user's password>",
         "data_as_metrics_exporter_password": "<custom query user's password>"
      }
   }
}

The following observability section snippet shows how to enable database monitoring when the database type is set to BYOD:

Note: You must ensure that all the prerequisites listed in the Prerequisites for Enabling Oracle Database Monitoring for BYOD section are met.

{
   <Siebel deployment payload>
   "observability":
   {
      "siebel_monitoring": true,        
      "enable_oracle_db_monitoring": "true",
      "auth_info": {
         "db_metrics_exporter_username": "<metrics user's username>",
         "db_metrics_exporter_password": "<metrics user's password>",
         "wallet_path": "<db wallet path>",
         "tns_connection_name": "<tns connection name>",
         "data_as_metrics_exporter_username": "<custom query user's username>",
         "data_as_metrics_exporter_password": "<custom query user's password>"
      }
   }
}

For more information on the parameter, see Parameters in Payload Content.

Enabling Oracle Database Monitoring on an Existing Siebel CRM Deployment

You can enable Oracle Database monitoring on an existing Siebel CRM environment that was deployed using SCM by submitting a POST request using the observability API.

To enable Oracle Database monitoring on an existing environment:

1. Create the JSON payload:
   • When the database type is set to ATP or DBCS_VM as shown below:

     {
        "observability":
        {
           "siebel_monitoring": true,
           "enable_oracle_db_monitoring": "true",
           "auth_info": {
              "db_metrics_exporter_password": "<metrics user's password>",
              "data_as_metrics_exporter_password": "<custom query user's password>"
           }
        }
     }

   • When the database type is set to BYOD as shown below:
     Note: You must ensure that all the prerequisites listed in the Prerequisites for Enabling Oracle Database Monitoring for BYOD section are met.

     {
        "observability":
        {
           "siebel_monitoring": true,
           "enable_oracle_db_monitoring": "true",
           "auth_info": {
              "db_metrics_exporter_username": "<metrics user's username>",
              "db_metrics_exporter_password": "<metrics user's password>",
              "wallet_path": "<db Wallet path>",
              "tns_connection_name": "<tns connection name>",
              "data_as_metrics_exporter_username": "<custom query user's username>",
              "data_as_metrics_exporter_password": "<custom query user's password>"
           }
        }
     }

2. Submit the payload using a POST request to the observability API, as shown below:

   POST https://<SCM_instance_IP>:<port_num>/scm/api/v1.0/environment/<ENV_ID>/observability

For more information on the parameters, see Parameters in Payload Content.

Enabling Oracle Database Monitoring on an Existing Siebel CRM Deployment with Siebel Monitoring Enabled

You can enable Oracle Database monitoring on an existing Siebel CRM environment that already has Siebel CRM monitoring enabled by submitting a POST request using the observability API. In this case, since Siebel CRM monitoring is already enabled, you need not set the siebel_monitoring parameter to true.

To enable Oracle Database monitoring on an existing environment that has Siebel CRM monitoring enabled:

1. Create the JSON payload:
   • When the database type is set to ATP or DBCS_VM as shown below:

     {
        "observability":
        {
           "enable_oracle_db_monitoring": "true",
           "auth_info": {
              "db_metrics_exporter_password": "<metrics_user's password>",
              "data_as_metrics_exporter_password": "<custom_query_user's password>"
           }
        }
     }

   • When the database type is set to BYOD as shown below:
     Note: You must ensure that all the prerequisites listed in the Prerequisites for Enabling Oracle Database Monitoring for BYOD section are met.

     {
        "observability":
        {
           "enable_oracle_db_monitoring": "true",
           "auth_info": {
              "db_metrics_exporter_username": "<metrics user's username>",
              "db_metrics_exporter_password": "<metrics user's password>",
              "wallet_path": "<db Wallet path>",
              "tns_connection_name": "<tns connection name>",
              "data_as_metrics_exporter_username": "<custom query user's username>",
              "data_as_metrics_exporter_password": "<custom query user's password>"
           }
        }
     }

2. Submit the payload using a POST request to the observability API, as shown below:

   POST https://<SCM_instance_IP>:<port_num>/scm/api/v1.0/environment/<ENV_ID>/observability

For more information on the parameters, see Parameters in Payload Content.