IBM InfoSphere Streams Version 4.1.0
Metrics
This collection resource provides access to recent values for resource, processing element, operator, and port metrics.
Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/domains/{restid}/hosts/{restid}/metrics
https://server:port/streams/rest/domains/{restid}/resources/{restid}/metrics
https://server:port/streams/rest/instances/{restid}/hosts/{restid}/metrics
https://server:port/streams/rest/instances/{restid}/jobs/{restid}/operators/{restid}/metrics
https://server:port/streams/rest/instances/{restid}/jobs/{restid}/operators/{restid}/inputports/{restid}/metrics
https://server:port/streams/rest/instances/{restid}/jobs/{restid}/operators/{restid}/outputports/{restid}/metrics
https://server:port/streams/rest/instances/{restid}/pes/{restid}/metrics
https://server:port/streams/rest/instances/{restid}/pes/{restid}/inputports/{restid}/metrics
https://server:port/streams/rest/instances/{restid}/pes/{restid}/outputports/{restid}/metrics
https://server:port/streams/rest/instances/{restid}/peconnections/{restid}/metricsProperties
This collection resource has
the following properties:
- metrics
- An array of metric objects. Each metric object has the following
properties:
- description
- A string that describes the metric.
- lastTimeRetrieved
- A number that represents the time when the metric was most recently retrieved. The unit of time is milliseconds since the epoch, which was midnight Greenwich mean time (GMT) on January 1, 1970.
- metricKind
- A string that identifies the kind of metric. Some possible values for this property include counter, gauge, time, and unknown.
- metricType
- A string that identifies the type of metric. Some possible values for this property include system, custom, and unknown.
- name
- A string that identifies the name of the metric. By default, when you retrieve a collection of metric resources, they are sorted according to this property value.
- resourceType
- A string that identifies the REST resource type, which is metric.
- value
- A number that is the value for the metric.
- next
- A string that identifies the URI for the next page in the list. This property is not present if the list is not paged or if the current page is the last page.
- owner
- A string that identifies the URI for the InfoSphere® Streams object to which the metrics apply.
- previous
- A string that identifies the URI for the previous page in the list. This property is not present if the list is not paged or if the current page is the first page.
- resourceType
- A string that identifies the REST resource type, which is metricList.
- total
- A number that represents the total number of objects in the list. If the list is filtered, the total corresponds to the total number of items that match the filter parameters.
Resource retrieval
You can use the following HTTP methods and query parameters to retrieve this resource:
- HTTP methods
- GET
- Query parameters
- This collection resource supports the standard query parameters for collection resources.