すべてのプロダクト
Search
ドキュメントセンター

Microservices Engine:マイクロサービスガバナンスへのカスタムインターフェイスの追加

最終更新日:Mar 11, 2026

Microservices Engine (MSE) は、Spring MVC エンドポイントや Dubbo サービスなど、フレームワークレベルのインターフェイスを自動的に検出します。これらのフレームワークに該当しないビジネスロジック(例:バッチジョブ、定期タスク、内部検証ルーティン)については、Sentinel SDK を使用してカスタムインターフェイスを登録できます。登録後、これらのインターフェイスは MSE コンソールに表示され、速度制限、サーキットブレーカー、および隔離ルールを適用できます。

カスタムインターフェイスのガバナンスには、以下の 2 つの独立した手順が必要です:

  1. コードをインストルメント化する -- 対象のコードブロックを Sentinel API でラップして、リソースとして登録します。

  2. MSE コンソールでのルール設定 — リソースに対して速度制限、サーキットブレーカー、または隔離ルールを適用します。

本トピックでは手順 1 を説明します。イベントトラッキングが完了すると、カスタムインターフェイスはトラフィックを受信するたびに MSE コンソールに表示されます。その後、コンソールからガバナンスルールを設定できます。

前提条件

開始する前に、以下の条件を満たしていることを確認してください。

  • マイクロサービスガバナンスが有効化されたアプリケーション

  • MSE Java エージェント バージョン 3.2.9 以降

説明

エージェントのバージョン詳細については、「Java エージェントのリリースノート」をご参照ください。特定のバージョンを固定する方法については、「エージェントのバージョン指定」をご参照ください。

可視化にはトラフィックが必要

プログラミングパターンの制約により、マイクロサービスガバナンスではトラフィックを受信したカスタムインターフェイスのみが表示されます。イベントトラッキング済みのコードブロックが呼び出されていない場合、コンソールには表示されません。

SDK の依存関係を追加

pom.xml に Sentinel コアライブラリを追加します。

<dependency>
  <groupId>com.alibaba.csp</groupId>
  <artifactId>sentinel-core</artifactId>
  <version>1.8.7</version>
</dependency>

ビジネスロジックのラップ

SphU.entry() を try-with-resources ブロック内で使用して、コードセクションを Sentinel リソースとして登録します。リソース名は、MSE コンソール上のモニタリングページおよびインターフェイス一覧でこのインターフェイスを識別するための名称です。

import com.alibaba.csp.sentinel.Entry;
import com.alibaba.csp.sentinel.SphU;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.alibaba.csp.sentinel.EntryType;

// 「HelloWorld」は、モニタリングページおよび MSE コンソールのインターフェイス一覧に表示されるリソース名です。
// EntryType.IN は、インバウンドトラフィック向けの流入リソースであることを示します。
try (Entry entry = SphU.entry("HelloWorld", EntryType.IN)) {
    // 保護対象のビジネスロジック
    System.out.println("Hello MSE Sentinel!");
} catch (BlockException e) {
    // 速度制限またはサーキットブレーカーがトリガーされました。
    // フォールバック応答を返すか、イベントをログに記録してください。
}

try-with-resources パターンにより、ブロック終了時に自動的にエントリが解放されます。これにより、finally ブロック内で entry.exit() を手動で呼び出す際に発生する可能性のあるリソースリークを防止できます。

パラメーター リファレンス

パラメーター説明
resourceNameモニタリングページおよびインターフェイス一覧に表示される識別子です。最大文字数は 1,024 文字です。推奨される文字:ハイフン (-)、アンダースコア (_)、ピリオド (.)、コロン (:)
EntryType.INインバウンドトラフィックです。このリソースを流入リソースとしてマークします。システムルールは流入リソースにのみ適用されます。MSE コンソールでは、アプリケーションの総トラフィックに対する EntryType.IN トラフィックのみをカウントします。
EntryType.OUTアウトバウンドトラフィック

結果の確認

  1. MSE コンソール にログインします。

  2. 左側のナビゲーションウィンドウで、マイクロサービスガバナンスアプリケーションガバナンス を選択します。

  3. アプリケーション一覧 ページで、ご利用のアプリケーションのリソースカードが表示され、データを報告していることを確認します。

    image.png

  4. カスタムインターフェイスに対してトラフィックを生成し、インターフェイスの詳細ページを開いて カスタムインターフェイス タブを選択し、インターフェイスが一覧に表示されていることを確認します。

次のステップ

カスタムインターフェイスにガバナンスルールを適用します。