Monitoring by using REST and JMX APIs (Streams)

The IBM Streams service provides a REST API for monitoring and managing a provisioned Streams instance and the corresponding build service. The service also provides a JMX API for monitoring and managing the provisioned Streams instance.

Procedure

To determine the URLs for accessing the REST and JMX APIs and for accessing the documentation that is provided with the product:

  1. Locate the service instance that you want to manage:
    1. From the IBM Cloud Pak for Data web user interface navigation menu, click Services > Instances.
    2. Click the Streams service instance entry that you want to manage.
  2. To access the API or the related documentation, use the appropriate REST or JMX endpoint URL from the endpoint sections.
    To access the URLs from outside the Kubernetes cluster, use the external endpoints. If the application is running within the Kubernetes cluster, use the service (that is, internal) endpoints for better performance. The endpoint sections in the web user interface contains a list of the actual endpoint URLs for the instance. The following tables list the API endpoints and the URL syntax.
    Streams external endpoints with URL syntax
    External endpoint URL
    Console https://cpd-console-route/streams-console/instances/instance-name/project/
    Instance REST https://cpd-console-route/streams_instance/v1/namespaces/project/instances/instance-name/
    Build service REST https://cpd-console-route/streams_build_service/v1/namespaces/project/instances/instance-name/
    Streams internal endpoints with URL syntax
    Endpoint URL
    Instance REST https://instance-name-rest.project:8444/streams/v1/instances/instance-name
    Instance JMX service:jmx:jmxmp://instance-name-jmx.project:9975
    Build service REST https://build-instance-name-build.project:8445/streams/v1/buildservice
    Streams endpoint documentation with URL syntax
    Endpoint URL
    Instance REST https://cpd-console-route/streams-doc/instances/instance-name/project/
    Instance JMX https://cpd-console-route/streams-doc/instances/instance-name/project/html/jmx/doc/index.html
    Build service REST https://cpd-console-route/streams-build-doc/instances/instance-name/project/
    Tip: The Streams REST and JMX API documentation is also available in the Streams documentation in IBM Documentation.