Our next-gen architecture is built to help you make sense of your ever-growing data. Watch a 4-min demo video!

Back to All Docs

Add Monitoring Data to Custom Dashboard Widgets

Last Updated: Jan. 09, 2024

Coralogix supports adding monitoring data (formerly known as archive data) to your custom dashboard widgets. This enables you to see data from the Monitoring (medium priority) tier in your custom dashboards in addition to the regular Frequent Search (high priority) data.

What is Monitoring Data?

When using Coralogix for log analytics, the platform typically ingests log, metrics, and traces from various sources such as servers, applications, or cloud services.

Using our Streama© technology, this data is processed, analyzed, and visualized within the Coralogix platform. However, not all system capabilities are available for compliance data.

To optimize costs and performance, Coralogix provides an option to archive log data in Amazon S3. This means that based on specific criteria (TCO policies) or after a set period of time (retention period), certain logs and spans are available only in the lower-cost, scalable, and durable storage solution. While in the archive, the data is still accessible, but has limitations on real-time processing when compared to actively indexed, high-priority data.

How Can I Use Monitoring Data in Custom Dashboards?

Including monitoring data in your custom dashboard allows you to have a more comprehensive and detailed view of your data, combining both recent real-time information and additional context. Specific reasons for using monitoring data might vary depending on your organization’s requirements, compliance policies, and analytical needs.

Take a look at these use-cases to get a feel for the many ways that monitoring data in Custom Dashboards can serve you.

Use-Case 1: Multiple Subsystem Locations

A company has a case where some of their subsystems are under a policy that is saved in OpenSearch servers, and some of their subsystems are saved in the archive due to TCO policies. A DevOps engineer wants to create a widget that collates the subsystems from all the different locations.

The DevOps engineer uses an Archive Query to create a visualization that shows the subsystems from all sources, regardless of whether they are saved in the OpenSearch servers or in the archive.

Use-Case 2: Data Whose Retention Period Has Passed

A DevOps engineer wants to query a specific status from today and compare it to the same time period in the previous month (for example, to compare a 15 minute period on the 1st of the month at 10am to the same 15 minutes on the 1st of the previous month at 10am). The data from the previous month is no longer within the retention period, and therefore is only available in the archive.

The DevOps engineer creates a visualization that shows the period of time this month and compares it to the same period of time last month from the archive data.

Configuration

STEP 1. From your Coralogix toolbar, navigate to Dashboards > Custom Dashboards.

STEP 2. Select the dashboard you want to view with monitoring data or create a new dashboard.

STEP 3. If you haven’t done so already, set the definitions for each widget (Data TableLine ChartGaugePie ChartVertical Bar Chart, and Horizontal Bar Chart) in the right-hand sidebar.

Notes:

  • Source options supporting monitoring data include logs and spans.

STEP 4. In your custom dashboard, select a widget to which you want to add monitoring data and click the Add Monitoring Data icon on the right-hand side of the widget’s title bar. Alternately, select Monitoring in the Load data from section in the right-hand toolbar.

Once monitoring data is added to a widget, making changes to the query will no longer trigger automatic changes in the widget. Instead, you must manually refresh the data when you want to see more recent data.

STEP 5. To manually refresh data, click the Partial Data icon. Then click REFRESH DATA in the popup that appears.

If you make changes to the dashboard filters, variables, or timeframe, you must manually refresh the data in order to see the filters applied.

STEP 6. To return to viewing OpenSearch data only, click the Switch to Frequent Search Data icon. Alternately, click FREQUENT SEARCH in the right-hand toolbar. This reverts the dashboard to its original state where you are locally querying your Frequent Search data.

Additional Resources

DocumentationCustom Dashboards
Line Charts
Data Tables
Gauges
Pie Charts
Vertical Bar Charts

Horizontal Bar Charts

Support

Need help?

Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.

Feel free to reach out to us via our in-app chat or by sending us an email at [email protected].

On this page