Using Custom Dashboards

Custom Dashboards

With this feature, user-customized dashboards can be added to the standard dashboard view in Mackerel.

Creating a custom dashboard

Click "Dashboards" located in left sidebar menu to change to the dashboard management screen.

Then click the "New Custom Dashboard" button.

f:id:mackerelio:20240909104114:plain

Create from template

Click "Generate custom dashboard manually" button.

This will show dialog to crete dashboard from template.

f:id:mackerelio:20240909143333:plain

Enter a name for the new Custom Dashboard in the title field.

Select the appropriate template for the dashboard you want to create and click the "Next" button. For more information on the available templates, see Templates available for custom dashboard generation below.

Enter or select the required fields for each template and click the "Create" button. Based on the settings and the posted metrics, you will be redirected to the generated dashboard page.

If you want to edit the generated dashboard, see the next Create by yourself section.

Create by yourself

Click "Create custom dashboard manually" button.

This will bring up the "Create a new Custom Dashboard" screen.

Enter a name for the new Custom Dashboard in the title field.

You can add widgets by dragging and dropping icons inside the frame at the bottom of the screen. For more on widgets, see "Available widgets for custom dashboards" below.

After you’ve placed your widgets, if you want to edit the contents or delete a widget, use the icons displayed in the upper right corner of each widget. You can rearrange and resize widgets by dragging and dropping. You can also duplicate a widget by dragging and dropping while pressing the Alt (option) key.

To undo your last action, click the "Undo" button.

When you’ve finished editing, complete the process by hitting the create button.

Available widgets for custom dashboards

The following widgets can be arranged in Custom Dashboards. For more details, check out the respective pages for each feature.

Graph widgets
Display various graphs.
Value widgets
Display the latest values of various metrics with numbers.
Markdown widgets
Freely write content in Markdown format.
Alert Status widgets
Display alert statuses for all the hosts belonging to a role.

Templates available for custom dashboard generation

Three-tier architecture template

This is a dashboard of a three-tier system consisting of web servers, app servers, and database servers, which is typical of a web application.

Specify the roles of Web, App, and DB. If metrics supported by the template have been posted in each role, widgets are automatically created to display those metrics.

The plugins and cloud integrations currently supported by each role are as follows:

  • Web Role
    • AWS Integration - ELB (CLB)
    • AWS Integration - ALB
    • AWS Integration - NLB
    • AWS Integration - Lambda
    • AWS Integration - API Gateway
    • AWS Integration - CloudFront
    • AWS Integration - EC2
    • mackerel-plugin-accesslog
    • mackerel-plugin-apache2
    • mackerel-plugin-nginx
  • App Role
    • AWS Integration - Lambda
    • AWS Integration - EC2
    • mackerel-plugin-gostats
    • mackerel-plugin-jvm
    • mackerel-plugin-jmx-jolokia
  • DB Role
    • AWS Integration - RDS
    • AWS Integration - EC2
    • mackerel-plugin-postgres
    • mackerel-plugin-mysql

In addition, if system metrics have been posted by mackerel-agent or mackerel-container-agent in each role, widgets are created to display them.

Precautions

  • There is limit on the maximum number of custom dashboards that can exist per organization (100 for the Standard plan). Check the number of custom dashboards that you can create in your organization here.
  • If your paid plan is downgraded to the free plan, any custom dashboards exceeding the limit will become unavailable but will not be deleted.