Back to Geneos FAQ

REST-Extractor plugin tips

REST-Extractor plugin is introduced from Geneos GA4.11. This support article aims to help users get started. For more details, we have provided links to the product documentations at the end of this article.

Plugin requirements Copied

1. Netprobe, Gateway, and Licence Daemon v4.11 or higher
2. Tokens for REST-Extractor plugin available for Licence Daemon
3. Set up correct Java environment for the Netprobe

Warning

REST-Extractor plugin has been tested with OpenJDK only. We have received issue reports from users who have tried Java runtime from certain software vendors. While the Netprobe log may be able to detect the Java paths, users may encounter symptoms that the plugin may be unable to expand or display a blank dataview on Active Console. Users are advised to check the compatibility section.

Example:

In Url, it is the source URL which the REST Extractor plug-in expects a JSON response.

If you use curl—for example, http://myRestURL or web browser to access the URL, here is the output:

Output in Rest-Extractor dataview:

Common errors Copied

1. Make sure the connection can be established from the server which has netprobe installed. You can test the connection by using curl command.

2. Make sure the JSON data returned by the URL is valid. There are web sites like https://jqplay.org/ that can help perform JSON format validation.

3. Wrong query in the Query field. If you put down an unsupported query, you will get that error. Test your query in https://jqplay.org/ before putting it into REST-Extractor.

4. Make sure your JSON query returns an output that follows the Response format as described in the Rest Extractor. A common mistake is missing the brackets, such as [<JSON body>], at the beginning and end of JSON body.

For more information, see Release Notes, REST Extractor, and Configure the Java environment for Netprobe.