Popular help topics
API Documents (v0)regarding the specification of the API for Mackerel
- mackerel-agent specificationsan explanation of mackerel-agent’s command options and settings
- Posting user-defined custom metricsposting middleware metrics of MySQL and such from mackerel-agent
- Using the official plugin pack to visualize middleware metricshow to use the official plugin pack, which supports various kinds of middleware
- Using the official check plugin pack for check monitoringOfficial plugins are available to perform a variety of check monitoring
- Monitoring LogsAlerts are issued if certain patterns are found in the log file
- Setting up monitoring and alertshow to set up the monitoring of registered hosts and receive alert notifications
- Configuring Downtimehow to set up periodic monitoring suspension
- Using Custom Dashboardshow to use user-customized dashboards
First Steps
How to
- Installing the agentan explanation of how to install mackerel-agent in your hosts
- Monitoring Containersusing mackerel-container-agent to monitor containers
- Using Query GraphDisplay labeled metrics in a query graph
- Installing mackerel-agent in Amazon Linuxan explanation of how to install mackerel-agent in Amazon Linux
- Installing mackerel-agent in Red Hat Enterprise Linux derivativessetup for Red Hat Enterprise Linux derivatives
- Installing mackerel-agent in Ubuntu / Debiansetup for Debian OS systems
- Installing mackerel-agent directly with binary filean explanation of how to install mackerel-agent directly using the binary file
- Installing mackerel-agent on Windowsan explanation of how to install mackerel-agent on Windows
- Using Chef to set-up mackerel-agentmake setting up mackerel-agent even easier with Chef
- Using graphsan explanation of how to use Mackerel's graphs.
- Creating services and rolesby creating services and roles, you can collectively manage multiple hosts performing similar functions
- Assigning roles to hostshow to assign the roles that you have created to hosts via the web
- Inviting users to join your Mackerel organizationhow to invite other users to join your organization and manage hosts together as a team
- Using the official plugin pack to visualize middleware metricshow to use the official plugin pack, which supports various kinds of middleware
- Using the official check plugin pack for check monitoringOfficial plugins are available to perform a variety of check monitoring
- Monitoring LogsAlerts are issued if certain patterns are found in the log file
- Using Custom Dashboardshow to use user-customized dashboards
- Using Mackerel in Auto Scaling environmentshow to best use Mackerel in Auto Scaling environments
- Using metadatahow to register and utilize metadata
- Removing registered hosts from Mackerel’s managed targetshow to remove hosts that no longer need to be monitored
- Using GraphBoardshow to use GraphBoards in the service screen
- Using Anomaly Detection for roleshow to monitor hosts in a role using machine learning
Alerts
- Setting up monitoring and alertshow to set up the monitoring of registered hosts and receiving alert notifications
- Consolidate alerts with Alert groupshow to set up alert group settings
- Adding monitors for script checksexecute check monitoring similarly to Nagios
- External URL Monitoringhow to set up http and https external URL monitors
- Expression Monitoringhow to set up expression monitors
- Monitoring with queriesMonitor labeled metrics with PromQL queries
- Slack notificationssending alert notifications to Slack
- PagerDuty notificationssending alert notifications to PagerDuty
- Chatwork notificationssending alert notifications to Chatwork
- Typetalk notificationssending alert notifications to Typetalk
- Opsgenie notificationssending alert notifications to Opsgenie
- Webhook notificationssending alert notifications to Webhook
- LINE notificationssending alert notifications to LINE
- Twilio notificationssending alert notifications to Twilio
- Microsoft Teams notificationssending alert notifications to Microsoft Teams
- Amazon EventBridge notificationssending alert notifications to Amazon EventBridge
Specifications
- What is a "host"?regarding hosts in Mackerel
- Services and Rolesan explanation of "services" and "roles" in Mackerel
- API specs (v0)regarding API specifications for Mackerel
- Metadata API for Mackerelthe specifications of the Metadata API about Mackerel information
- Metrics specificationsregarding the specs of the metric names drawn on graphs
- mackerel-agent specificationsan explanation of mackerel-agent’s command options and settings
- User permissionsabout user permissions
Advanced
- Posting user-defined custom metricsposting middleware metrics for MySQL and more from mackerel-agent
- Using go-mackerel-plugin to create a custom metric pluginan introduction on how to create plugins using the official library
- Posting Service Metrics with fluentduse fluentd to post the number of requests, error rate, and more for each status code
- Integrating Capistrano 3.xeliminate the need for host list management by obtaining the host list from Mackerel
- Using the mkr CLI toolautomate tasks using command-line tools
- Managing monitoring rules in GitHuban introduction to managing monitoring rules with GitHub
- Monitoring Dockermonitor Docker hosts using the mackerel-agent Docker image
- Using fluent-plugin-webhook-mackereluse fluentd to handle alerts from Mackerel with more flexibility
- Displaying customized graphsdisplay flexible, function-based customized graphs
- AWS Integrationmanage AWS cloud products as Mackerel hosts and monitor metrics.
- Azure Integrationmanage Azure cloud products as Mackerel hosts and monitor metrics.
- Google Cloud Integrationmanage Google Cloud products as Mackerel hosts and monitor metrics.
- Using Experimental Featurestry out features before their official release
- Using 2-Step Authenticationstrengthen security by configuring 2-Step Authentication.
- Mandatory 2-Step Authenticationstrengthen security by requiring 2-Step Authentication
- Aggregating Amazon CloudWatch Logs and posting the metrics to Mackerelutilize logs to monitor application metrics
- Authentication with SAMLExplains how to sign in to Mackerel using your Identity provider credentials.
- Setting up SAMLExplains how to set up for linking Mackerel with an Identity Provider.
Need even more help?
If the content covered in this help page doesn't solve your problem, please contact our support team.
About
This is the page containing Mackerel's https://mackerel.io instructional documents.
