Use an OEJMX query to get agent information

Use OEJMX with the -Q filepathname parameter to use a custom query file. A query file can have multiple queries. For more information about the OEJMX command syntax, see OEJMX utility.

Each JMX query is a JSON string with an MBean identifier and attribute or operation information. The query format is:

• O—ObjectName is a JsonObject

• M—Operation is a JsonArray

• A—(optional) Attribute is a JsonObject

{"O":"PASOE:type=OEManager,name=AgentManager","M":["getAgents","oepas1"]}

In List available MBeans to locate AgentManager details, steps are provided to list the available MBeans. From that list, the operations and attributes for the AgentManager are identified. To collect information about the agents, create a custom OEJMX query file using the getAgents API for the default oepas1 instance.

To write a custom OEJMX query:

1. Create a new file in your PAS for OpenEdge instance's bin\jmxqueries directory called getAgents.qry.
2. Add the following line to the getAgents.qry file:

   {"O":"PASOE:type=OEManager,name=AgentManager","M":["getAgents","oepas1"]}

   This line contains a JMX query to access the AgentManager MBean, and specifically the getAgents JMX API. This provides information about the running agents in the PAS for OpenEdge instance, which can be used to get thread and session information, status, and other metrics.

   The query returns the agent information for the default oepas1 instance. If you are running this query on a PAS for OpenEdge instance with a different name, change oepas1 to the name of the current instance or ABL application that you want to get agent information about.

   If you want agent information for all running ABL applications on the PAS for OpenEdge instance, you can specify APP_NAME instead of oepas1 (or other ABL application name). APP_NAME is a supported token that returns information for all ABL applications on the PAS for OpenEdge instance. More information about supported tokens is described inCommon OEJMX queries.

   Note: A query must be a single line that does not contain embedded spaces. A query file can contain multiple queries. The best practice is to use explicit names over tokens to guarantee the intended results. In this example, oepas1 replaces the APP_NAME token.
3. Navigate to the bin directory of the instance, for example:

   proenv>cd %WRKDIR%\oepas1\bin

4. Ensure the instance is running by executing the following command:

   proenv>tcman pasoestart -restart

5. Run the OEJMX getAgents query that you created in step one, for example:

   proenv>oejmx -Q jmxqueries\getAgents.qry

   The default output location is instance_name/temp/queryname-out-yyMMdd-HHmm.txt.

6. Review the output getAgents-outyyMMdd-HHmm.txt file in the instance_name/temp directory to see the query response, for example:

   Query: Line 1. PASOE:type=OEManager,name=AgentManager, getAgents(oepas1) Result: {"getAgents":{"agents":[{"agentId":"b4XlcFFOR_uh68bStvHe1Q","pid":"26896","state":"AVAILABLE"}]}}

   Note: The output shows the original query on line 1 and the results on the next line. The original query message can be suppressed by running the OEJMX query with the -R option, for example:

   proenv>oejmx -Q jmxqueries\getAgents.qry -R

   For more information about the OEJMX command syntax, see OEJMX utility.

   The output of the getAgents query provides the Agent ID and PID for the running ABL application agents. You can use this information to gather more information about your agent, such as threads and session metrics. For more information, see Use an OEJMX query to get session metrics and Common OEJMX queries.