IBM Streams 4.3.0

Using JMX APIs to manage and monitor IBM Streams

Java™ Management Extensions (JMX) APIs provide programmatic access to configuration and status information for IBM® Streams objects, such as a domain and its instances, jobs, and resources. You can manage and monitor these objects by using a set of JMX beans. A JMX bean provides attributes, operations, and notifications for working with the managed object.

About this task

Attributes generally provide configuration and state information about IBM Streams objects. The JMX APIs provide methods for getting and setting the attribute values. For example, the InstanceMXBean has a high availability count attribute, which you can get or set by using the getHighAvailabiltyCount and setHighAvailabiltyCount methods.

In addition to getting and setting attribute values, the JMX APIs provide operations for management tasks. For example, you can use operations to create, start, stop, or remove instances and to submit or cancel jobs.

Notifications provide a way to signal a value change, event, or problem. For example, you can use notifications to detect when attribute values change. You can also use notifications to monitor when significant events occur, such as when an instance, service, or job stops or starts.

  • Getting started with JMX APIs
    To develop an application that uses the IBM Streams JMX API, you must configure the access control lists and determine the JMX URL for establishing a connection.
  • Accessing IBM Streams information with JMX APIs
    To access IBM Streams information by using the JMX API, you must supply the necessary environment parameter values, establish a JMX connection, obtain access to an IBM Streams JMX bean proxy, and call bean methods through the proxy.
  • Registering JMX beans for jobs
    You must register JMX beans for jobs and related objects before you can access them from an application. Related objects include processing elements (PEs), operators, and connections.
  • Performing large data operations with JMX APIs
    The IBM Streams JMX API uses an HTTPS implementation for transferring large data values between the client where the application runs and the server where the web management service runs. For example, this implementation is used for client retrieval of processing element (PE) metrics and for uploading an application when a job is submitted.
  • Processing JMX API notifications
    To successfully process JMX notifications, your application must implement the NotificationListener interface, become a listener for notifications, and be tolerant of potential lost notifications.
  • Handling JMX API errors
    The IBM Streams Java Management Extensions (JMX) APIs throw a standard Java exception when an error occurs.
Parent topic: Developing
Related reference:
JMX API documentation