The Service Map for APM is here!

Timeboard

Change Timeboard name

  1. Click on the info icon on the top right corner of the Timeboard:
    Timeboard name
  2. Click on the pencil icon to edit the title and description
  3. Click the checkmark to save changes

Event Correlation at Design Time

Event Correlation refers to overlaying events on top of a dashboard graph. You can set up correlation at two different times: when you set up the dashboard, or ad-hoc when you view the dashboard.

guides-eventcorrelation-screenboard

Set up event correlation at design time by editing any graph on both Timeboards and Screenboards and adding events to the graph. To learn more about this, visit the Graphing Primer. You can find details about adding events using the UI or via the JSON interface further down the page.

Event Correlation at View Time

guides event correlation

Set up event correlation at view time by adding a query in the search box at the top left of any Timeboard dashboard window. This replaces any events added at design time, but applies the events to all graphs on that particular dashboard.

Correlation between Logs and Metrics

Jump from a metric to its logs

Fast and easy correlation is key when troubleshooting an issue. Use the following shortcut from any dashboard timeseries graph to open a contextual menu with the most related logs.

Related logs

Select View related logs to jump to the Log Explorer page zoomed on the selected timeframe with the current context of your graph.

How do we define the search query ?

To define the most related logs, the following parameters are used:

  • Timeframe: Focuses on the selected data point and uses the graph bucket size to display data before and after the selected point.
  • Integration prefix: If the metric is coming from an integration, Datadog filters on the source attribute with the same integration name.
  • Tags: All tags used in the graph (template variable, split by, filter by) are automatically added to the search query.

Read Only

An Administrator or Timeboard creator can make a Timeboard read-only by clicking the gear icon (upper right corner of a Timeboard) and clicking the Permissions link:

Read Only

Click “Yes” on the confirmation window to make the Timeboard read-only

Only account administrators and the Timeboard creator can activate read-only mode for a Timeboard. Any user in the organization, regardless of administrator privileges, can sign up to receive change notifications for a particular Timeboard.

If a user decides to track changes for a Timeboard, the following Timeboard changes are reported to the user through an event in the event stream:

  1. Text changes (title, description)
  2. Tile changes
  3. Timeboard cloning
  4. Timeboard deletion

In order to prevent the above listed changes, an administrator (account administrators or Timeboard creator) can activate read-only view disabling all non-administrator user edits to any tiles or text in the Timeboard, as well as Timeboard deletion.

Even in read-only mode, non-administrator users can still clone the Timeboard, rearrange the tiles, snapshot each tile, and view the tile in full screen. Any tile rearrangement by a non-administrator user does not persist if the Timeboard is set to read-only.

Tracking Changes

A user can find all events related to changes to the Timeboard they are following by searching tags:audit, <Timeboard_name> in the main event stream, as each notification event is tagged with those two tags.

Auditing Dashboards

In dashboards, notifications provide the ability to track changes for audit purposes. Any changes made creates an event in the event stream that explains the change and displays the user that made the actual change.

See changes with the following event search:

https://app.datadoghq.com/event/stream?per_page=30&query=tags:audit%20status:all

This feature can be enabled by following these steps:

  1. At the top right corner of a dashboard, click on the gear icon:

    enable notifications

  2. Select Notifications option and enable the notifications:

     notifications pop up

Backup my Timeboard

Using Datadog APIs, it’s possible to write a script to backup your Timeboard definitions as code. See the following projects as examples of how these backups can be accomplished:

Special thanks to Brightcove, Shopify, and Zendesk for sharing these projects!

Further Reading