Service Summary Widget

The service summary displays the graphs of a chosen service in your screenboard.

service summary

Setup

service summary setup

Configuration

  1. Select an environment and a service.
  2. Select a widget size.
  3. Select the information to display:
    • Hits
    • Errors
    • Latency
    • Breakdown
    • Distribution
    • Resource (Note: You need to select the large widget size to see this option.)
  4. Choose your display preference by selecting a timeframe and the number of column to display your graphs across.
  5. Enter a title for your graph.

API

This widget can be used with the Dashboards API. See the Dashboards API documentation for additional reference.

The dedicated widget JSON schema definition for the service summary widget is:

Expand All

Field

Type

Description

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

{
  "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"
}

Further Reading

Additional helpful documentation, links, and articles: