https://github.com/moviestoreguy/detector-doctor

Ensure that the detector doesn't skip a beat
https://github.com/moviestoreguy/detector-doctor

Last synced: 3 days ago
JSON representation

Ensure that the detector doesn't skip a beat

• Host: GitHub
• URL: https://github.com/moviestoreguy/detector-doctor
• Owner: MovieStoreGuy
• License: mit
• Created: 2020-03-16T04:31:49.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-03-26T02:31:15.000Z (over 4 years ago)
• Last Synced: 2024-10-11T18:31:05.076Z (27 days ago)
• Language: Go
• Size: 43.9 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Detector Doctor

_Ensure your detectors never skip a beat_  

Help ensure the health of the detector and if there is any required actions that need to come of it.

This should helpfully resolve the issue of understand where the issue lays and what needs to be done 

as part of it.

## Development

 

The follow code has been developed against Go version 1.14 and to ensure a transparent build environment docker is also employed.

## Usage

```bash

$ detdoc [--flags] --token ${SFX_API_TOKEN} detectorID, ...

```  

_To get the most up to date flags, run the application locally_

This will query the SignalFx API to read the detectorIDs provided to it establish if there is any obvious errors with the detector,

the result of this will produce a report for each detector request.

## Intent / How it works

The application will query the detector in order to establish what is the current issue with the detector:

| Testing                     | Issue            | Implemented?                                                |

|-----------------------------|------------------|-------------------------------------------------------------|

| OverMTS Limt                | User             | Yes, Queries the result of the detector                     |

| Has Notificaiton            | User             | Yes, checks to see if any notification rules are set        |

| Has Program Text            | User             | Yes, checks to see if there is any program text defined     |

| Is locked                   | System           | Yes, though not sure what can cause a detector to be locked |

| Valid SignalFlow            | User             | Yes, it processed using websockets                          |

| Handling Sparse Metrics     | User             | Yes, there is currently an active check to address this     |

| Disabled rules              | User             | Yes, queries the rules set with a detector                  |

| Depends on properties       | User             | No, currently looking at way to handle this check           | 

| Metrics are delayed         | Informational    | No, need to be able to query the underlying MTS             |

| Missed alert                | System           | No, need to be able to take the signalflow and compare when it should of fired when looking at last modified time |

| Missed fired detector       | System           | No, need to figure out how best to do this                  |

| Drop in data points         | Informational    | No, relies on querying MTS which isn't implemented          |