A service is a set of processes that do the same job, for example, a web framework or database. Datadog provides out-of-the-box graphs to display service information, as seen on the Service page. Use the service summary widget to display the graphs of a chosen service in your dashboard.
Setup
Configuration
- Select an environment and a service.
- Select a widget size.
- Select the information to display:
- Hits
- Errors
- Latency
- Breakdown
- Distribution
- Resource (Note: You need to select the large widget size to see this option.)
- Choose your display preference by selecting the number of columns to display your graphs across.
- Enter a title for your graph.
API
This widget can be used with the Dashboards API. See the following table for the widget JSON schema definition:
Expand All
Number of columns to display.
Allowed enum values: one_column,two_column,three_column
Whether to show the latency breakdown or not.
Whether to show the latency distribution or not.
Whether to show the error metrics or not.
Whether to show the hits metrics or not.
Whether to show the latency metrics or not.
Whether to show the resource list or not.
Size of the widget.
Allowed enum values: small,medium,large
Time setting for the widget.
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
Used for arbitrary live span times, such as 17 minutes or 6 hours.
Type "live" denotes a live span in the new format.
Allowed enum values: live
Unit of the time span.
Allowed enum values: minute,hour,day,week,month,year
Used for fixed span times, such as 'March 1 to March 7'.
Start time in seconds since epoch.
End time in seconds since epoch.
Type "fixed" denotes a fixed span.
Allowed enum values: fixed
How to align the text on the widget.
Allowed enum values: center,left,right
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"
}
Further Reading
Additional helpful documentation, links, and articles:
