{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":31212,"path":"it-operations-management/metric-intelligence/configure-itoa-metric-extension.md","title":"Manually configure the Metric Intelligence extension","bundle":null,"doc_type":null,"release":"australia","body":"\n# Manually configure the Metric Intelligence extension\n\nConfigure the MID Server Metric Intelligence extension to enable the MID Server to pull raw metrics from external systems. The extension detects anomalies and reports them to the instance along with raw data. This MID Server Metric Intelligence extension is required and must be running in order for your system to be able to collect Metric Intelligence data.\n\n## Before you begin\n\nSee [Get started with Metric Intelligence](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/metric-intelligence/get-started-metrics.md) for the high level steps of setting up Metric Intelligence.\n\nRole required: evt\\_mgmt\\_admin\n\n## About this task\n\nThe MID Server Metric Intelligence extension normalizes the raw data and then transmits the data to the instance. If the extension detected any anomalies above a specified threshold, they are sent to the instance. The extension runs for as long as it is enabled. This provides a persistent connection to the MID Server to constantly listen for raw Metric Intelligence data from external systems.\n\nThe MID Server Metric Intelligence extension:\n\n- Receives raw metric data, batches them and sends them to the instance at specified intervals.\n- Detects anomalies and sends a report to the instance.\n- The information that is sent to the ServiceNow instance is relevant for Metric Intelligence, so data processing is efficient.\n\nThe MID Server Metric Intelligence extension does not provide any API calls. However, when the **Enable REST Listener** option is selected, the extension adds a handler for the supported REST APIs.\n\n**Note:**  \n\n- Only upon configuring the Metric Intelligence extension, the Metric Intelligence MID Servers actually join the distributed cluster for Metric Intelligence.\n- After the initial configuration, the first metric is not included in the metrics data. \n- There is a delay of one minute in receiving metric information from the synchronization of the instance with the MID Server.\n\n## Procedure\n\n1. Navigate to **All** > **MID Server** > **Profiles and Deployments** > **Metric Intelligence**.\n\n2. In the Metric Intelligence Metrics Contexts list, click **New**.\n\n3. Fill in the fields, as appropriate.\n\n\n
\n\nField\n\n\n\nDescription\n\n
\n\nName\n\n\n\nA unique name for this extension for easy identification.\n\n
\n\nShort description\n\n\n\nA description of this extension.\n\n
\n\nStatus\n\n\n\nThis field is auto-populated with the status of the extension. The field is blank until the extension is started. After issuing a command to the extension, one of the following values is displayed: - **Started**: The extension is running.\n- **Stopped**: The extension is not running.\n- **Offline**: The MID Server is down.\n- **Error**: The extension failed with an error \\(the error message is displayed in **Error Message**\\).\n- **Warning**: A run-time exception has occurred. The extension continues to work.\n\n\n
\n\nError Message\n\n\n\nMessage describing any error that causes a command, such as **Start** or **Stop**, to fail. This field appears when the value in the **Status** field is **Error** and also when the value in the **Status** field is **Warning**.\n\n
\n\nExecute on\n\n\n\nLocation for running this extension. When configuring this option for use with Metric Intelligence, set to **Specific MID Server**. Then specify the MID Server with **Operationalintelligence** as a supported application and the **Metrics** capability.\n\n
\n\nMID Server\n\n\n\nThe name of the designated MID Server, which is configured with **Operationalintelligence** as a supported application and the **Metrics** capability.\n\n
\n\nExecuting on\n\n\n\n\\[Read-Only\\] The name of the MID Server on which the extension is running. This field shows the name of the MID Server even if the MID Server is down. If the user stops the extension, this field is empty.\n\n
4. When using the Push method for collecting Metric Intelligence data, the MID Server Metric Intelligence extension must be configured with the **Enable REST Listener** enabled. This option enables a listener so that a REST endpoint can receive raw metric data. The raw metric data is then placed in the regular data flow where the data is sent to the instance and the anomaly detector looks for anomalies. When selected, it adds a handler to the web server to listen for any metrics that are pushed to the MID Server. When this option is selected, the Web Server extension, which starts a Web Server on the MID Server, must also be configured. For more information, see [Configure the MID Web Server extension](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/event-management/configure-mid-web-server-extension.md).\n\n5. Right-click the form heading and select **Save**.\n\n6. Under **Related Links** click **Start** to save the Metric Intelligence data in this extension and start the extension.\n\n |Related Link|Description|\n |------------|-----------|\n |Start|Starts the extension on the configured MID Server if it is currently not running.|\n |Stop|Stops the running extension on the configured MID Server. No action is taken if the extension is not running.|\n |Restart|Stops, then starts the extension on the configured MID Server.|\n |Test|The test is not relevant to Metric Intelligence. Parameters are not tested or validated when **Test** is run.|\n |Update parameters|Sends the latest saved parameters to the extension.|\n\n\n"}}