Skip to content

BenefexLtd/incident-bot

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Incident Bot

tests version

Incident management framework centralized around a ChatOps bot to allow your teams to easily and effectively identify and manage technical incidents impacting your cloud infrastructure, your products, or your customers' ability to use your applications and services.

Incident Bot's Documentation

Need support or just want to chat with us? Join us on Discord.

Features

  • Organize your efforts into Slack channels to coordinate incident response
  • Easy to read messages that get to the point without a ton of visual distractions
  • Completely customizable status, severity, and role definitions to control all stages of incident response
  • Communicate with the bot using ephemeral messages to keep clutter out of your channels
  • Keep the rest of your organization informed with an incident digest channel that explains the state of all incidents
  • Integrate with tools you already use like Confluence, Jira, Opsgenie, Statuspage, PagerDuty, and Zoom
  • Automatically build a postmortem document base to save time
  • A web interface for advanced features and organizational capabilities [TBD]

Quick Start

  • Create a Slack app for this application. You can name it whatever you'd like.
  • Select from an app manifest and copy manifest.yaml out of this repository and paste it in to automatically configure the app and its required settings. Be sure to override any customizable settings like name, etc.
  • You'll need the app token, bot token, and user token for your application and provide those as the SLACK_APP_TOKEN, SLACK_BOT_TOKEN, and SLACK_USER_TOKEN environment variables - these can be found within the app's configuration page in Slack. For more information on Slack tokens, see the documentation here.
  • You'll need a Postgres instance to connect to. If trying the bot out using Docker Compose or Helm, there are options to run a database alongside the app.
  • Configure and deploy the application using one of the methods described in the documentation, or however you choose. (There's a Docker image available.)

Full setup documentation is available here.

Feedback

This application is not meant to solve every problem with regard to incident management. It was created as an open-source alternative to paid solutions.

If you encounter issues with functionality or wish to see new features, please open an issue or a feature request to let us know.

We encourage you to join the community Discord if you wish to interact with us directly.

Development

Install Poetry.

poetry install --no-root

poetry shell

From here, you can use the Makefile or simply run python3 main.py to start the application.

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 94.5%
  • Shell 4.6%
  • Other 0.9%