Geneos - REST-Extractor plugin tips

REST-Extractor plugin is introduced from Geneos GA4.11.

Here are the plugin requirements:

1. Netprobe, Gateway and License Daemon v4.11 or higher
2. Tokens for REST-Extractor license
3. Set up correct Java environment for the netprobe. You can refer to this link: https://docs.itrsgroup.com/docs/geneos/current/Netprobe/configure/configure-the-java-environment.html

Here is an example:

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

If you use curl (e.g. : curl http://myRestURL) or web browser to access the URL , here is the output:

Output in Rest-Extractor dataview:

Common errors while setting up REST-Extractor (other than missing requirements):

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 this page: https://docs.itrsgroup.com/docs/geneos/current/data-collection/rest-extractor.html#Response_format. A common mistake is missing the brackets: [ <JSON body> ] at the beginning and end of JSON body.

You can always reach out to ITRS support if you have any Geneos questions.