Widget Résumé de service

Le résumé de service affiche le graphique d’un service précis dans votre screenboard.

résumé de service

Configuration

Configuration du widget Résumé de service

Configuration

  1. Sélectionnez un environnement et un service.
  2. Sélectionnez une taille de widget.
  3. Sélectionnez les informations à afficher :
    • Hits
    • Erreurs
    • Latence
    • Répartition
    • Distribution
    • Ressources (remarque : pour afficher des ressources, la plus grande taille de widget est requise)
  4. Choisissez votre préférence d’affichage en sélectionnant un intervalle et le nombre de colonnes à représenter sur vos graphiques.
  5. Saisissez un titre pour votre graphique.

API

Ce widget peut être utilisé avec l’API Dashboards. Consultez la documentation à ce sujet pour en savoir plus.

Le schéma JSON utilisé pour le widget Résumé de service est le suivant :

Expand All

Champ

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

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

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,week_to_date,month_to_date,1y,alert

Option 2

object

Used for arbitrary live span times, such as 17 minutes or 6 hours.

type [required]

enum

Type "live" denotes a live span in the new format. Allowed enum values: live

unit [required]

enum

Unit of the time span. Allowed enum values: minute,hour,day,week,month,year

value [required]

int64

Value of the time span.

Option 3

object

Used for fixed span times, such as 'March 1 to March 7'.

from [required]

int64

Start time in seconds since epoch.

to [required]

int64

End time in seconds since epoch.

type [required]

enum

Type "fixed" denotes a fixed span. Allowed enum values: fixed

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

Pour aller plus loin

Documentation, liens et articles supplémentaires utiles:

Créer des dashboards avec JSONDOCUMENTATION more more