MQ

 View Only

 Monitoring the MQ REST API

Jump to  Best Answer
Sebastian Wilk's profile image
Sebastian Wilk posted Wed August 06, 2025 06:00 AM

Hey MQ folks,

we just started playing around with the REST API to allow clients to send and receive messages. After tinkering a bit we have it up and running, however, as of now, I have no idea how to monitor the webserver.

Searching the web and the forums yielded no result, checking the processes I was unable to find anything that gets up and running upon firing up the webserver.

My question is:

How do you people monitor the REST API? Since other than sending messages or dropping a "dspmqweb" to see if the server available I currently have no way of telling wether or not the server is up.

The REST API is hosted on a Windows Server 2022 machine, currently on MQ 9.4.

Kind regards

Sebastian

Francois Brandelik's profile image
Francois Brandelik IBM Champion  Best Answer

The strmqweb starts a javaw.exe process that you can find in the task manager. Remember to check the command line info for the process in case you are running multiple ones.

However the best way to monitor the REST API would be to excercise it with an "info/display" type of request. If you get the expected return, everything is O.K.

om prakash's profile image
om prakash IBM Champion

One option you can use the `api/docs` route to ensure the webserver is available.

https://abc.ibm.com/api/docs -> 200 ensures the webserver is available.

If you want to ensure the webserver is authenticating etc.. add credential to the endpoint - https://abc.ibm.com/ibm/api/explorer/

Sebastian Wilk's profile image
Sebastian Wilk

That is a bummer then, but as expected, we have to create our own type of heartbeat to monitor the webserver.

bruce2359's profile image
bruce2359

By “monitor” I presume you mean “determine if the (insert resource here) is available and ready to successfully perform workload at a precise point in time.”  

There is no simple answer, other than attempting the intended workload.  It either works, or it doesn’t.  Cost-benefit analysis will dictate HA and DR efforts to mitigate failures.  

The same question has been discussed in other contexts, including queue manager, channel, data base manager, specific application, and other resources. 

Sebastian Wilk's profile image
Sebastian Wilk

Hey Bruce,

correct, in this particular case all that's needed is a heartbeat to see if the service is available.

While the discussion isn't new, apparently the webserver still is. We monitor all the MQ related resources with vendor monitors, but none of the ones we use have any option to check if the REST API is up or not, hence the question if there is something available.

I already made a dummy curl call and will pipe the output into a file to then postprocess the results.