Configuration of MosqMQTTBroTest

Using this test, administrators can determine the uptime of the message broker as well as figure out whether/not the message broker was rebooted. This test also throws light on the count of clients connected/disconnected to the message broker. This way, the test provides near-accurate indicators of the client connection load on the message broker. Also, by reporting the rate at which messages (including PUBLISH messages) and data are processed, the test reveals early to administrators if the message broker is experiencing processing difficulties.

The default parameters associated with this test are as follows:

• The TEST PERIOD list box helps the user to decide how often this test needs to be executed.

• In the HOST text box, specify the host for which the test is to be configured.

• In the PORT text box, specify the port at which the configured Host listens; by default, this is 1883.

• The eG agent connects to the target Mosquitto MQTT, and runs MQTT API commands to pull metrics of interest. By default, the USERNAME parameter is set to none implying that the eG agent can automatically connect to the target Mosquitto MQTT and collect the required metrics. However, in some highly secure environments, administrators may have restricted the access to the target Mosquitto MQTT and would have provided access only to a specific user. In such environments, to monitor the target Mosquitto MQTT and run the API commands, the eG agent requires the credentials of that specific user. Configure this test with the Username and Password of that user in the USERNAME and PASSWORD text boxes. Finally, confirm the password by retyping it in the CONFIRM PASSWORD text box.

• By default, the SSL flag is set to No, as the target message broker is not SSL-enabled by default. If the message broker is SSL-enabled, then set this flag to Yes.

• The CA FILE parameter is applicable only if the target Mosquitto MQTT message broker is SSL-enabled i.e., the SSL flag is set to Yes.

  Specify the full path to the CA Certificate file available in the target Mosquitto MQTT message broker. For example, if the name of the CA Certificate file is m2mqtt_ca.crt and if it is available in the cert folder of the target Mosquitto MQTT host, then, the location of the file should be mentioned as: C:\Program Files\mosquitto\cert\m2mqtt_ca.crt. To know how to create a CA Certificate File, refer to the Monitoring Mosquitto MQTT document.

• The CLIENT CERT FILE parameter is applicable only if the target Mosquitto MQTT message broker is SSL-enabled i.e., the SSL flag is set to Yes.

  Specify the full path to the Client Certificate file available in the target Mosquitto MQTT message broker. For example, if the name of the Client Certificate is client.crt and if it is available in the cert folder of the target Mosquitto MQTT host, then, the location of the file should be mentioned as C:\Program Files\mosquitto\cert\client.crt. To know how to create a Client Certificate File, refer to Monitoring Mosquitto MQTT document.

• The CLIENT KEY FILE parameter is applicable only if the target Mosquitto MQTT message broker is SSL-enabled i.e., the SSL flag is set to Yes.

  Specify the full path to the Client Key Pair available in the target Mosquitto MQTT message broker. For example, if the name of the Client Key Pair is client.key and if it is available in the cert folder of the target Mosquitto MQTT host, then, the location of the file should be mentioned as C:\Program Files\mosquitto\cert\client.key. To know how to generate the Client Key pair, refer to the Monitoring Mosquitto MQTT document.

• The KEY FILE PASSWORD parameter is applicable only if the target Mosquitto MQTT message broker is SSL-enabled i.e., the SSL flag is set to Yes. Specify the password corresponding to the Client Key Pair in the KEY FILE PASSWORD text box.

• The CONFIRM PASSWORD Parameter is applicable only if the target Mosquitto MQTT message broker is SSL-enabled i.e., the SSL flag is set to Yes. Confirm the KEY FILE PASSWORD by retyping it in the CONFIRM PASSWORD text box.

• If multiple components of the same component type are awaiting configuration, then an APPLY TO OTHER COMPONENTS check box will appear in this page. Clicking on this check box will allow you to apply the configuration to all/selected components of that type.

• Once the necessary values have been provided, clicking on the UPDATE button will register the changes made.

When changing the configuration for specific servers, a “*” beside the text box corresponding to the parameter signifies that these values have to be manually configured by the user. The parameter values that require to be configured will typically be prefixed with a “$” or contain a series of “*”. A value of “none” in the parameter value indicates that the corresponding parameter value can be changed if required.