API Management 10.4 | Using CentraSite | Portlet Management | Built-in Run-Time Portlets
 
Built-in Run-Time Portlets
This section describes the set of run-time report searches that are installed as portlets with CentraSite.
Portlet
Description
Displays the run-time metrics of the selected service over a specific period of time.
Displays the run-time metrics of the selected service over an extended period of time.
Lists the top X consumers based on the maximum run-time invocations on services.
Lists the top X services based on the maximum run-time events on services for the given number of days.
Lists the top X services based on the maximum invocations for the given number of days.
Lists the top X services based on the maximum payload size.
Lists the top X services based on the maximum run-time errors.
Lists the top X services based on the maximum run-time policy violations.
Service Performance Metrics
The Service Performance Metrics portlet in the Welcome page displays the run-time metrics for a service over a specified period of time.
The input parameters are:
Parameter
Description
Service Key
Required. Specifies the Universally Unique Identifier (UUID) of the service that you want to include in the view.
Start Time / End Time
Required. Specifies the starting and ending date and time during which you want to examine metrics.
The result attributes are:
*Service Name – The fully qualified name of the service.
*Service Key – The Universally Unique Identifier (UUID) that is assigned to the service and uniquely identifies it within the registry.
*Service Description – The comment or descriptive information about the service.
*Service Version – The user-assigned version identifier for the service.
*Total Request Count – The total number of requests for the service running for the current interval.
*Total Success Count – The number of successful service invocations for the service for the current interval.
*Total Fault Count – The number of failed invocations for the service for the current interval.
*Minimum Response Time – The minimum amount of time (in milliseconds) it took to complete an invocation in the current interval.
*Maximum Response Time – The maximum amount of time (in milliseconds) it took to complete an invocation in the current interval.
*Average Response Time – The average amount of time it took the service to complete each invocation in the current interval.
Service Performance Metrics Over Time
The Service Performance Metrics portlet in the Welcome page displays the run-time metrics for a service over an extended period of time.
The input parameters are:
Parameter
Description
Service Key
Required. Specifies the Universally Unique Identifier (UUID) of the service that you want to include in the view.
Time Interval
Required. Specifies the time interval (as expressed in Days, Hours, Minutes, and Seconds) between consecutive repeats of examining metrics.
Duration (Past X Days/Hours)
Required. Specifies a duration (as expressed in Days, Hours, Minutes, and Seconds) during which you want to examine metrics.
The result attributes are:
*Service Name – The fully qualified name of the service.
*Service Key – The Universally Unique Identifier (UUID) that is assigned to the service and uniquely identifies it within the registry.
*Service Description – The comment or descriptive information about the service.
*Service Version – The user-assigned version identifier for the service.
*Total Request Count – The total number of requests for the service running for the current interval.
*Total Success Count – The number of successful service invocations for the service for the current interval.
*Total Fault Count – The number of failed invocations for the service for the current interval.
*Minimum Response Time – The minimum amount of time (in milliseconds) it took to complete an invocation in the current interval.
*Maximum Response Time – The maximum amount of time (in milliseconds) it took to complete an invocation in the current interval.
*Average Response Time – The average amount of time it took the service to complete each invocation in the current interval.
Top X Consumers Based on Runtime Invocations
The Top X Consumers Based on Runtime Invocations portlet in the Welcome page lists the top X consumers based on number of run-time invocations of services.
The input parameters are:
Parameter
Description
Number of Entries
Required. Integer. Specifies the number of most popular consumers (which is based on the total number of invocations) that you want to include in the view.
By default, this portlet displays up to five consumers.
The result attributes are:
*Consumer Application Name – The fully qualified name of the consumer application asset.
*Consumer Application Description – The comment or descriptive information about the consumer application asset.
*Invocation Count for Consumer Application – The number of invocations made by the consumer application asset on a service.
Top X Monitoring Events Per Service
The Top X Monitoring Events per Service portlet in the Welcome page lists the top X run-time events for a selected service for the given number of days.
The input parameters are:
Parameter
Description
Number of Entries
Required. Integer. Specifies the number of most popular run-time events for the service that you want to include in the view.
Number of Days Past
Required. Integer. Specifies the number of days in the past to filter run-time events for the service.
The result attributes are:
*Service Name – The fully qualified name of the service.
*Service Key – The Universally Unique Identifier (UUID) that is assigned to the service and uniquely identifies it within the registry.
*Service Description – The comment or descriptive information about the service.
*Service Version – The user-assigned version identifier for the service.
*Monitoring Event Count for Service – The number of monitoring events made on the service.
Top X Services Based on Invocations
The Top X Services Based on Runtime Invocations portlet in the Welcome page lists the top X services based on run-time invocations for the given number of days.
The input parameters are:
Parameter
Description
Number of Entries
Required. Integer. Specifies the number of most popular services (which is based on the maximum number of invocations) that you want to include in the view.
Number of Days Past
Required. Integer. Specifies the number of days in the past to filter services that had the maximum number of invocations.
The result attributes are:
*Service Name – The fully qualified name of the service.
*Service Key – The Universally Unique Identifier (UUID) that is assigned to the service and uniquely identifies it within the registry.
*Service Description – The comment or descriptive information about the service.
*Service Version – The user-assigned version identifier for the service.
*Invocation Count for Service – The number of invocations made on the service.
Top X Services Based on Payload Size
The Top X Services Based on Payload Size portlet in the Welcome page lists the top X services with maximum payload size.
The input parameters are:
Parameter
Description
Number of Entries
Required. Integer. Specifies the number of services that you want to include in the view.
Maximum Payload Size
Required. Integer. Specifies the maximum payload size (in bytes).
The result attributes are:
*Service Name – The fully qualified name of the service.
*Service Key – The Universally Unique Identifier (UUID) that is assigned to the service and uniquely identifies it within the registry.
*Service Description – The comment or descriptive information about the service.
*Service Version – The user-assigned version identifier for the service.
*Maximum Payload Size for Service – The maximum payload size for the service.
Top X Services Based on Runtime Errors
The Top X Services Based on Runtime Errors portlet in the Welcome page lists the top X services with maximum run-time errors.
The input parameters are:
Parameter
Description
Number of Entries
Required. Integer. Specifies the number of services that you want to include in the view.
The result attributes are:
*Service Name – The fully qualified name of the service.
*Service Key – The Universally Unique Identifier (UUID) that is assigned to the service and uniquely identifies it within the registry.
*Service Description – The comment or descriptive information about the service.
*Service Version – The user-assigned version identifier for the service.
*Error Count for Service – The number of runtime errors marked on the service.
Top X Services Based on Runtime Policy Violations
The Top X Services Based on Runtime Policy Violations portlet in the Welcome page lists the top X services with maximum run-time policy violations.
The input parameters are:
Parameter
Description
Number of Entries
Required. Integer. Specifies the number of services that you want to include in the view.
The result attributes are:
*Service Name – The fully qualified name of the service.
*Service Key – The Universally Unique Identifier (UUID) that is assigned to the service and uniquely identifies it within the registry.
*Service Description – The comment or descriptive information about the service.
*Service Version – The user-assigned version identifier for the service.
*Policy Violations Count for Service – The number of runtime policy violations marked on the service.
Copyright © 2015- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release