User-defined software services

NAM Console ► Deployment ► Manage devices, select NAM Probe Configuration ► Open configuration, Software Services ► User-Defined Software Services

Use this screen to manually define a software service.

Skill level: advanced user

This screen offers functionality suitable for expert users.

  • If you are new to software services, start with Software services for beginners before you come here.
  • If you want to monitor a well-known software service, start with Autodiscovered Software Services to see if your work has already been done for you.
  • If you find you still need to define your own software service, try to use the wizard or a template to walk you through the process. You can always use the manual screens to tweak a software service after you create it with the wizard. See Software Services for details.

To manually create a software service on your NAM Probe:

Open NAM Console ► Deployment ► Manage devices.

Find the NAM Probe you want to configure and select Open configuration from that device's menu.

Navigate to Configuration ► Software Services ► User-Defined Software Services.

A software service needs (at minimum):

  • The name under which this software service will be listed and sorted.
  • The base protocol, which is usually TCP, possibly UDP. This selection affects the selection of analyzers.
  • The analyzer that will examine the traffic. If you don't see the analyzer you want, make sure the base protocol is correct.
  • A rule identifying the address and port on which to look for the traffic you want to analyze. You are going to specify these things in the steps that follow.

Right-click in the Software services table and select Add.

Specify the software service name, base protocol, and analyzer, and then click OK.

With the new software service selected, right-click in the Rules table (under the Software services table) to add a rule in the Edit Rule screen.
Tabs and settings available in the Edit Rule screen vary according to the analyzer you select (the type of traffic you want to monitor), but they all include the Services tab, and that is where you need to start.

On the Services tab of the Edit Rule screen, right-click in the Services list and select Add.
The Service Details window is displayed.

In the Service Details window, type the range of addresses and port numbers to watch for this software service.

On the Edit Rule screen, click OK.

  • Your new software services is now on the Software services list.
  • When you select your software service, the address/port rule is displayed on the Rules list.

You can use the other tabs to fine-tune your software service, but the basic service is now in place.

To verify that the software service is configured, on the report server (NAM Server), open the main menu

and select ExploreSoftware services.

The Operation explorer opens with a focus on software services.
See the "per software service" setting in the Performance details table.

If you have a working NAM configuration with a NAM Probe feeding data to your NAM Server, the Performance details table lists everything identified as a software service.

In the example above:

  • The first row shows a service called HTTPS. You know it was automatically discovered because of the green check mark in the A (for automatic) column.
  • The second row shows a service called Client44-SSL. You know it was manually configured because of the red x in the A column.
Tip

If you have just added a software service manually, you should be able to find the service in this table.
Use the Find box (and Find button) at the bottom of the table display if you have a lot of software services in the table.

The sections described below correspond to the Edit Rule tabs for an HTTP/HTTPS service. Other software services offer a subset of these tabs.


Services

Use the Services tab to

  • List the addresses and ports on which this analyzer will monitor traffic.
  • Add more such addresses and ports.
  • Set some more advanced parameters.

To add or edit a user-defined software service:

  1. Right-click anywhere in the Services table and select Add, Open or Delete from the context menu.
  2. Depending on the analyzer selected in the software service definition, different options and settings are available for rule definition.
    See Configuring rules for user-defined software services for details.

URL monitoring

Use the URL Monitoring tab to

  • Describe URLs to monitor
  • Describe URLs to exclude from monitoring

Right-click in the URL definitions table to open a menu of options:

  • Add monitored URL to create a new definition for monitoring URLs.
  • Add excluded URL to create a new definition for URLs excluded from monitoring.
  • Open to edit the selected definition.
  • Delete to remove the selected definition.

See Configuring URL monitoring for details.


Dimensions, metrics, attributes

Use the Dimensions, Metrics, Attributes tab to specify measurable data in your network environment or software.

  • How the value should be reported: Custom metric, EBS module, Grouping attribute, Miscellaneous parameter, or Operation attribute
  • Where the value should be reported: the bucket in which to categorize this value
  • Where to search for the value: request header, response header, etc.
  • Search and transformation rules: how to search within the payload (anything from a simple string search to a complicated regex).

See Dimensions, metrics, and attributes in HTTP monitoring and Searching within the payload for full details.


User name recognition

Use the User Name Recognition tab to configure how to recognize a user for this software service:

  • Type: user name, session ID, or acknowledge URL
  • Where to search for the value: request header, response header, etc.
  • Host or path settings
  • Search and transformation rules: how to search within the payload (anything from a simple string search to a complicated regex).

Name recognition can be configured globally for all HTTP software services configured on NAM Probes set to work in HTTP Mode. See HTTP - User Identification.

See HTTP - User Identification for details.


URL auto-learning

Use the URL Auto-Learning tab to determine the set of URLs appearing in per-URL reporting statistics without the need to manually define each URL. URLs that are found frequently are automatically learned and reported.

There are four basic settings:

  • Off disables URL auto-learning.
  • Global settings uses the global setting.
  • Custom settings enables the Advanced settings section, where you can override URL auto-learning rules for this software service.
  • All specifies to learn all URLs for this software service.

See Configuring URL auto-learning for details.


Character encoding

Use the Character Encoding tab to make it possible to recognize content with international character encoding. For each of these:

  • URI
  • Parameter
  • Header
  • Response header
  • Response body you can specify (globally or per host) the type of encoding (typically Asian) to use: shift-jis, gbk, etc.

See Web - HTTP for more on character encoding..


End of page components

Use the End of Page Components tab to describe how to identify the end of an HTTP/HTTPS page:

  • At the software service level
  • At the URL level
  • At the URL parameters level

Loading this component indicates that the page is complete: no further elements are taken into account when calculating metrics for the page.

See End of Page Components for details.


Orphaned redirects

Use the Orphaned redirects tab to define location suffixes and request URL suffixes to exclude from orphaned redirects.

HTTP redirects are stored until either a matching target URL is seen or a timeout expires. If the redirect target page has not been seen by the time the redirect timeout expires, the NAM Probe reports the URL with all transactional metrics equal to zero and the redirect is referred to as an "orphaned redirect". The URL reported is taken from the orphaned redirect.

See Web - HTTP for details.


HTTP options

Use the HTTP Option s tab to set a variety of HTTP-specific parameters.

See HTTP Options for details.


Content types

By default, a NAM Probe recognizes only HTML objects as pages, but it can be configured to treat other types of objects as HTML pages to be monitored. Such objects may include, for example, images, embedded objects such as Flash objects, and objects that require third-party plug-ins to render.

To have the NAM Probe treat a certain content type as a monitored page:

  1. Right-click the Objects recognized as pages table and select Add from the pop-up menu to add a new entry.

    For each entry, you can set the following options:

    1. Auto-Learning Enabled
      Enable URL auto-learning mechanism for pages of the selected content-type.
    2. Treat as HTML
      For asynchronous web applications, partial page updates are not declared as text/html, so the NAM Probe does not handle such events using HTML-based monitoring features. Select Treat as HTML for update information content types (typically text/xml) to be able to recognize partial page updates as pages, report page elements, enable frame recognition, recognize the page name, apply response based rules, and report metrics and attributes. Otherwise, you will only be able to calculate basic performance metrics for partial page updates.
      These entries must be compatible with those of the Content type field in the HTTP header. Many instances of the parameters are allowed, one for each content type to be recognized as a page. For example, image/jpg and image/gif are valid entries for an Objects recognized as pages table.
      The text/html content type is the default for pages and cannot be removed from the list. Accordingly, the text/html pages are always treated as HTML and Treat as HTML is always set to true and cannot be modified.
  2. Right-click in the Filtering out pages table and select Add from the pop-up menu to configure page filtering based on the content of the URL.

    URLs to which the filtering criteria in the list apply are not reported in the performance data files.

    This can be useful if, for example, a client requests a page composed of HTML content and a number of images, but some of the requested images are missing. The web server would respond with an HTTP error code, but if it responds with an HTML page stating that an element is missing, this would be recorded as a legitimate page load and would misleadingly raise page volume reports and should be filtered out. In such cases, you could use the Filtering out pages list to prevent such pages from being recorded.

    The default list contains the following entries:

    • .css
    • .htc
    • .gif
    • .jpg
    • .jpeg

See Web - HTTP for more on content type monitoring.


Recognition and parsing of URLs

The global configuration settings for recognition and parsing of URLs are inherited by all user-defined software services for HTTP.

To override the global settings for this software service, clear the Use global values check box on this tab and specify how to recognize and parse URLs for this software service.

  • Method of truncating URLs
  • First parameter separators
  • Parameter separators in URL
  • Parameter separators in HTTP header
  • Search for parameters first (in POST body or in URL request)

See Web - HTTP for more on the recognition and parsing of URLs.


Options

Clear an Inherit from global setting check box to enable a control and use that setting for this software service.

  • Slow operation load time threshold
    The number of seconds after which an operation is considered slow.
  • Server time threshold The number of seconds after which server time is considered slow.
  • Idle TCP session cleanup timeout
    The number of minutes after which the TCP session is considered idle.
  • Overwrite ICA session mappings
    Whether to overwrite ICA session mappings.
  • HTTP limits
    • Maximum header length Maximum size in bytes of the buffer that the HTTP header can be assembled into before considering it incomplete and proceeding with its processing. This option is available only in HTTP mode of the HTTP analyzer. The value is configured globally for all software services.
    • Maximum request body length Maximum size in bytes of the buffer that HTTP request body can be assembled into before considering it incomplete and proceeding with its processing. This option is available only in HTTP mode of the HTTP analyzer. The value is configured globally for all software services.
    • Maximum response body length Maximum size in bytes of the buffer that HTTP response body can be assembled into before considering it incomplete and proceeding with its processing. This setting can be adjusted only for Oracle Forms over HTTP profile. Default value of "0 " will be used for other analysis profiles.

See Configuring rules for user-defined software services.


Availability

Select the Availability tab to configure the availability reporting at the software service level, overriding the global settings. The scope of failure reporting depends on an analyzer.

Incomplete responses

  • Partial response (standalone hit)
    An incomplete response observed for a hit without an operation context, classified as a Dead hit. This pertains to situations when server started the response but never finished due to a timeout or other problems.
  • Aborted response (standalone hit)
    An incomplete response observed for a hit without an operation context, classified as a Break. This pertains to situations when server started the response but aborted it before completion with TCP reset.
  • No response
    A request hit with no response from a server. This pertains to situations when server did not respond at all or responded in unrecognizable way.
  • Partial response
    An incomplete response with a Dead hit status. This pertains to situations when server started the response but never finished due to a timeout or other problems.
  • Aborted response
    An incomplete response with a Break status. This pertains to situations when server started the response but aborted it before completion with the TCP reset.

HTTP errors

The NAM Probe is able to deliver information on seven HTTP error groups (“categories”).

  • HTTP client errors (4xx)
  • HTTP server errors (5xx)
  • HTTP unauthorized errors
  • HTTP Not Found errors
  • HTTP client errors (category 3)
  • HTTP server errors (category 1)
  • HTTP server errors (category 2)

You can decide whether each of these should be taken into account when calculating (failures transport). Note that HTTP client errors (4xx), HTTP server errors (5xx), HTTP unauthorized errors, HTTP Not Found errors, and HTTP server errors (category 1) have configurable contents. For more information, see Web - Errors.

Failures (application)

You can decide whether each of five operation attributes should be reported as failures (application).

See Configuring availability.


Fault domain isolation

Use these threshold settings to identify the true source of a problem you are investigating.

Use the following threshold settings to accurately identify the true source of the problem:

Server/idle/network time

  • Server time threshold
    The server time portion of an overall operation time. Server times above the threshold limit are considered to be slow due to poor data center performance.
  • Idle time threshold
    Threshold for the time during the operation execution when there is no network or server activity related to the operation. It is assumed that idle time is caused by the user's software not sending requests because the user's PC is busy.
  • Network time threshold
    Threshold for the time the network (between the user and the server) takes to deliver requests to the server and to deliver page information back to the user. In other words, Network time is the portion of transaction time that is due to the delivery time on the network.

Retransmission

  • Retransmissions threshold
    Percentage of retransmissions regarding all observed transmissions.
  • Network time affected by high retransmission threshold
    Percentage of the network time affected by high retransmission threshold.

Request size

  • Request size threshold
    Threshold for the request where anything larger would be considered big request.
  • Network time affected by the transfer of a big request threshold
    Threshold for the request where anything larger would be considered big request.

Response size

  • Response size threshold
    Threshold for the response where anything larger would be considered big response.
  • Network time affected by the transfer of a big response threshold
    Threshold for the network time that is affected by the transfer of a big response threshold.

Hit count

  • Number of hits threshold
    Threshold for the number subcomponents of error-free operations or transactions.
  • Single hit duration threshold
    Threshold for a hit duration as a percentage of operation time

RTT

  • Rtt threshold
    Threshold for the time it takes for a SYN packet to travel from the client to a monitored server and back again.

Redirects

  • Redirect time threshold
    Threshold for redirect time as a percentage of operation time.
  • Number of (base hit) redirects threshold
    Threshold for number of redirects as a percentage of operation time