Data Center RUM Documentation

Skip to end of metadata
Go to start of metadata

The process of configuring extraction of the operation attributes is similar to the one used for custom metrics. The key difference relates to the type of information that is extracted and reported. The custom metrics functionality is used to extract and report the numeric values and the operation attributes relate to the textual data.

Before You Begin

It is assumed that you have already created one or more user-defined software services for this protocol.

For software services created with the application monitoring wizard and based on SOAP or XML over HTTP or HTTPS, you can define operation attributes using the wizard. For more information, see Defining SOAP Operations and Defining XML Operations.

For services defined in the Entire Configuration perspective of the RUM Console, perform the following steps:

 

Define operation attributes for a software service rule

 

  1. Start and log on to RUM Console.

  2. From the top menu, select Software Services ? Manage Software Services.

  3. Select a software service from the list.

    Click in the row corresponding with your service to display a set of rules for this service on the Configuration tab.

  4. On the Configuration tab, select Edit manually from the Actions context menu for a selected rule.

    The Edit Rule pop-up window appears. In this window you can edit and delete the existing rules, or add new rules.

  5. Navigate to the Operation Attributes tab.

  6. Determine if the operation attribute value should be reported.

    Select Report attributes value if you wish to report the values of the defined attributes.

    You can either just count the number of occurrences of each of the defined operation attributes or you can also determine if a retrieved attribute value should be reported. You can either just count the number of occurrences of each of the defined operation attributes or you can also determine if a retrieved attribute value should be reported. The extracted operation attributes counters are then reported by CAS and retrieved messages by ADS. If you disable the reporting of the attribute value at the software service rule level, the same will apply to the operation attributes defined at the operation level.If you disable the reporting of the attribute value at the software service rule level, the same will apply to the operation attributes defined at the operation level.

  7. Select and open a definition.

    Select a category from lines 1 through 5, where each line number corresponds to one of five operation attribute categories. The numbers correspond to the XML operation categories reported by Central Analysis Server reports.

    By default, different operation types are shown on reports as Operation Attribute 1, ..., 5. The report server reports enable you to customize these default names to suit your particular software service.

    Double-click it or right-click and choose Open.

  8. Specify if an operation attribute should be searched in a response or a request.

  9. Specify the XML tag whose value should be reported as an operation attribute.

    Enter the name of the tag that carries the information of your interest. If the tag occurs more than once in the request or response body, the last found is reported.

  10. Optional: Specify the search pattern.

    You can narrow your search by specifying the particular pattern to occur in the value of a defined XML tag for the attribute to be reported.

    • Select isRegex if you use a regular expression as a search pattern. Using regular expression you can extract part of the message if you wish to trim it of redundant elements. For more information, see Regular Expression Fundamentals.

    • Select isWildcard to provide a simple search pattern. The pattern should consist of a case-sensitive string expected in the tag and it may also contain optional wild-card character “*” to signify any number of any characters.

  11. Publish the draft configuration on the monitoring device.

Example: Example of defining XML operation patterns

The following example of XML traffic demonstrates how you can set the operation attributes to report on some specific XML operation attributes:

Request:

Response:

To report on not exits error:

  1. select Report attributes value to report the error message,

  2. choose the category 1 and add a definition,

  3. specify to search for an attribute in the response the tag,

  4. add TransRespCode tag to search in,

  5. choose the isWildcard pattern,

  6. and add the 0xx232250 wildcard.

It will match

and report on the not exits error as XML operation attribute - 1 with 0xx232250 as the message.

If you wish to report on the OK status, repeat these steps, choosing the category 2 and adding the 0xx232000 wildcard. It will match

and report on the OK status as XML operation attribute - 2 with 0xx232000 as the message.