31.3 Event Notification Blackout Periods

31.3.1 Scripting Blackouts

During maintenance periods for database servers, you can suspend Event Handlers. Agents continue to collect data, data is stored in the repository, and events are generated and displayed. Notifications, such as SNMP traps, emails and so on, are not generated.

To enable a blackout period for an individual instance, you can use the context menu on the MySQL Instances page. Open the instance menu and select Enable Event Handler Blackout. The instance name is grayed out to indicate the presence of an active blackout. No Event Handlers are triggered for the selected instance for the duration of the blackout period.

You can also enable a blackout period by entering the following URL into the address bar of your browser, substituting the appropriate host name, port and server name:

https://HostName:18443/rest?command=blackout&server_name=ServerName:3306&blackout_state=true

The URL is composed of the following components:

• Service Manager hostname: the URL of MySQL Enterprise Service Manager.

• command: the command to run. This can be one of the following:

  • blackout: applies or removes a blackout_state to the specified asset types.

  • blackout_status: requests the current blackout status of the specified asset.

• blackout_state: can be one of the following:

  • true: blackout the specified assets.

  • false: remove the blackout from the specified assets.

• Asset type: this can be one of the following:

  • server_name: the name and port number of the MySQL instance.

  • server_uuid: the UUID of the MySQL instance.

  • group_name: the name of the group. See Chapter 18, Managing Groups of Instances for more information.

  • asset_type: (only used for blackout of agents and blackout_status of agents) can be one of the following

    • agent.Agent: specifies the agent as the asset type. The command, or URL, must also contain the agent_id parameter.

    • mysql.MysqlServer: specifies the MySQL instance as the asset type. The command, or URL, must also contain the id parameter, with the value of the MySQL instance UUID.

Log on to the MySQL Enterprise Service Manager as a user with blackout privileges. For more information, see Section 23.5, “MySQL Enterprise Monitor”. Use the username and password you specified when you initially logged in to the Monitor UI.

You can also blackout a server group by entering the following URL into the address bar of your browser, substituting the appropriate host name, and server group name:

https://localhost:18443/rest?command=blackout&group_name=Finance&blackout_state=true

When the HTTP authentication dialog box opens, enter the administrator's credentials.

To confirm that a server is blacked out, check that its name is grayed out in the Monitor UI.

To reactivate the blacked-out server or server group, use the appropriate URL and query string, changing the blackout_state=true name/value pair to blackout_state=false. Again, this must be done by a user with administrative privileges.

Note

Restarting MySQL Enterprise Monitor does not reactivate a blacked out server.

To blackout an agent, use the following URL:

https://localhost:18443/rest?command=blackout&agent_id=agentID&blackout_state=true

To blackout an agent and all the MySQL instances currently monitored by that agent, use the following URL:

https://localhost:18443/rest?command=blackout&agent_id=agentID&blackout_state=true&recursive=true

To check the blackout status of an agent, use the following URL:

https://localhost:18443/rest?command=blackout_status&id=agentID&asset_type=agent.Agent

To check the blackout status of a MySQL instance, use the following URL:

https://localhost:18443/rest?command=blackout_status&id=mysqlUUID&asset_type=mysql.MysqlServer

You can also check the blackout status of a MySQL instance using its serer name. For example:

https://localhost:18443/rest?command=blackout_status&server_name=serverName

Note

It is not currently possible to check the blackout status of a group.