Skip to content

Latest commit

 

History

History
128 lines (88 loc) · 3.69 KB

README.md

File metadata and controls

128 lines (88 loc) · 3.69 KB
Raw

sentry-mattermost-sidecar

This tools is a sidecar to use sentry webhook on mattermost.

Roadmap

  • Handle sentry Issue alerts
  • Handle sentry Metric alerts

How to use

First you must create a Mattermost incoming webhook integration. mattermost-incoming-webhook-integration-setup

Next you must deploy the docker image (don't forget to fill SMS_MATTERMOST_WEBHOOK_URL environment variable with the Mattermost webhook URL) somewhere and redirect sentry webhook on it with route name defined as Mattermost channel for each projects. sentry-webhook-integration-setup

Then you setup sentry issue alerts as you like. sentry-issue-alert-creation

Getting started

Requirement

  • docker
  • bash
  • virtualbox (if you want to setup local mattermost and sentry instance)
  • vagrant (if you want to setup local mattermost and sentry instance)

Hack

To start you must launch dev environment:

$ ./scripts/up.sh

This will launch images in docker-compose.yml.

An image named workspace with golang is used as a isolated container to develop. You can use enter-workspace.sh to enter inside it:

$ ./scripts/enter-workspace.sh

From outside the container you can build with:

$ ./scripts/build.sh

You can test an example sentry webhook with:

$ ./scripts/test-request.sh

Then you can see the converted request that will be send to mattermost using:

$ ./scripts/get-last-request-result.sh

Deploy

This image is automatically deployed and versionned as a docker image at itsalex/sentry-mattermost-sidecar.

To deploy a new tag use ./scripts/create-and-push-tag.sh:

$ ./scripts/create-and-push-tag.sh 1.0.0

Setup VM with Mattermost and Sentry

You can setup a VM with Mattermost and Sentry if you want to perform real tests. You should have at least:

  • 16 CPU thread
  • 20GB RAM

If you valid those requiremnts, you can launch the VM:

$ vagrant up

A server will be launch with Mattermost and Sentry installed, you should now create Sentry first user:

$ vagrant ssh -c "cd /opt/sentry && sudo docker compose run web upgrade"
...
Running hooks in /etc/ca-certificates/update.d...
done.
Running migrations for default
Operations to perform:
  Apply all migrations: auth, contenttypes, feedback, hybridcloud, nodestore, replays, sentry, sessions, sites, social_auth
Running migrations:
  No migrations to apply.
Creating missing DSNs
Correcting Group.num_comments counter
17:26:28 [INFO] sentry.outboxes: Executing outbox replication backfill
17:26:28 [INFO] sentry.outboxes: Processing sentry.ControlOutboxs...
17:26:28 [INFO] sentry.outboxes: Processing sentry.RegionOutboxs...
17:26:28 [INFO] sentry.outboxes: done

Would you like to create a user account now? [Y/n]:

Follow the instruction to create Sentry default user. Mattermost default user will be asked on the first connection on Mattermost url.

You're now ready, you can new access services with the following URLs:

The VM have a static IP so you can always access it with IP 192.168.56.4. You can find the IP of your computer accessible from the VM using:

$ ip a | grep 192.168.56 | awk '{print $2}'
192.168.56.1/24