サービスサマリーウィジェット

このドキュメントは最新ではありません。最新版はこちらをクリックして英語版をご覧ください。

サービスサマリーは、選択されたサービスのグラフをスクリーンボードに表示します。

サービスサマリー

セットアップ

サービスサマリーのセットアップ

コンフィギュレーション

  1. 環境とサービスを選択します。
  2. ウィジェットのサイズを選択します。
  3. 表示する情報を選択します。
    • Hits
    • Errors
    • レイテンシー
    • Breakdown
    • Distribution
    • リソース (注: このオプションを表示するには、大きなウィジェットサイズを選択する必要があります)
  4. タイムフレーム、およびグラフの表示に使用する列数を選択して、表示設定を行います。
  5. グラフのタイトルを入力します。

API

このウィジェットは、ダッシュボード API とともに使用できます。詳しくは、ダッシュボード API ドキュメントをご参照ください。

サービスサマリーウィジェットのウィジェット JSON スキーマ定義は次のとおりです。

Expand All

フィールド

種類

説明

display_format

enum

Number of columns to display. Allowed enum values: one_column,two_column,three_column

env [required]

string

APM environment.

service [required]

string

APM service.

show_breakdown

boolean

Whether to show the latency breakdown or not.

show_distribution

boolean

Whether to show the latency distribution or not.

show_errors

boolean

Whether to show the error metrics or not.

show_hits

boolean

Whether to show the hits metrics or not.

show_latency

boolean

Whether to show the latency metrics or not.

show_resource_list

boolean

Whether to show the resource list or not.

size_format

enum

Size of the widget. Allowed enum values: small,medium,large

span_name [required]

string

APM span name.

time

object

Time setting for the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert

title

string

Title of the widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the service summary widget. Allowed enum values: trace_service

default: trace_service

{
  "display_format": "string",
  "env": "",
  "service": "",
  "show_breakdown": false,
  "show_distribution": false,
  "show_errors": false,
  "show_hits": false,
  "show_latency": false,
  "show_resource_list": false,
  "size_format": "string",
  "span_name": "",
  "time": {
    "live_span": "5m"
  },
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "trace_service"
}

その他の参考資料

お役に立つドキュメント、リンクや記事:

JSON を使用したダッシュボードの構築ドキュメント more more