Show TOC

Example documentationIntegrate CCMS Metrics into MAI: Spool Service Queue

 

In this example, you integrate the CCMS metric Spool Service Queue Usage (%) into technical monitoring. The metric specifies the percentage of the spool service queue which is in use; this queue receives output requests from the dispatcher queue when a free work process in the formatting server accepts it.

You can display this metric in the Alert Monitor, e.g. in the Entire System monitor.

Integration

This section is an example of the Extend Monitoring and Alerting Infrastructure with CCMS Metrics process. This process shows how you can extend technical monitoring with additional, previously not monitored CCMS metrics.

Activities

The integration of the CCMS metric into the Monitoring and Alerting Infrastructure (MAI) comprises several steps, which are described consecutively below:

Determine CCMS metric attributes

To integrate the CCMS metric into MAI, you need a set of technical attributes of this metric (this step, and its attributes, are described under Determine CCMS Metric Attributes). You need the following attributes:

  • MTE class

  • Object name, if the metric occurs more than once per context

  • Context name

  • MTE Type

  • Granularity

  • Instance-specific or system-wide

To determine these attributes for the metric, proceed as follows:

  1. Start the Alert Monitor (transaction RZ20) in a managed ABAP system, and start the Start of the navigation path SAP CCMS Monitor Templates Next navigation step Entire System End of the navigation path monitor.

  2. Expandi the monitor path Start of the navigation path <System-ID> Next navigation step R/3 Services Next navigation step Spool Next navigation step <Iistance name> Next navigation step SpoolService End of the navigation path, and select the Service Queue node. Choose Attributes.

  3. The Monitoring: Attributes and Methods screen display most of the required attributes. The name of the MTE class is R3SpoolServiceQueue, the long name of the node is:

    <system ID>\<instance name>\R3Services\Spool\SpoolService\ServiceQueue

    Results:

    Attribute

    Value

    MTE class

    R3SpoolServiceQueue

    Context

    <instance name>, so it is an instance-specific metric

    Object Name

    SpoolService

    Note Note

    This is not required because the monitor tree structure indicates that there is only one node with this MTE class per context.

    End of the note.

    MTE Type

    Performance attribute, so a numeric value is output

    Granularity

    Select the node in the monitor tree and choose Show Details (Show Details), to see in the smoothed performance values for the last 30 minutes that the metric is measured every minute.

You have then determined all required attributes of the CCMS metric.

Determine Collector

To integrate a CCMS metric into MAI, you must specify the data collector and its input parameter for the metric. The collector and its input parameter value depend on the CCMS metric attributes that you determined.

This step is described under Determine the Collector. Use the data collector CCMS MTE, because the metric has the following attributes:

  • It is an instance-specific metric.

  • The metric delivers a numerical value.

  • The object name is not relevant.

The input parameters are as follows:

Parameter ID

Parameter value

GRANULARITY

5 minutes, not less, because the MAI calls the collectors every five minutes

MTE_CLASS

R3SpoolServiceQueue

INSTANCE

This parameter is filled automatically

Create Customer Template

MAI metrics, whether delivered by SAP or created by customers, are in templates in technical monitoring, so to create a metric, you must first create a customer template in der SAP Solution Manager Configuration (this and the next step are described in Creating MAI Metrics from CCMS Metrics). To do so, proceed as follows:

  1. Start SAP Solution Manager Configurations (transaction SOLMAN_SETUP).

  2. Go to Technicals Monitoring, the monitoring use case System Monitoring, and step Template Management.

  3. Switch to editing mode.

  4. Expand the type of the managed object and product for which you want to create a custom template, in the Templates navigation bar. For an instance-specific metric, it is Start of the navigation path Technical Instance Next navigation step SAP ABAP 7.00 - 7.03 End of the navigation path

  5. If you have not yet created a suitable template, select this SAP-delivered template, and choose Create Customer Template. Enter a name in the Name field, for example Other CCMS Metrics.

  6. Save the template.

You have now created a customer template. Create the metric in this template.

Create New Metric

You are in Template Management, and have created a customer template. Create a new MAI metric in this template:

  1. Go to edit mode, and then to expert mode.

  2. To create a new metric, choose Start of the navigation path Create Next navigation step Metric End of the navigation path. A customer metric creation wizard starts.

  3. Enter the general attributes of the new metric in the Overview tab:

    Attribute

    Value

    Name

    Spool service queue usage

    Category

    Performance

    Class

    Metric

    Data Type

    Whole number

    Unit

    Percent

    Active

    Do not change this entry.

    Technical Name

    Z_R3SPOOLSERVICEQUEUE

    Customer description

    Enter a description of your metric.

  4. Go to the Data Collection tab. Specify the technical connection to the CCMS metric to be integrated into MAI:

    Attribute

    Value

    Data Collector Type

    RFC (Pull)

    Data Collector Name

    CCMS MTE

    Collection interval

    5 minutes

    Input Parameter Collector

    GRANULARITY: 5 Minutes

    MTE_CLASS: R3SpoolServiceQueue

  5. Go to the Data Usage tab. Specify the applications for which you use the new metric. In this example, you want to display the history of the new metric in the metric monitor as well.

    Attribute

    Value

    Send Values to an Event Calculation Engine

    Do not change this entry.

    Send Values to SAP NetWeaver Business Warehouse

    Set this flag.

    BW Mapping Rule

    Standard BI Mapping for CCMS Metrics (ONLY Data Provider: CCMS MTE)

    Granularity

    Optimized for Metric Monitor

  6. Go to the Threshold Value tab. Specify the threshold types and values for the new metric:

    Attribute

    Value

    Threshold Value Type

    Numeric Threshold (GtoY/YtoR/RtoY/YtoG)

    Monitored Value

    Trigger at Value

    Do not change these entries.

    Threshold values

    Copy the threshold values from CCMS:

    • Switch from GREEN to YELLOW: 80%

    • Switch from YELLOW to RED: 95%

    • Switch back from RED to YELLOW: 90%

    • Switch back from YELLOW to GREEN: 70%

  7. Go to the Validity tab. Do not enter a value.

  8. Go to the second step (Assignments) of the customer metric creation wizard. You can assign an alert to the metric. Skip this step because there is not yet a suitable alert for the new metric. Choose Finish, to complete the creation of the metric.

  9. Save the template.

Create an alert for the new metric

No alert is yet assigned to your new metric. To create an alert in this template, proceed as follows (the descriptions of this and the next step are under Creating Alert Types for the New MAI Metrics):

  1. Choose Start of the navigation path Create Next navigation step Alert End of the navigation path. A customer alert creation wizard starts.

  2. Enter the general attributes of the new alert in the Overview tab:

    Attribute

    Value

    Name

    Spool service queue load is too high

    Category

    Performance

    Severity

    5 - Medium

    Do not group occurrences

    Do not change this entry.

    Active

    Do not change this entry.

    Technical Name

    ZA_R3SPOOLSERVICEQUEUE

    Customer description

    Enter a description of your alert.

  3. Do not change the settings in the Messages, Notifications, Third-Party Components and Auto-Reactions tabs. These settings are then copied into the template.

  4. In the Rule tab, you specify how the alert color is determined if the alert has several metrics assigned to it. Do not change the value Worst Case Rule.

  5. Go to the second step (Assignments) of the customer alert creation wizard. You can assign a metric to the alert. Choose the Spool Service Queue Usage metric created above.

    Choose Finish, to complete the creation of the alert.

  6. Save your template.

Rename New Event

You have created an alert for your new metric. The system generates a consolidation event with the same name as the alert, automatically. As the event is displayed independently of the status in technical monitoring, change the name. Proceed as follows:

  1. Go to the Metrics, Events, Alert Hierarchy tab.

  2. Find the newly created alert Spool Service Queue Load Too High, and expand its subtree. The automatically created consolidation event is below the alert.

  3. Choose the consolidation event of the alert, and name it Spool Service Queue Usage.

  4. Save your template.

Assign and activate template

You have made the required changes to the customer template. To use the new metric and its alert in technical monitoring, assign the template to managed objects, and activate the assignment. This is described in Using Templates.

  1. Go to SAP Solution Manager Configuration step Define Scope.

  2. Select ABAP systems whose metrics you want to monitor, and go to the next step (Monitoring Setup).

  3. Choose Assign Templates for all instances, and for the product SAP ABAP Basis choose the previously created template Other CCMS Metrics.

  4. Activate the assignment with Start of the navigation path Copy and Activate Next navigation step All Managed Objects End of the navigation path.

Result

You have performed all steps required to integrate a CCMS metric into MAI; the metric is displayed in the Technical Monitoring work center.

Start System Monitoring of the ABAP systems to which you have assigned your template. The metric is in the technical instances, under Start of the navigation path Instance Performance Next navigation step Spool Service Queue Usage End of the navigation path.