Breaking News from AWS re:Invent
Coralogix receives AWS Rising Star award!

Back to All Docs

Custom Dashboards

Last Updated: Sep. 21, 2023

Coralogix now offers the ability to create unlimited, personalized custom dashboards. Use six new visualizations – Data Table, Line Chart, Gauge, Pie Chart, Vertical Bar Chart, and Horizontal Bar Chart – each of which supports all three data types – logs, metrics, and spans – to define and create a dashboard catered to your specific observability needs. Then query across your widgets using our new Filter and Variable capabilities.

Create a Custom Dashboard

STEP 1. In your navigation bar, click Dashboard > Custom Dashboards.

STEP 2. Create a new dashboard by clicking +NEW DASHBOARD.

STEP 3. Drag a widget into your new dashboard: Data Table, Line Chart, Gauge, Pie Chart, Vertical Bar Chart, or Horizontal Bar Chart. Set the definitions.

STEP 4. Hover over SAVE, then click SAVE AS and enter a name for your new dashboard.

STEP 5. Hover over your new dashboard in the dashboards panel, and three dots will appear to the right. Click on the three dots and select from a number of options in the drop down menu: STAR, SET AS DEFAULT, RENAME, DELETE, SAVE AS.

Note:

  • Your entire team will have access to all dashboards. Those with editing permissions can edit all dashboards.
  • Log filters are applied to log-based widgets.
  • Variables defined on a dashboard are accessible from all widgets.
  • When editing a widget, the widget you are currently editing is highlighted and all other widgets are faded.

For more information about the different widget types and explanations of their definitions, see the following documents:

Select Dashboard Timeframe

By default, custom dashboards show data from the last 15 minutes. This can be modified using the timeframe dropdown at the upper right-hand side of the dashboard.

You can choose between different timeframes either by selecting one of the quick timeframes, or by using the custom tab and selecting two dates between which you want to show data.

90-Day Timeframe

Coralogix supports selecting a timeframe of up to 90 days for your custom dashboards. This enables you to view metric widgets with long retention periods easily within your custom dashboards.

Notes:

  • Timeframe limitations may apply depending on the data source and the data origin.
  • When selecting more than a 7-day time period, the results will appear based on the specific settings of each data source, similar to the Explore screen time limitation.
  • For example, if your logs in the Explore screen are limited by up to 8 days timeframe, this will be the case also for the custom dashboard, and logs data will appear for only the last eight days, as opposed to metrics, which can show up to 90 days of data in the same dashboard.
  • The query range and retention period are each marked with an annotation line. Hovering over the line shows an explanation.
  • If the retention period is, for example, 21 days, the user will be able to see that limit on the time series widget, and selecting an older 7-day time query within those 21 days will still return results.

View & Modify a Custom Dashboard

Widgets are always in edit mode and may be edited at any time.

STEP 1. In your dashboard, navigate to Dashboard tab > Custom Dashboards.

STEP 2. In the left-hand side bar, view all available dashboards.

STEP 3. Click on the dashboard you wish to view and modify as desired.

  • When you click on SAVE dropdown menu, you will have the option to select either SAVE or SAVE AS. SAVE makes changes to your current dashboard; SAVE AS clones your dashboard and saves the changes, while maintaining the original as is.
  • If you choose to SAVE AS, a popup will appear requiring that you name your cloned dashboard.

STEP 4. Once you have made changes to a widget, click SAVE. This saves your entire dashboard. Click RESET to revert your changes and view the previously saved dashboard.

Notes:

  • Three dots can be found in the the upper right-hand corner of every widget. Click on this and select from the menu options: DELETE or CLONE. For line charts, you also have the option to HIDE LEGEND.
  • To expand a specific widget within a dashboard, click on the Expand icon in the top right corner of the widget. This temporarily expands the widget to fill the entire dashboard.
  • Hover over a specific dashboard name, and three dots will appear to the right. Click on the three dots and select from a number of options in the drop down menu: STAR, SET AS DEFAULT, RENAME, DELETE.
  • STAR and DEFAULT settings are unique for each user. All other settings apply across all team members.
  • Right clicking on a value in the legend of a Line chart opens a context menu with the following options:
    • Exclude. Exclude this value from the current filter.
    • Include. Include only this value in the filter.
    • Explore. Opens the query in the Explore screen for further analysis.
    • Create Alert. Lets you create an alert directly from the custom dashboard (see Creating Alerts from Custom Dashboard Widgets ).
    • Copy Name. Lets you copy the exact name of the time series for use in queries or searches.

Create Variables

STEP 1. Click on the variable icon { } in the upper right-hand corner of your dashboard.

STEP 2. Define your Variable by defining Type, Field, Variable Name, and Display Name.

STEP 4. Click SAVE.

STEP 5. View the variables per Field in the upper right-hand corner of your screen.

STEP 6. Use the {{ variable_name }} in the widgets query language.

Notes:

  • Input the Value in the Lucene or PromQL query. When the Value is changed, all widgets are affected.
  • To use the current dashboard timeframe in your query, use the ${__range} variable in your query. This variable is always available and does not need to be defined before you use it. You can also use the ${__range_s}  and ${__range_ms} variants of this variable, to get the range in seconds or milliseconds. For example, you could use the query sum(last_over_time(request_count[${__range}])) by (service) to show the last reported request_count metric value over the entire time frame grouped by service.

Create Filters

STEP 1. Click on Filters View in your left-hand sidebar.

STEP 2. Click +ADD FILTER.

Note: Application and subsystem filters are created by default; you have the option of creating new filters.

STEP 3. Define the parameters of your Filter: Source, Field, and Operator.

STEP 4. Click SAVE.

Notes:

  • When a filter is enabled, only log-based widgets are filtered.
  • Disable a filter by clicking on the toggle next to the filter name.

Additional Resources

DocumentationLine 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