Sentryでエラーをモダンに確認しよう！

Posted at 2024-11-09

Sentryとは？

Sentryはエラーモニタリングツールになります！

アプリケーションのエラーや例外をリアルタイムで検出し、
詳細な情報を収集・表示するためのツールです。

Sentryを導入するといいこと

Sentryを導入することで、以下の利点があります：

Sentryの利点

リアルタイムなエラー検知：エラー発生後通知を受け取り、早期対応が可能
エラーレポート可視化：スタックトレース等、エラーが発生した状況をすぐに把握可能
頻度やユーザー影響の確認：エラーの回数、どのユーザーに影響があったのかを確認することができ、優先度を決めやすくなります！

Sentryの導入方法(Spring Boot)

今回はSpring Bootのプロジェクトを例に、導入をしてみます。

1. Sentryの新規登録

下記からSentryの公式から新規登録をしてください！
個人開発レベルであれば、課金は不要かと個人的に思います。

新規登録

公式ページにアクセスすると下記のような画面が表示されるので、
各種入力をしましょう。

Install

登録が終わったら早速「Install Sentry」からStartしましょう！

SDKを入れる

今回はJavaを例に説明していますが、色々SDKが用意されてます！

2. 依存関係を追加

gradleとmavenで記載方法は異なりますが、
バージョンは導入時の内容に合わせてください！

mavenの場合

pom.xml

<dependency>
    <groupId>io.sentry</groupId>
    <artifactId>sentry-spring-boot-starter-jakarta</artifactId>
    <version>6.19.1</version>
</dependency>
<dependency>
    <groupId>io.sentry</groupId>
    <artifactId>sentry-logback</artifactId>
    <version>6.19.1</version>
</dependency>

gradleの場合

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'io.sentry:sentry-spring-boot-starter-jakarta:6.19.1'
    implementation 'io.sentry:sentry-logback:6.19.1'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

3. SentryのDSNを設定

次にapplication.propertiesにSentryの
DSN（プロジェクトの識別子）を追加します!

application.properties

# DSNはSentryを導入時に
sentry.dsn=https://<YOUR_SENTRY_DSN>@sentry.io/<PROJECT_ID>

# 環境を指定（production, stagingなど）
sentry.environment=development

DSNを設定する必要がありますが、DSNの説明は以下になるので
こちらはご確認ください！

https://docs.sentry.io/concepts/key-terms/dsn-explainer/

4. Springの方でエラーを発生させる

Springの方でSentryに意図的なエラーを発生させましょう！

sampleController.java

@Controller
public class ErrorController {
    
    @GetMapping("/a")
    public String generateError() {
        try {
            throw new Exception("This is Test.");
        } catch (Exception e) {
            Sentry.captureException(e);
        }
    }
}