Monitoring
Gridy ID Service Event Monitoring allows Administrators to monitor & receive notifications when certain events occur.
Event monitoring & alerting are disabled by default for all API account types. Use the CLI to enable both event monitoring & alerting to start receiving alerts.
See the current list of events monitored below:
Note: Monitoring & Alerting is not available to Free service accounts.
Monitored Events
| event | enabled | description | |
|---|---|---|---|
| onNewChallenge | true | Monitor new challenge request events. | |
| onCancelChallenge | true | Monitor cancel challenge request events. | |
| onNewQRKeysChallenge | false | Monitor new QR Keys challenge request events. | |
| onNewCubeChallenge | false | Monitor new Cube ID challenge request events. | |
| onNewVoiceChallenge | false | Monitor new Voice ID challenge request events. | |
| onNewFaceChallenge | false | Monitor new Face ID challenge request events. | |
| onNewPinChallenge | false | Monitor new Pin ID challenge request events. | |
| onVerifyCode | false | Monitor successful authentication code verification events. | |
| onQRKeysAuth | false | Monitor successful QR Keys authentication events. | |
| onVoiceAuth | false | Monitor successful Voice ID authentication events. | |
| onFaceAuth | false | Monitor successful Face ID authentication events. | |
| onCubeAuth | false | Monitor successful Cube ID authentication events. | |
| onPinAuth | false | Monitor successful Pin ID authentication events. | |
| onFailedAttempt | false | Monitor failed authentication attempt events. | |
| onMaxAttempts | false | Monitor max failed authentication attempt events. | |
| onAcctBlocked | false | Monitor account blocked events. | |
| onAcctLockdown | false | Monitor account temporary lockdown events. | |
| onBlockedCheck | false | Monitor Blocked service request events. | |
| onIPAddrBlock | false | Monitor IP address blocked events. | |
| onIPRangeBlock | false | Monitor IP range blocked events. | |
| onUserBlock | false | Monitor User blocked events. | |
| onTorExitNodeBlock | false | Monitor ToR exit node blocked events. | |
| onPublicProxyBlock | false | Monitor Public Proxy blocked events. | |
| onAnonymousProxyBlock | false | Monitor Anonymous Proxy blocked events | |
| onGeoIPCtryBlock | false | Monitor Geo IP Country range blocked events. | |
| onApi500Status | false | Monitor API Intenral error events (Http 500 errors). | |
| onApi400Status | false | Monitor API User error events (Http 400 errors). | |
| onApi200Status | false | Monitor API Success events (Http 200 status). | |
| onApi202Status | false | Monitor API Accepted events (Http 202 status). | |
| onApi204Status | false | Monitor API No content events (Http 204 status). |
Note: We are adding new events all the time, so check back
Settings
Monitoring Enabled
Enable Gridy ID service event monitoring (default: false )
java -jar gridy-admin-cli.jar settings update --data '{ "monitoring-enabled": true }'
Monitor Events
Monitor Gridy ID service events (default: None )
Event Types:
- onNewChallenge
- onNewQRKeysChallenge
- onNewVoiceChallenge
- onNewFaceChallenge
- onNewCubeChallenge
- onNewPinChallenge
- onCancelChallenge
- onVerifyCode
- onQRKeysAuth
- onVoiceAuth
- onFaceAuth
- onCubeAuth
- onPinAuth
- onFailedAttempt
- onMaxAttempts
- onAcctBlocked
- onBlockedCheck
- onIPAddrBlock
- onIPRangeBlock
- onUserBlock
- onTorExitNodeBlock
- onPublicProxyBlock
- onAnonymousProxyBlock
- onGeoIPCtryBlock
- onApi500Status
- onApi400Status
- onApi200Status
- onApi202Status
- onApi204Status
java -jar gridy-admin-cli.jar settings <add|remove> --data '{ "monitor-events": "['onNewChallenge','onVerifyCode']" }'
Wildcards
Use the * wildcard to add/remove all monitor events
Example
java -jar gridy-admin-cli.jar settings <add|remove> --data '{ "monitor-events": "['*']" }'