Configuring Service REST rule monitoring

To use monitoring, you must turn it on for the rules that you want to trace. You can configure monitoring to monitor all Service REST rules in the system, all rules in a service package, or individual Service REST rules. Monitoring is useful for debugging your application during development, for example, if a request is failing.

CAUTION:
Monitoring is not recommended for production environments because it might affect performance and depending on the number of incoming service requests, there is a chance that over a period of time, the invocation history might get large enough so that you run out of database space.

The configuration for specifying when to monitor a Service REST rule is hierarchical, based on the service/EnableGlobalMonitoring Dynamic System Setting, the Service Package settings, and the individual Service REST rule setting.

The service/EnableGlobalMonitoring Dynamic System Setting can be set to On, Off, or Deferred (the default). When set to On, all REST services in the system are monitored. When set to Off, no REST services in the system are monitored. When set to Deferred, you can configure monitoring on the service package or individual service level. If the setting does not exist, the default behavior is the same as if it is set to Deferred.

Monitoring at the service package and individual service level is configured on the rule forms. When monitoring is set to On at the service package level, all REST services in the package are monitored. When monitoring is set to Off at the service package level, no REST services in the package are monitored. When monitoring is set to As defined on the service rule, you can configure monitoring at the individual service level.

At the individual service level, monitoring can be set to either On or Off.

At the service package and service level, you can also configure whether to capture the state of the primary data page.

Configuring monitoring for all Service REST rules

By default, monitoring for all Service REST rules is set to Deferred. To change the default:

  1. From the Records Explorer, click SysAdmin > Dynamic System Settings.
  2. Locate and click the service/EnableGlobalMonitoring setting.
  3. In the Value field, enter On to enable monitoring for all Service REST rules, or Off to disable monitoring for all Service REST rules.
    Note: Settings at the service package level or service level are ignored. To configure monitoring at the service package level or service level, set service/EnableGlobalMonitoring to Deferred.
  4. Click Save.

Configuring monitoring for a service package

Service package monitoring configuration settings are used only if the service/EnableGlobalMonitoring Dynamic System Setting is set to Deferred.

  1. From the Records explorer, either click Integration-Resources > Service Package.
  2. Click the service package Ehat you want to configure.
  3. On the Context tab, click the Gear in the Service monitoring field.
  4. Select On to monitor all rules in the service package. Select Off to turn off monitoring for all rules in the service package. Select As defined on the service rule to configure monitoring at the service level.
  5. If you selected On, you can select whether to include the clipboard state of the primary data page. Click Yes or No.
  6. Click Submit.
  7. Click Save.

Configuring monitoring for an individual service level

You can configure monitoring at the service level only if the service/EnableGlobalMonitoring Dynamic System Setting is set to Deferred and the service package is set to As defined on service rule.

  1. From the Records Explorer either click Integration-Services > Service REST.
  2. Click the service level that you want to configure.
  3. On the Service tab, click the Gear in the Service monitoring field.
  4. Select On to turn monitoring on for this rule or Off to turn monitoring off for this rule.
  5. If you selected On, you can select whether to include the clipboard state of the primary data page. Click Yes or No.
  6. Click Submit.
  7. Click Save.