Scenario: Alarming on Log Data

If you're a member of the Administrators group, you already have the required access to execute this scenario. Otherwise, you need access to Monitoring and Notifications.

The workflow for creating the connector includes a default policy when needed to provide permission for writing to the target service. If you're new to policies, see Getting Started with Policies and Common Policies.

Setup is easy in the Console. Alternatively, you can use the Oracle Cloud Infrastructure CLI or API, which lets you execute the individual operations yourself.

This section walks through creating a connector and an alarm using the Console and then updating the topic created with the alarm.

For help with troubleshooting, see Troubleshooting Connectors and Troubleshooting Notifications.

This section walks through creating the connector, topic, subscriptions, and alarm using the CLI.

For information about using the API and signing requests, see REST API documentation and Security Credentials. For information about SDKs, see SDKs and the CLI.

1. Create a connector: Open a command prompt and run the oci sch service-connector create command:

   oci sch service-connector create --display-name
   "<display_name>" --compartment-id <compartment_OCID> --source [<source_in_JSON>] --tasks [<tasks_in_JSON>] --target [<targets_in_JSON>]

2. Create a topic: Open a command prompt and run the oci ons topic create command: 

   oci ons topic create --name "Alarm Topic" --compartment-id "<compartment-ocid>"

3. To this topic, add a subscription referencing your email address. Open a command prompt and run the oci ons subscription create command:

   oci ons subscription create --compartment-id "<compartment-ocid>" --topic-id "<topic-ocid>" --protocol "EMAIL" --subscription-endpoint "john.smith@example.com"

4. Create an alarm that defines the error threshold and references this topic as the destination: Open a command prompt and run the oci monitoring alarm create command: 

   oci monitoring alarm create --display-name "My Alarm" --compartment-id "<compartment-ocid>" --metric-compartment-id "<compartment-ocid>" --namespace "oci_computeagent" --query-text "<yourmetric>[1m].count() > 0" --severity "INFO" --destinations "<topic-ocid>" --is-enabled true

For help with troubleshooting, see Troubleshooting Connectors and Troubleshooting Notifications.

This section walks through creating the connector, topic, subscription, and alarm using the API.

For information about using the API and signing requests, see REST API documentation and Security Credentials. For information about SDKs, see SDKs and the CLI.

Use the following operations:

1. CreateServiceConnector: Create a connector.

   Example CreateServiceConnector request

   POST /20200909/serviceConnectors
   Host: service-connector-hub.us-phoenix-1.oraclecloud.com
   <authorization and other headers>
   {
     "compartmentId": "<compartment_OCID>",
     "description": "My connector description",
     "displayName": "My Connector",
     "source": {
       "kind": "logging",
       "logSources": [
         {
           "compartmentId": "<compartment_OCID>",
           "logGroupId": "<log_group_OCID>",
           "logId": "<log_OCID>"
         }
       ]
     },
     "target": {
       "compartmentId": "<compartment_OCID>",
       "kind": "metrics",
       "metric": "<yourmetric>",
       "metricNamespace": "<yournamespace>"
     },
     "tasks": [
       {
         "condition": "data.action='REJECT'",
         "kind": "logRule"
       }
     ]
     }
   }

2. CreateTopic: Create a topic.

   Example CreateTopic request

   POST /20181201/topics
   Host: notification.us-phoenix-1.oraclecloud.com
   <authorization and other headers>
   {
     "name": "Alarm Topic",
     "compartmentId": "<compartment_OCID>"
   }

3. CreateSubscription: To this topic, add a subscription referencing your email address.

   Example CreateSubscription request: Email

   POST /20181201/subscriptions
   Host: notification.us-phoenix-1.oraclecloud.com
   <authorization and other headers>
   {
     "topicId": "<topic_OCID>",
     "compartmentId": "<compartment_OCID>",
     "protocol": "EMAIL",
     "endpoint": "john.smith@example.com"
   }

4. CreateAlarm: Create an alarm that defines the memory threshold and references this topic.

   Example CreateAlarm request

   POST /20180401/alarms
   Host: telemetry.us-phoenix-1.oraclecloud.com
   <authorization and other headers>
   {
     "displayName": "My Alarm",
     "compartmentId": "<compartment_OCID>",
     "metricCompartmentId": "<compartment_OCID>",
     "namespace": "<yournamespace>",
     "query": "<yourmetric>[1m].count() > 0",
     "severity": "INFO",
     "destinations":
     [
       "<topic_OCID>"
     ],
     "isEnabled": true
   }

For help with troubleshooting, see Troubleshooting Connectors and Troubleshooting Notifications.