/api/tree/notmatched

When processing a TSMeta, if the tree has strictMatch enabled and the meta fails to match on a rule in any level of the set, a not matched entry will be recorded. This endpoint allows for retrieving the list of TSUIDs that failed to match a rule set. It is useful for debugging in that if you find a TSUID in this list, you can pass it through the /tree/test endpoint to get details on why the meta failed to match.

Note

Calling this endpoint without a list of one or more TSUIDs will return all non-matched TSUIDs in the tree. If you have a large number of timeseries in your system, the response can potentially be very large. Thus it is best to use this endpoint with specific TSUIDs.

Note

If storeFailures is diabled for the tree, this endpoint will not return any data. Not Matched entries will still appear in the TSD's logs.

Verbs

  • GET

Requests

The following fields are used for this endpoint

Name Data Type Required Description Default QS RW Example
treeId Integer Required The ID of the tree to pass the TSMeta objects through treeid 1
tsuids String Required A list of one or more TSUIDs to search for not-matched entries. If requesting testing of more than one TSUID, they should be separted by a comma. tsuids 000001000001000001,00000200000200002

Response

A successful response will return a map of key/value pairs where the unrecorded TSUID as the key and a message about which rule failed to match as the value. The response will only return not matched entries that were found. If one or more of the TSUIDs requested did not result in a not matched entry, it will not be returned with the result. This may mean that the TSMeta has not been processed yet. Note that if no failed matches have occurred or the tree hasn't processed any data yet, the result set will be empty. If the requested tree did not exist in the system, a 404 will be returned with an error message. If invalid data was supplied a 400 error will be returned.

Example Response

{
  "010101": "Failed rule 0:0",
  "020202": "Failed rule 1:1"
}

© 2010–2016 The OpenTSDB Authors
Licensed under the GNU LGPLv2.1+ and GPLv3+ licenses.
http://opentsdb.net/docs/build/html/api_http/tree/notmatched.html