Djangoの500エラーをSlackに通知する方法を解説（トレースバック付き）

sample_web/
├── .env                        # 環境変数ファイル
├── docker-compose.yml          # Docker Compose設定ファイル
├── manage.py                   # Django管理スクリプト
├── sample_project/             # プロジェクト名
│   ├── asgi.py                 # ASGI設定ファイル
│   ├── settings.py             # プロジェクト設定ファイル
│   ├── urls.py                 # URLルーティング
│   ├── wsgi.py                 # WSGI設定ファイル
│   ├── static/                 # 静的ファイルディレクトリ
│   │   └── css/
│   │       └── base.css        # ベースCSSファイル
│   └── templates/              # HTMLテンプレートディレクトリ
│       └── home.html           # ホームページのテンプレート
├── home/                       # アプリフォルダ
│   ├── views.py                # ビューファイル
│   └── migrations/             # マイグレーションファイル
└── common/                     # 共通機能用フォルダ
    └── send_error_log.py       # エラーログ送信スクリプト

pip install requests

import traceback
import requests
import json

from django.views.decorators.csrf import requires_csrf_token
from django.views.defaults import server_error

# Slackにメッセージを送信する
def send_error_to_slack(message_list, color, username):

    WEBHOOK_URL = "ここに先ほどコピーしたWebhook URLを張り付け"

    # メッセージを送信
    requests.post(
        WEBHOOK_URL,
        data=json.dumps(
            {
                "attachments": [
                    {
                        "text": "\n".join(message_list),
                        "color": color,
                    }
                ],
                "username": username,
            }
        ),
    )

# 500番エラーをSlackに通知
@requires_csrf_token
def server_error_send_to_slack(
    request,
    template_name="500.html",
):
    # Slackにエラーメッセージを通知する
    message_list = [
        "🚨 **500 Internal Server Error 発生** 🚨",
        f"URL: {request.build_absolute_uri()}",
        f"メソッド: {request.method}",
        f"Traceback:```\n{traceback.format_exc()}\n```",
    ]

    # Slackにエラーメッセージを通知する
    send_error_to_slack(message_list, "danger", "システムエラー通知")

    return server_error(request, template_name)

WEBHOOK_URL = "ここに先ほどコピーしたWebhook URLを張り付け"

WEBHOOK_URL = "https://hooks.slack.com/services/~~~"

# Slackにエラーメッセージを通知する
message_list = [
    "🚨 **500 Internal Server Error 発生** 🚨",
    f"URL: {request.build_absolute_uri()}",
    f"メソッド: {request.method}",
    f"Traceback:```\n{traceback.format_exc()}\n```",
]

from django.contrib import admin
from django.urls import include, path
from common.send_error_log import server_error_send_to_slack

urlpatterns = [
    path("admin/", admin.site.urls),
    # ~~~
]

# 500番エラーをSlackに通知する設定
handler500 = server_error_send_to_slack

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = False

from django.views.generic import TemplateView

# ホームページ
class HomePage(TemplateView):

    template_name = "home.html"

    def get(self, request, *args, **kwargs):

        # 500エラーを起こす
        print(hogehoge)
        return super().get(request, *args, **kwargs)

from django.views.generic import TemplateView
from common.send_error_log import send_error_to_slack

# ホームページ
class HomePage(TemplateView):

    template_name = "home.html"

    def get(self, request, *args, **kwargs):
        try:
            # 感知させたい処理を行う
            pass
        except Exception:

            # 処理が上手くいかない時にエラーメッセージを設定して通知
            message_list = [
                "🚨 **500 Internal Server Error 発生** 🚨",
                f"〇〇の処理でエラーが起きちゃった！テヘペロ！",
            ]
            send_error_to_slack(message_list, "danger", "システムエラー通知")

        return super().get(request, *args, **kwargs)