Class ServiceSummaryWidgetDefinition

The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.

Hierarchy

  • ServiceSummaryWidgetDefinition

Constructors

constructor

Properties

additionalProperties? displayFormat? env service showBreakdown? showDistribution? showErrors? showHits? showLatency? showResourceList? sizeFormat? spanName time? title? titleAlign? titleSize? type

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional displayFormat

displayFormat?: WidgetServiceSummaryDisplayFormat

Number of columns to display.

env

env: string

APM environment.

service

service: string

APM service.

Optional showBreakdown

showBreakdown?: boolean

Whether to show the latency breakdown or not.

Optional showDistribution

showDistribution?: boolean

Whether to show the latency distribution or not.

Optional showErrors

showErrors?: boolean

Whether to show the error metrics or not.

Optional showHits

showHits?: boolean

Whether to show the hits metrics or not.

Optional showLatency

showLatency?: boolean

Whether to show the latency metrics or not.

Optional showResourceList

showResourceList?: boolean

Whether to show the resource list or not.

Optional sizeFormat

sizeFormat?: WidgetSizeFormat

Size of the widget.

spanName

spanName: string

APM span name.

Optional time

time?: WidgetTime

Time setting for the widget.

Optional title

title?: string

Title of the widget.

Optional titleAlign

titleAlign?: WidgetTextAlign

How to align the text on the widget.

Optional titleSize

titleSize?: string

Size of the title.

type

type: ServiceSummaryWidgetDefinitionType

Type of the service summary widget.

Settings

Member Visibility

Theme

Generated using TypeDoc