Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/resultadosdigitais/hellper
Incident Manager Hellper bot aims to orchestrate the process and resolution of incidents, reducing the time spent with manual tasks and ensuring that the necessary steps are fulfilled in the right order. Also, it facilitates the measurement of impact and response rate through metrics.
https://github.com/resultadosdigitais/hellper
hacktoberfest incident slack
Last synced: about 1 month ago
JSON representation
Incident Manager Hellper bot aims to orchestrate the process and resolution of incidents, reducing the time spent with manual tasks and ensuring that the necessary steps are fulfilled in the right order. Also, it facilitates the measurement of impact and response rate through metrics.
- Host: GitHub
- URL: https://github.com/resultadosdigitais/hellper
- Owner: ResultadosDigitais
- License: mit
- Created: 2020-04-09T20:30:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T06:57:12.000Z (almost 2 years ago)
- Last Synced: 2024-03-26T13:56:14.362Z (9 months ago)
- Topics: hacktoberfest, incident, slack
- Language: Go
- Homepage:
- Size: 699 KB
- Stars: 52
- Watchers: 94
- Forks: 11
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
Hellper - Your best friend in times of crisis
Hellper bot aims to orchestrate the process and resolution of incidents, reducing the time spent with manual tasks and ensuring that the necessary steps are fulfilled in the right order. Also, it facilitates the measurement of impact and response rate through metrics.
A chance to help explore and develop a bot written in Go, integrated with multiple external platforms and tools.
Help us expand incident processes’ and understand the needs of other companies that may benefit from Hellper bot.
You’re just one PR away from joining the developing team of Hellper! Contribute
---
## Contents
- [Contents](#contents)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installing](#installing)
- [Variables explanation](#variables-explanation)
- [Running the Tests](#running-the-tests)
- [Running the application](#running-the-application)
- [Deployment](#deployment)
- [Setup database](#setup-database)
- [Optional Setup](#optional-setup)
- [Ngrok (To receive events from Slack)](#ngrok-to-receive-events-from-slack)
- [Golang](#golang)
- [Database](#database)
- [How to use](#how-to-use)
- [Commands](#commands)
- [Metrics](#metrics)
- [Alerts](#alerts)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Need help?](#need-help)
- [License](#license)
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
### Prerequisites
1. [Docker Compose](https://github.com/docker/compose/releases)
2. [Slack Account](https://slack.com/)
3. [G Suite Account](https://gsuite.google.com/)
### Installing
1. Clone this repo
```shell
git clone [email protected]:ResultadosDigitais/hellper.git
```
2. [Configure Slack](/docs/CONFIGURING-SLACK.md)
3. [Configure Google](/docs/CONFIGURING-GOOGLE.md)
4. Make a copy from configuration example
```shell
cp development.env.example development.env
```
#### Variables explanation
| Variable | Explanation | Default value |
| --- | --- | --- |
|**HELLPER_BIND_ADDRESS**|Hellper local bind address|`:8080`|
|**HELLPER_DATABASE**|Database provider (supported values: postgres)| `postgres` |
|**HELLPER_DSN**|Your Data Source Name| --- |
|**HELLPER_ENVIRONMENT**|Current environment (supported values: production, staging)| --- |
|**HELLPER_GOOGLE_CREDENTIALS**|[Google Credentials](/docs/CONFIGURING-GOOGLE.md#Get-a-Client-ID-and-Client-Secret)| --- |
|**HELLPER_GOOGLE_DRIVE_TOKEN**|[Google Drive Token](/docs/CONFIGURING-GOOGLE.md#Generate-Google-Drive-access-token)|
|**HELLPER_GOOGLE_DRIVE_FILE_ID**|[Google Drive FileId](/docs/CONFIGURING-GOOGLE.md#Template-Post-mortem) to your post-mortem template| --- |
|**HELLPER_GOOGLE_CALENDAR_TOKEN**|[Google Calendar Token](/docs/CONFIGURING-GOOGLE.md#Generate-Google-Calendar-access-token)|
|**HELLPER_GOOGLE_CALENDAR_ID**|[Google Calendar Id](/docs/CONFIGURING-GOOGLE.md#Obtain-your-Google-Calendar's-ID) to schedule your post-mortem |
|**HELLPER_POSTMORTEM_GAP_DAYS**|Gap in days between resolve and postmortem event, by dafault the gap is 5 days if there is no variable| `5` |
|**HELLPER_MATRIX_HOST**|[Matrix](https://github.com/ResultadosDigitais/matrix) URL host| --- |
|**HELLPER_PRODUCT_CHANNEL_ID**|The Product channel id used to notify new incidents| --- |
|**HELLPER_NOTIFY_ON_RESOLVE**|Notify the Product channel when resolve the incident| `true` |
|**HELLPER_NOTIFY_ON_CLOSE**|Notify the Product channel when close the incident| `true` |
|**HELLPER_NOTIFY_ON_CANCEL**|Notify the Product channel when cancel the incident| `true` |
|**HELLPER_SUPPORT_TEAM**|Support team identifier to notify| --- |
|**HELLPER_PRODUCT_LIST**|List of all products splitted by semicolon| `Product A;Product B;Product C;Product D` |
|**HELLPER_REMINDER_OPEN_STATUS_SECONDS**|Contains the time for the stat reminder to be triggered in open incidents, by default the time is 2 hours if there is no variable| `7200` |
|**HELLPER_REMINDER_RESOLVED_STATUS_SECONDS**|Contains the time for the stat reminder to be triggered in resolved incidents, by default the time is 24 hours if there is no variable| `86400` |
|**HELLPER_REMINDER_OPEN_NOTIFY_MSG**|Notify message when status is open| `Incident Status: Open - Update the status of this incident, just pin a message with status on the channel.` |
|**HELLPER_REMINDER_RESOLVED_NOTIFY_MSG**|Notify message when status is resolved| `Incident Status: Resolved - Update the status of this incident, just pin a message with status on the channel.` |
|**HELLPER_OAUTH_TOKEN**|[Slack token](/docs/CONFIGURING-SLACK.md#OAuth-Access-Token) to exeucte bot user actions| --- |
|**HELLPER_SLACK_SIGNING_SECRET**|[Slack token](/docs/CONFIGURING-SLACK.md#Signing-Secret) to verify external requests| --- |
|**FILE_STORAGE**|Hellper file storage for postmortem document| `google_drive` |
|**TIMEZONE**|Timezone for Post Mortem Meeting| `America/Sao_Paulo` |
|**HELLPER_SLA_HOURS_TO_CLOSE**|Number of hours between the incident resolution and Hellper reminder to close the incident.| `168` |
## Running the Tests
1. `make test`
## Running the application
2. `make run`
## Deployment
[](https://heroku.com/deploy)
### Setup database
- Run this command and copy the address:
`heroku config:get DATABASE_URL`
- Run this command and past it on the YOUR_DATABASE_URL:
`heroku config:set HELLPER_DSN=YOUR_DATABASE_URL`
- Import the scheema changing `YOUR_HEROKU_APP_NAME` by your application name:
`heroku pg:psql --app YOUR_HEROKU_APP_NAME < internal/model/sql/postgres/schema/hellper.sql`
- Configure your [environment variables](#Variables-explanation)
## Optional Setup
### Ngrok (To receive events from Slack)
- Download Ngrok and create an account
- `sudo cp ngrok /usr/local/bin`
- `ngrok http 8080`
- Copy your public address. You'll need this to [Configure Slack API](/docs/CONFIGURING-SLACK.md)
### Golang
- Install [golang](https://golang.org/doc/install)
OR
1. Install [gvm](https://github.com/moovweb/gvm)
2. Follow gvm post install instructions
3. Install go 1.14 as default
### Database
```shell
psql $HELLPER_DSN -f "./internal/model/sql/postgres/schema/hellper.sql"
```
## How to use
### Commands
After [Configuring Slack](/docs/CONFIGURING-SLACK.md) you can use the commands created. The commands are as it follows:
| Command | Short Description |
| - | - |
|`/hellper_incident`|_Starts Incident_|
|`/hellper_status`|_Show all pinned messages_|
|`/hellper_close`|_Closes Incident_|
|`/hellper_resolve`|_Resolves Incident_|
|`/hellper_cancel`|_Cancels Incident_|
|`/hellper_pause_notify`|_Pauses incident notification_|
|`/hellper_update_dates`|_Updates the dates for an incident_|
The first command `/hellper_incident` can be use at any channel and/or conversation on Slack. It will open a pop-up for the user to set and start an Incident, creating the channel, meeting room link and post-mortem doc.
The remaining commands must be used only on the Incident's channel since they act on the specific incident that is open.
### Metrics
This metrics came from `metrics` view table, they are calculated by the following formulas:
| Metric | Description | Formula |
| --- | --- | --- |
| **start_ts** | Date and time when the incident is started | Date and time in UTC from db |
| **identification_ts** | Date and time when the incident is identified | Date and time in UTC from db |
| **end_ts** | Date and time when the incident is resolved | Date and time in UTC from db |
| **acknowledgetime** | Time To Acknowledge | `identification_ts` - `start_ts` |
| **solutiontime** | Time To Solution | `end_ts` - `identification_ts` |
| **downtime** | Time in an incident | `end_ts` - `start_ts` |
| **MTTA** | Mean Time To Acknowledge | `total acknowledgetime` / `total incidents` |
| **MTTS** | Mean Time To Solution | `total solutiontime` / `total incidents` |
| **MTTR** | Mean Time To Recovery | `total downtime` / `total incidents` |
### Alerts
Alerts are useful for notifying the status of incidents. Notifications can be used in different situations, such as requesting an update of the incident status or finalizing the post-mortem. For this you can use the CLI `notify` on your CronJob service.
To use the CLI you need to build the binary file:
```shell
go build -o notify cmd/notify/main.go
```
#### Example of use
```shell
SHELL=/bin/bash
BASH_ENV=/app/.env
# At 16:30 on every week-day, from Monday through Friday, it sends a report to a selected channel with all incidents not closed
30 16 * * 1-5 root /app/notify --type=report --to=YOUR_SLACK_CHANNEL_ID --status=all
# Every 30th minute it sends a status update request alert for all open incidents
0/30 * * * * root /app/notify --type=channels --status=open
# At 13:30 on every week-day, from Monday through Friday, sends a post-mortem request alert for all resolved incidents
30 13 * * 1-5 root /app/notify --type=channels --status=resolved
```
## Contributing
Thanks for being interested in contributing! We’re so glad you want to help! Please take a little bit of your time and look at our [contributing guidelines](/docs/CONTRIBUTING.md). All type of contributions are welcome, such as bug fixes, issues or feature requests.
## Code of Conduct
Everyone interacting in the Hellper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](/docs/CODE_OF_CONDUCT.md).
## Need help?
If you need help with Hellper, feel free to open an issue with a description of the problem you're facing.
## License
The Hellper is available as open source under the terms of the [MIT License](LICENSE).