Sentryの基本的な使い方

はじめに

エラー監視ツールの一つである Sentry についてインストールから基本的な使い方までをまとめたドキュメントです。多くの言語に対応していますが、ここでは、Pythonでの利用例を記載します。

Sentry とは

Sentryとは、アプリケーションを運用するうえでエラー監視をしてくれるツールです。フロントエンド系やサーバーレスプラットフォームにも対応しています。 Sentry のページから体系的にエラーを監視できます。本家ホームページでは、100 万人の開発者と 8 万の組織が利用していると記載されています。

インストール

sentry-sdk を pip でインストールします。

$ pip install --upgrade sentry-sdk

使い方

ユーザー登録

まず、ユーザー登録をします。こちらのSentry のページへ行き、必要な情報を入力してユーザー登録します。

プロジェクトの作成

Sentry のページでプロジェクトを作ります。使用する言語を選択すると、設定方法や使い方を示してくれます。プロジェクト作成画面で Python を選択し、[Create Project]ボタンを押します。

すると、インストールの方法から設定方法まで表示されます。

エラー監視

プロジェクト作成時に示されたように、以下のコードをプログラムの実行時に必ず呼ばれるどこかに記述します。例えば、設定ファイルを扱うパッケージの init.py の中に書いておきます。

import sentry_sdk

# DSNの値を設定
sentry_sdk.init(
    "https://*****.ingest.sentry.io/****",

    traces_sample_rate=1.0
)

エラーの内容等は、Sentry のページの Issues に表示されます。

試してみる

Warning、Error と例外を発生させて、どのように監視できるか実際に試してみます。

以下のように、Warning、Error と例外を発生させる Python コードを実行してみます。

import logging
import sentry_sdk

# sentry sdk 初期化
sentry_sdk.init(
    "https://*******.ingest.sentry.io/*******",

    traces_sample_rate=1.0
)

# ログを出力
logging.warning('WARNING のログ')
logging.error('ERROR のログ')

# 例外の発生
raise Exception('例外の発生')

Sentry のページへ行き、Issues を見るとエラー等の一覧が表示されます。

各項目をみると詳細が表示されます。エラーはこのように表示されます。

例外は、このように表示されます。

参考

備考

Hakky ではエンジニアを募集中です！まずは話してみたいなどでも構いませんので、ぜひお気軽に採用ページからお問い合わせくださいませ。