Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Configuring Service REST rule monitoring

Updated on April 6, 2022

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.

Before you begin: Create the service/EnableGlobalMonitoring dynamic system setting with owning ruleset Pega-IntegrationEngine. For more information, see Creating a dynamic system setting.
Caution: Monitoring is not recommended for production environments because it might affect performance. 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 with owning ruleset Pega-IntegrationEngine, 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.

  1. Configure monitoring for all Service REST rules, an individual service, or a service package:
    ChoicesActions
    Configure monitoring for all Service REST rules
    Note: By default, monitoring for all Service REST rules is set to Deferred.
    1. In the navigation pane of Dev Studio, click Records.
    2. Expand the SysAdmin category, and then click Dynamic System Settings.
    3. Locate and click the service/EnableGlobalMonitoring setting.
    4. 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.
    Configure monitoring for a service package
    Note: Service package monitoring configuration settings are used only if the service/EnableGlobalMonitoring dynamic system setting is set to Deferred.
    1. In the navigation pane of Dev Studio, click Records.
    2. Expand the Integration-Resources category, and then click Service Package.
    3. Click the service package that you want to configure.
    4. On the Context tab, click the Gear in the Service monitoring field.
    5. Configure monitoring rules by performing one of the following actions:
      • 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.
    6. Optional: If you selected On, you can select whether to include the clipboard state of the primary data page by clicking Yes or No.
    7. Click Submit.
    Configure monitoring for an individual service level
    Note: 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. In the navigation pane of Dev Studio, click Records.
    2. Expand the Integration-Services category, and then click Service REST.
    3. Click the service level that you want to configure.
    4. On the Service tab, click the Gear in the Service monitoring field.
    5. Select On to turn monitoring on for this rule or Off to turn monitoring off for this rule.
    6. Optional: If you selected On, you can select whether to include the clipboard state of the primary data page by clicking Yes or No.
    7. Click Submit.
  2. Click Save.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us