How to Identify Unused Dashboards

This article applies to:

  • Usage Monitoring
  • Product edition: All
  • Feature Category: Data Visualization

Overview

Dashboards are one of the key features of Tanzu Observability. Over time, as more and more dashboards are created, inevitably, there are dashboards that are no longer in use. To keep your environment clean and to ensure that useful dashboards can be located more readily, it's good practice to clean up unused dashboards from time to time. In order to do that, we must first identify which dashboards are no longer being used or viewed.

 

Strategies

Using the Dashboard Browser

One of the columns in the Dashboard Browser indicates Views over the last day, last week, or last 4 weeks (or month). The Sort dropdown includes options to sort by the number of views over these periods of time. The Sort dropdown also allows sorting from low to high. This puts the fewest viewed dashboards at the top of the list. You will likely find that there are dashboards that have not been viewed at all over the last month. These are good candidates for clean-up.

 

mceclip1.png

 

Using the API

This approach is similar to the previous approach but allows additional flexibility. Specifically, this approach allows checking for dashboards that have not been viewed over time frames longer than a month (or 4 weeks). 

  1. Get ID s of all dashboards
    Using the API endpoint documented at https://YOUR-CLUSTER.wavefront.com/api-docs/ui/#!/Dashboard/getAllDashboard, we can get all dashboards available. The "url" for each entry in the response is the dashboard ID. Note that you may need to iterate through all the available dashboards by using the "offset" parameter in the API request.

  2. Find all dashboards that have been viewed over the time window of interest
    One of the internal metrics provided by Wavefront tracks views of each dashboard: ~wavefront.dashboard.<dashboard id>.views. Using a query like the following will allow us to obtain all the IDs for dashboards that have been viewed over the last 12 weeks:
    aliasMetric(mmax(12w, ts(~wavefront.dashboard.*.views)), 2)
    You could of course adjust the time window based on your needs. The purpose of the aliasMetric here is to simplify the metric name so that it only indicates the dashboard ID.

  3. Find all unviewed dashboards
    Now that we have the IDs for all dashboards and the IDs for all dashboards that have been viewed, taking the difference would give us all of the IDs of unviewed dashboards.

 

See Also

How to Identify Unused Data

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk