Searching for Monitor documents
While intended for API monetization and throttling, data in the Monitor search index can still be used for integrations that need statistical accounts of service invokes. In this page, we will discuss the different methods you can use in order to preview or obtain Monitor data for your integrations.
Using the user interface
Of all interfaces compatible with TORO Integrate v3.2.6, only the Server Admin UI demonstrates querying capabilities against the Invoke monitor search index. In particular, searches can be done through interface elements located at the static search bar, seen at the top of the Server Admin UI.
Viewing all documents
Go to the static search bar located at the top of the Server Admin web interface. Select Monitor from the dropdown, and click the search button to go to the Monitor page.
The Monitor page will display all documents residing in the instance's Monitor search index. To update displayed results, refresh the page.
Viewing document details
To view the details of a specific Monitor document, click the document's ID from the table displayed in the Monitor page. A modal on the right side of the page would appear with the requested information.
Use the search bar in the Monitor user interface to look for documents containing field values that match the provided input string. Type the text to match in the search bar and then press .
You can also filter Monitor documents using facets. Click the facet field you want to filter by, and then select a value from the appearing dropdown to filter documents using the selected facet. You'll notice next to each facet is a number. This number is the number of documents in the Monitor search index that match the facet.
If you need finer-grained searches, you can use the Advanced Filter form. This type of search allows you to specify a value-to-match per field. Click the inverted triangle beside the search button to make the form appear.
Using RESTful web services
As with the other search indices, the Tracker search index can be queried and managed via the Solr Search API. Simply ensure the following path parameters are substituted when sending requests:
For ease of use, there are also Monitor endpoints exposed in TORO Integrate's own REST API.
To query the Invoke monitor search index in Gloop, create an invoke step (preferred) or
Gloovy step calling any of the search methods belonging to
MonitorMethods. Your step should roughly look like this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
SearchResult searchMonitor(query, monitorDocumentIds, trackerDocumentIds, packageNames, endpointTypes, users, endpointNames, serviceNames, urls, successes, startDate, endDate, minimumCost, maximumCost, pageSize, page)
MonitorMethods has other utility methods for your Invoke monitor-related needs
MonitorMethods contains convenience methods for:
- Managing and retrieving Monitor rules
- Fetching the billing details of your users
- Setting or fetching HTTP request costs