ドキュメント

gRPC ツール

約1分で読めます · このページを GitHub で編集

← ShimoDocs Suite デプロイメント文書

Tip

gRPC ツールは内部に接続するために使用されます gRPC サービス、サービスとメソッドの表示、およびユニャリメソッドのデバッグ呼び出しの開始。

このページでは、ターゲットを選択するための3つの方法をサポートしています:アドレスを手動で入力する、選択する Kubernetes サービス、または Pod によって選択します。

1. アクセス gRPC

  1. にログインし、 MDP 操作プラットフォーム.
  2. 選択 システムサービス 上部にあります。
  3. 展開 ミドルウェアツール 左のナビゲーションバーにあります。
  4. 選択 gRPC.

ページは最初に接続するサービスを選択する「ターゲット」エリアを表示します。 gRPC

2. ターゲット選択方法

ページでは3つのターゲットモードが提供されます。

モード 説明
手動 アドレスを手動で入力します、例えば gRPC svc-user:50051.
サービス ターゲットをクラスター、ネームスペース、サービス、ポートで選択します。
Pod ターゲットをクラスター、ネームスペース、Pod、ポートで選択します。

3. 手動接続

  1. 選択 手動.
  2. 入力 gRPC アドレスボックスにサービスアドレスを入力します。 アドレス 入力ボックス
  3. クリック 接続.
  4. 接続が成功すると、ページはサービス/メソッドのデバッグ作業エリアに入ります。

4. サービスで接続

  1. 選択 サービス.
  2. ターゲットクラスターとネームスペースを選択します。
  3. サービス/ポート ドロップダウンでターゲットサービスとポートを選択します。
  4. サービスリストが更新されない場合は、クリックします。 更新.
  5. クリック 接続.

5. Pod で接続

  1. 選択 Pod.
  2. ターゲットクラスターとネームスペースを選択します。
  3. Pod/ポート ドロップダウンで、対象のPodとポートを選択します。
  4. Podリストが更新されない場合は、クリックしてください 更新.
  5. クリック 接続.

6. サービスとメソッドを選択

接続に成功すると、ページはサービスリスト、メソッドリスト、リクエストエリア、レスポンスエリアに分かれます。

  1. 左側のサービスリストから対象のサービスを選択します。
  2. サービス検索ボックスを使用してサービスをフィルタリングできます。
  3. メソッドリストから対象のメソッドを選択します。
  4. 切り替え可能なメソッドフィルターオプション: Unary, Streaming, All.
  5. メソッド検索ボックスを使用してメソッドをフィルタリングできます。

現在のページはUnaryメソッドの呼び出しのみサポートしています。ストリーミングメソッドは使用不可として表示されます。

7. リクエストパラメータを入力

リクエストエリアは以下の2つの入力方法をサポートしています:

メソッド 説明
フォームモード ページはメソッドの入力フィールドに基づいてフォームを生成します。
JSON モード ~の場合 JSON モード が有効になると、完全なリクエストボディを直接編集できます。 JSON

フォームモードを使用する手順:

  1. 対象のメソッドを選択します。
  2. リクエストパラメータをフィールドごとに入力します。
  3. ドロップダウンを使用して列挙フィールドを選択します。
  4. 選択 true または false ブールフィールドの場合。
  5. 繰り返しフィールドには、ページに記載されているとおりにコンマを使用します。

使用手順 JSON モード:

  1. スイッチをオンにします。 JSON モード スイッチ。
  2. テキストボックスに完全な内容を記入します。 JSON テキストボックスに
  3. 形式が有効であることを確認します。 JSON 形式が有効であることを確認します。

8. メタデータを記入します

  1. 展開 メタデータ リクエスト領域に記入します。
  2. キーと値を記入します。
  3. 複数のメタデータを追加するには、クリックします 追加.
  4. 行を削除するには、削除アイコンをクリックします。

メタデータは、認証情報、リクエストID、またはビジネスコンテキストを伝えるためによく使用されます。

9. 呼び出しを開始して応答を表示します

  1. ターゲット、サービス、メソッド、リクエストボディ、およびメタデータを確認します。
  2. クリック 呼び出す ページ右上で。
  3. ステータス、経過時間、応答メタデータ、および応答を応答領域で確認します。 JSON 応答領域で。
  4. 呼び出しが失敗した場合、応答領域にエラーステータスとエラー内容が表示されます。

10. ターゲットを切り替えるまたは再接続する

  1. クリック 接続 を使用します。
  2. クリック ターゲットを変更 ターゲット選択ページに戻ります。
  3. ターゲットを切り替えた後、再接続してサービス/メソッドを再選択する必要があります。

11. 一般的なトラブルシューティングのシナリオ

シナリオ 操作の提案
サービスが接続可能か確認してください 対象を選択してクリックしてください 接続 サービスリストが読み込めるか確認します。
インターフェースメソッドを見つける サービス検索とメソッド検索フィルタを使用する。
クエリインターフェースをデバッグする 単一(Unary)メソッドを選択し、リクエストパラメータを入力してクリックする 呼び出す.
コンテキストを通す必要がある Metadataを展開し、対応するキーと値を入力する。
レスポンスが空または失敗 レスポンスの状態、エラー内容、Metadataを確認する。