Getting Started with Dashboards
The key to getting started with dashboards is knowing what kind of questions you ask yourself regularly. What are common issues your customers face? When a problem occurs, what questions help you find a solution?
Creating a good dashboard is about bringing the answers to these questions to the surface. Also, it is important not to cram all of those thoughts into the same dashboard. Creating separate dashboards to pinpoint different issues can help you quickly find your answers.
This guide gets you started on a path to creating dashboards. These basic dashboards enable team discussion and speed up issue resolution.
If you haven’t already, create a Datadog account. Install the Agent on a host, and an integration for something running on that host.
Determine the purpose of the dashboard you’re creating. A dashboard can help you and your teammates focus on the right work. A team dashboard reminds you what’s high priority, what needs attention, and what you’re succeeding at. Make a team dashboard (or multiple) with the information that people most frequently need they have to dig for. SLO and SLI details make for an excellent team dashboard.
A dashboard connected to real-time data is a powerful tool for guiding conversations with managers and executives. A good executive dashboard can show that you are working on the most important things, how much a service is costing you, or whether you’re progressing toward goals, meeting your SLOs, and scaling effectively. Executive dashboards are most effective when they answer these questions at the highest level and are interconnected to drill down into the answer.
Dashboards can also help you track down persistent problems and fix them. Troubleshooting dashboards often start as a scratch pad of things you know, and gradually build as you discover more. For example, start with a graph or widget from another dashboard or view that shows a problem. You can then drill down from there to find your solution.
Explore out-of-the-box dashboards
Datadog provides many out-of-the-box dashboards for features and integrations. For the infrastructure you monitor, check out the out-of-the-box dashboards that are provided with Datadog:
- Go to Dashboards > Dashboards list and search for the name of an integration you have added, for example
Redis, or a feature you use, such as
- Browse the search results for dashboards marked Preset and see if at least some of the graphs show the answers you’re looking for.
- Explore the links in the out-of-the-box dashboard’s title drop-down to find more information about how people are using them.
Start by reusing other dashboards
A common way to start a dashboard is by encountering a similar dashboard already in use, and adjusting it to suit your needs. If you find a dashboard that answers many of the questions you want your dashboard to answer:
- Clone it by opening the dashboard and selecting Clone dashboard from the Settings menu (the gear icon on the right-hand side). This creates an unlinked copy of the dashboard; changes you make in the new copy don’t affect the source widget.
- Edit the clone by opening it and clicking Edit widgets.
- Delete widgets you don’t need by selecting Delete from the widget’s Settings menu.
- Move things around to suit your needs. Groups and individual widgets can be dragged and dropped into new locations in the dashboard.
- Copy in widgets you like from other dashboards by hovering over the widget and typing
Command + C (
Ctrl + C on Windows). Paste it into your dashboard by opening the dashboard and typing
Command + V (
Ctrl + V on Windows).
- Use the Export to Dashboard option provided by many Datadog views for data they show. For example, the Logs Explorer and Log Analytics views have share options to export logs lists and metrics to dashboards.
Learn more about metrics
Through integrations, Datadog collects metrics from your infrastructure and applications. The collected metrics are documented in the integration’s README files. If you encounter a metric in the Metrics Explorer or as you’re creating a dashboard, and you want to know what the metric is, look it up in the Integrations docs.
For example, suppose you are looking at a time graph of the metric
aws.s3.first_byte_latency. Go to the Data collected section of the AWS S3 integration README to see its description:
The average per-request time from the complete request being received by a bucket to when the response starts to be returned. Shown as millisecond.
After you’ve selected a few metrics to add to your dashboard, experiment with various widget types, queries, functions, and aggregation approaches, to display the data in ways that best answer the questions you have.
By specifying Template variables, you can make one dashboard answer questions for a selection of scenarios. For example, you can create a time graph that shows latency metrics for whichever data center geography the user selects from the dashboard’s variables drop-down, or for all of them together. For more information, see Template Variables.
You can make graphs easier to read by adjusting Y-axis ranges, colors, or legends, or by adding markers and event overlays. See the Dashboards documentation for all the ways you can customize and refine timeseries and other widgets.
For more details and examples of these techniques, sign up for the online learning course Building Better Dashboards.
Timeseries graphs of metrics are useful, but dashboards can contain many types of widgets to communicate important information. Try:
- Alert values and Check statuses: Show big red, yellow, and green numbers to bring attention to successes or problems.
- Heat maps: Show complex metric-infrastructure relationships across multiple tags with intuitive color-intensity graphs.
- iFrames, formatted text, and images: Show any number of website-like details to help explain the dashboard contents and provide additional resources.
- Tables: Show lists of metrics grouped by tag keys.
- Top lists: For example, show which hosts have the least free space, which services are throwing the most errors, or which URLs are returning the most 404s.
- Host map: Show a diagram of, for example, the hosts in your infrastructure with colors that show status of their integrations or services.
- Service Level Objectives (SLO): Show team performance against goals with an SLO summary widget, and group it additional widgets that show details for SLI metrics.
- Distributions: Show, for example, a histogram of number of different types of events in a containerized environment, the number of critical errors in each service, website flow (number of users getting to page 2, page 3, page 4), or latency percentile buckets.
See Widgets for more information and examples of setting up these graphs.
Organize, link, and drill down
Move graphs around so they create a flow for the work you do or conversations you have around the dashboard. Drag and drop widgets to place them. On screenboards, use Free Text widgets to organize sections under headings. On timeboards, add a Group widget that can contain multiple widgets, and can collapse out of the way when you’re viewing the dashboard.
There are two ways to create links from a dashboard to any target URL:
- Add a Notes and Links widget, which can contain Markdown formatted text, including links. The widget editor includes Markdown formatting tips.
- Create a Custom link from a widget’s Settings (gear) menu. Custom links can interpolate variables and template variables, so that the link changes according to what the user has selected when they click, taking them to exactly the right place for drilling down into data or taking corrective action.
Share your dashboards outside of the Datadog site
Click Generate Public URL in a dashboard’s Settings (gear) menu to create a URL you can share with big screens or people who don’t necessarily have a Datadog account.
Integrate with your team communications by using the Slack integration to import dashboards and other Datadog features, such as monitors and incidents, into a Slack channel.
Create multiple dashboards quickly
Every dashboard has a JSON representation that you can copy or export from the Settings menu. Each widget on the dashboard also has a JSON definition, which you can see and edit by opening the widget editor (pencil icon) and clicking the JSON tab under Graph your data.
Because all widgets and dashboards are represented as JSON, you can programmatically generate them by using the Dashboards API, which is useful if you want to generate a Dashboard every time your team starts a new project or encounters an incident, or formalizes an SLO, for example.
Additional helpful documentation, links, and articles: