Getting Started

Mackerel is a service for visualizing and monitoring the resource status of multiple servers and service performance.

If this is your first time using Mackerel, you have to create an organization first. Or, you can join an existing organization (Glossary of terminology) by getting an invitation from users who have already joined that organization.

Join an Organization

Create a new organization

  1. Access the sign-up page.
  2. Enter your email address. 3.If you agree to the Terms of Use and you are an adult or a minor with parental consent, please check two boxes.
  3. Click on Sign Up.
  4. Follow the on-screen instructions to create an organization.
  5. A confirmation email will be sent to the email address you entered in step 2. Please follow the contents of the email to set your password.

Join an existing organization

  1. Ask an administrator or owner who already belongs to the organization to invite you. (Inviting users to join your Mackerel organization)
  2. Access the URL in the invitation email to view the sign-up page.
  3. If you agree to the Terms of Use and you are an adult or a minor with parental consent, please check two boxes.
  4. Click on Sign Up.
  5. The Organization Invitation page will appear. Click Join to join the organization.
  6. A confirmation email will be sent to your email address, Please follow the instructions in the email to set your password.

What to Do Next

Register hosts

By installing mackerel-agent on the server to be monitored, it will be registered as a host (What is a "host"?) with Mackerel.
Cloud integration is available to register cloud managed services as monitored hosts. To monitor container services, such as ECS tasks and Kubernetes pods, you can use mackerel-container-agent. Metrics collected by agents (Metrics specifications) and cloud integration are posted to registered hosts.

Manage hosts

Registered hosts can be managed together in units of "services" and "roles" according to their roles (Services and Roles). A graph of hosts grouped by common roles (role graph) can be viewed for each service from the Service List.

Monitor Hosts

Monitoring rules can be set to generate alerts and notifications based on monitoring results. For example, "Host metric monitor" generates an alert when the value of a metric posted to a host exceeds or falls below a threshold set in a monitoring rule.

By setting up check monitoring in mackerel-agent, you can monitor the process status and logs in the server. To use check monitoring, you need to install the check plugin beforehand.

User-created plug-ins that follow the check monitoring specifications can also be used for monitoring.

Post a variety of metrics

In addition to metrics posted by agents and cloud integration, metrics such as middleware can be posted by using metric plug-ins. Metric plug-ins must be installed beforehand in order to use them.

User-created plug-ins that follow the custom metric specifications can also be used to post metrics.

Metrics that are not tied to a specific host can be posted as service metrics by using the API or other means. Service metrics can be viewed for each service from the Service List.

Create your own dashboard

Dashboards can be created by freely arranging necessary graphs, etc. according to the purpose. This can be used to view information from multiple hosts in a cross-sectional manner.

Manage users

You can invite users with whom you wish to collaboratively manage the organization. You can also set operating privileges for each user.

When you are in trouble

Use the help and FAQ

The Help page provides information on how to use Mackerel. Frequently Asked Questions are available on the FAQ page. If you have any questions, you may be able to resolve them by reviewing these pages.

Contact our support team

If you are unable to resolve your issue after reviewing the Help or FAQ, please contact us using the Contact Us form. Mackerel's technical support team will assist you in resolving the issue. Please check Support related questions for our support policy. In addition, please be aware of the following links to help us resolve your concerns as soon as possible.