Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/transferwise/tw-incidents
https://github.com/transferwise/tw-incidents
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/transferwise/tw-incidents
- Owner: transferwise
- License: other
- Created: 2019-05-09T07:26:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-22T07:38:22.000Z (6 months ago)
- Last Synced: 2024-07-22T09:05:09.790Z (6 months ago)
- Language: Java
- Size: 194 KB
- Stars: 1
- Watchers: 87
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Tw Incidents
Allows applications to raise incidents and recover from them.
Configuration options are in [IncidentsProperties](tw-incidents/src/main/java/com/transferwise/common/incidents/IncidentsProperties.java)
Engineers have to provide implementations for `IncidentGenerator`s, which are responsible for gathering active incidents.
Optionally engineers can also provide implementations for `IncidentNotifier`s, which could broadcast incidents activations and recoveries to slack, email, logs etc.
An example for `IncidentGenerator`:
```
public class StuckTasksIncidentGenerator implements IncidentGenerator {
@Autowired
private ITaskDao taskDao;
private Incident incident;
@Override
public List getActiveIncidents() {
int cnt = taskDao.getTasksCountInStatus(TaskStatus.ERROR);
if (cnt > 0) {
if (incident == null) { // If there already is active incident, we would use that. We would not want to spam VictorOps with new incident per polling interval.
incident = new Incident()
.setMessage("" + cnt + " tasks in ERROR state.")
.setSummary("" + cnt + " tasks in ERROR state.");
}
} else {
incident = null;
}
return Arrays.asList(incident);
}
@Override
public Duration getPollingInterval(){
// Getting count from database may be somewhat slow, so we provide larger getActiveIncidents call interval.
return Duration.ofMinutes(5);
}
}
```
## VictorOps
Configuration options are in [VictorOpsProperties](tw-incidents/src/main/java/com/transferwise/common/incidents/victorops/VictorOpsProperties.java).
VictorOps example:
```yaml
tw-incidents:
victorops:
enabled: true
notify-base-url: https://alert.victorops.com/integrations/generic/20131114/alert/
api-token: '{cipher}MagicNumber123'
routing-key: currencies
incident-id-prefix: '${spring.application.name}/${partner-service.node-id}/'
```
Notes:
1. The `notify-base-url` is not just an example. This is the url that all the services should use.
2. You can get the `api-token` [here](https://portal.victorops.com/dash/transferwise/#/advanced/rest)
## Slack
Configuration options are in [SlackProperties](tw-incidents/src/main/java/com/transferwise/common/incidents/slack/SlackProperties.java)
Slack example:
```yaml
tw-incidents:
slack:
enabled: true
url: http://hooks.slack.com/...
incidentIdPrefix: test-service
```
During testing, it might be useful to set the `channel` property to your Slack `@username`, so that messages come to you as Slackbot ones.
## License
Copyright 2021 TransferWise Ltd.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.