Description
At the beginning we decided to use SA (Server Admin Log) with mwbot library to log instrument interactions (for example, when launching a new one) but, at this moment, there is an open discussion about how to deal with "deployment-like" events.
The code to log those events to SAL is already working (but disabled) when launching instruments but we should work on an abstraction layer to be ready for a change regarding the way of doing this.
Extracted from the Design Document:
@cming@wikimedia.org @Sfaci@wikimedia.org Be aware that there may be a need to abstract away precisely how we're logging to the SAL (or "deployment-like" events). For now, it might do to just put the SAL-updating logic behind an interface so that it can be varied later, e.g.
interface DeploymentLogger {
async logDeployment( instrumentName, message ): void;
}
Acceptance criteria
- Create an abstraction layer to log "deployment-like" events
- Implement the way of logging "deployment-like" events according to the decision we finally make
Required
- Unit/Integration tests
- Testing instructions
- Documentation