Customize Service Observability dashboard templates

  • Release version: Xanadu
  • Updated March 17, 2025
  • 2 minutes to read
  • Customize Service Observability dashboard templates when you want to view metrics on the Overview or Observability tabs other than the default charts.

    About this task

    Service Observability dashboards are built using templates specific for each Application Performance Monitor (APM) vendor and entity tab. They're built using Platform Analytics, letting you customize templates to meet your business needs. For example, you might want to display metrics from your APM vendor that aren't available by default.

    The Service Observability dashboards use APM-specific templates. You can see what each template displays by default from its respective reference topic.

    Note:
    When you make a customization, you're changing the template and not the individual service's dashboard. This means that dashboards for any services that also use the same data source are also changed.

    When you customize a template, a copy of the original is saved so that you can reimplement it if needed. Default dashboards display a Certified tag.

    Before you begin

    Role required: sn_sow_svcobs.admin

    Procedure

    1. Navigate to Workspaces > Service Operations Workspace.
      You can access the Service Details page from these pages in the SOW:
      • Services list: Choose a service from the list.
      • Service dashboard: Choose a service in the dashboard and select Service Details.
      • List: Navigate to Application Services > Services and select a service.
      • Express list alert: Select a service from the Impacted services column.
      The Service Details page opens and the Overview tab is displayed.
      If charts are displaying error messages, see Chart error states.
    2. Open the template in editing mode.
      • If you're editing a certified template, select Duplicate.
      • If you're editing a custom template, select Edit.
      Note:
      Duplicating a certified template keeps you from overwriting it and also lets you reinstall it, if needed.
      The new dashboard is titled with the words - Copy appended. Use the pencil icon to change the dashboard name.
    3. To do basic editing, such as rearranging, resizing, or deleting charts, follow the instructions for Edit Platform Analytics dashboard elements.
    4. To add a query for a new chart, follow these steps:
      1. In Edit mode, select Add new element and choose the data visualization type.
      2. In the Add data source page, navigate to Service Observability and select your APM vendor.
        Be sure to select the same APM vendor used on the template you're editing.
      3. Enter a query in the Metric card.
        Use the Docs link to refer to the APM documentation for help with creating the query.
      4. To preview your query, select Run and then choose a service and entity.
      5. When satisfied with your query, select Add this source to add the chart to the template.
    5. To edit an existing query, follow these steps.
      1. In Edit mode, select the chart to edit.
      2. In the Data sources section of the Configuration panel, use the More actions menu to select Edit.
      3. In the Edit data source page, edit the query in the Metric card.
      4. To preview your query, select a service and an entity and select Run.
      5. When satisfied with your query, select Apply to edit the chart on the template.
    6. To return the template to the default (Certified) version, choose Edit and use the More actions menu to select Return to certified.