Monitoring hooks¶
Configuration and code runs in an 'if exists' method, so that if it is not defined, the Monitoring framework will behave no differently. All of the functions below are optional when creating a client package.
Functions¶
Index¶
.client.gw.client.queryDetails¶
| Function | .client.gw.client.queryDetails |
|---|---|
| Purpose | This hook allows for custom code to be run to modify the data before the GwQueryStatus table is published into the Monitoring framework. It is invoked by the Gateway from .gw.client.sendResponse. |
| Arguments | queryStatusDetails (dictionary) |
| Output | queryStatusDetails (dictionary) |
| How to use | Data inside the 'response' and 'detail' values will be published into the Monitoring framework. Any new fields will also need to be added to the GwQueryStatus yaml in order to be persisted to the GwQueryStatus table. |