Set service context

Overview

The Set Service Context filter configures service-level monitoring details. For example, you can use the fields on this filter window to configure whether API Gateway stores service usage and service usage per client details. You can also set the name of the service displayed in the web-based API Gateway Manager monitoring tools and API Gateway Analytics reporting tools.

For more details on monitoring and reporting tools, see the API Gateway Administrator Guide.

General settings

Name:
Enter an appropriate name for the filter to be displayed in a policy.

Service Name:
Enter an appropriate name for this service to be displayed in the web-based API Gateway Manager tools, and in the API Gateway Analytics interface when generating reports for this service.

Monitoring Options:
The fields in this group enable you to configure whether this service stores usage metrics data to a database. For example, this information can be used by API Gateway Analytics to produce reports showing how and who is calling this service. You can configure the following fields:

  • Enable monitoring:
    Select this option to enable monitoring for this web service in the Monitoring view in API Gateway Manager, and in API Gateway Analytics. For more details on monitoring, see the API Gateway Administrator Guide.
  • Which attribute is used to identify the client:
    Enter the message attribute to use to identify authenticated clients. The default is authentication.subject.id, which stores the identifier of the authenticated user (for example, the user name or user's X.509 Distinguished Name).
  • Composite context:
    This setting enables you to select a service context as a composite context in which multiple service contexts are monitored during the processing of a message. This setting is not selected by default.
  • For example, API Gateway receives a message, and sends it to serviceA first, and then to serviceB . Monitoring is performed separately for each service by default. However, you can set a composite service context before serviceA and serviceB that includes both services. This composite service passes if both services complete successfully, and monitoring is also performed on the composite service context.

Related Links