{"id":442,"date":"2010-03-24T13:55:01","date_gmt":"2010-03-24T11:55:01","guid":{"rendered":"http:\/\/code.openark.org\/forge\/?page_id=442"},"modified":"2010-03-24T13:58:10","modified_gmt":"2010-03-24T11:58:10","slug":"emails","status":"publish","type":"page","link":"https:\/\/code.openark.org\/forge\/mycheckpoint\/documentation\/emails","title":{"rendered":"Emails"},"content":{"rendered":"<p><em>mycheckpoint<\/em> allows for emails notifications in various forms. More forms of email notifications are yet to be implemented. Currently, the following forms of emails are supported:<\/p>\n<ul>\n<li>Alert notifications<\/li>\n<li>Access error notifications<\/li>\n<li>Brief HTML reports email<\/li>\n<\/ul>\n<h4>Email configuration<\/h4>\n<p>It is necessary to provide with these configuration parameters:<\/p>\n<ul>\n<li>SMTP host (the mail server which will allow sending or relaying of emails)<\/li>\n<li><em>&#8220;From&#8221;<\/em> address<\/li>\n<li>&#8220;To&#8221; address(es). One or more (comma delimited, spaces allowed) email addresses.<\/li>\n<\/ul>\n<p>The parameters may either be provided on the command line, or in a <a href=\"http:\/\/code.openark.org\/forge\/mycheckpoint\/documentation\/usage#defaults_file\">defaults file<\/a>. Following is a defaults file setup:<\/p>\n<blockquote>\n<pre>[mycheckpoint]\r\nsmtp_host = mail.my-server-company.com\r\nsmtp_from = monitor@my-server-company.com\r\nsmtp_to = dba@my-server-company.com\r\n\r\n[client]\r\nuser=dbmonitor\r\npassword=123456\r\nsocket=\/tmp\/mysql.sock\r\nport=3306\r\nhost=localhost<\/pre>\n<\/blockquote>\n<p>See &#8220;<strong>Brief HTML reports email<\/strong>&#8220;, following, for specifying the above parameters as command line options.<\/p>\n<p>There is currently no sanity check for any of the above parameters. If they work &#8211; fine. If not &#8211; <em>mycheckpoint<\/em> lets the mail server deal with it.<\/p>\n<h4>Alert notifications<\/h4>\n<p>These are your <em>&#8220;Slave is not replicating&#8221;<\/em> or <em>&#8220;Disk quota exceeds 90%&#8221;<\/em> kind of emails.<\/p>\n<p>mycheckpoint sends an email for the first time an alert condition turns <strong>true<\/strong> (the alert is <em>raised<\/em>) and the first time it turns <strong>false<\/strong> (the alert is <em>resolved<\/em>). An alert condition may be defined as <strong>repetitive_alert<\/strong>, in which case an email is sent for every sample where the alert condition holds <strong>true<\/strong>.<\/p>\n<h4>Access error notifications<\/h4>\n<p>These notifications occur when <em>mycheckpoint<\/em> cannot access MySQL.<\/p>\n<p>Since <em>mycheckpoint<\/em> stores monitored data in MySQL, and is a MySQL monitoring solution, it is a critical error when it cannot access the MySQL server. The reasons are not tested. Perhaps the service is down, or there&#8217;s too many connections, or there&#8217;s a network problem, or what have you. <em>mycheckpoint<\/em> responds by sending an email alert.<\/p>\n<h4>Brief HTML reports email<\/h4>\n<p>It is possible to manually send a brief HTML report via mail. The report is sent as an HTML attachment. Pass the <strong>email_brief_report<\/strong> argument to <em>mycheckpoint<\/em>.<\/p>\n<p>Usage example:<\/p>\n<blockquote>\n<pre>mycheckpoint --defaults-file=\/etc\/mycheckpoint.cnf <strong>email_brief_report<\/strong><\/pre>\n<\/blockquote>\n<p>or<\/p>\n<blockquote>\n<pre>mycheckpoint --defaults-file=\/etc\/mycheckpoint.cnf <strong>--smtp-from<\/strong>=monitor@my-server-company.com <strong>--smtp-to<\/strong>=dba@my-server-company.com <strong>--smtp-host<\/strong>=mail.my-server-company.com <strong>email_brief_report<\/strong><\/pre>\n<\/blockquote>\n<h4>Turning off emails<\/h4>\n<p>Execute:<\/p>\n<blockquote>\n<pre>mycheckpoint <strong>--skip-emails<\/strong> ...<\/pre>\n<\/blockquote>\n<p>To turn off automatic mail notification (i.e. alerts and access error notifications).<\/p>\n","protected":false},"excerpt":{"rendered":"<p>mycheckpoint allows for emails notifications in various forms. More forms of email notifications are yet to be implemented. Currently, the following forms of emails are supported: Alert notifications Access error notifications Brief HTML reports email Email configuration It is necessary to provide with these configuration parameters: SMTP host (the mail server which will allow sending [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":147,"menu_order":25,"comment_status":"open","ping_status":"open","template":"","meta":{"footnotes":""},"class_list":["post-442","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/code.openark.org\/forge\/wp-json\/wp\/v2\/pages\/442","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/code.openark.org\/forge\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/code.openark.org\/forge\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/code.openark.org\/forge\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/code.openark.org\/forge\/wp-json\/wp\/v2\/comments?post=442"}],"version-history":[{"count":15,"href":"https:\/\/code.openark.org\/forge\/wp-json\/wp\/v2\/pages\/442\/revisions"}],"predecessor-version":[{"id":456,"href":"https:\/\/code.openark.org\/forge\/wp-json\/wp\/v2\/pages\/442\/revisions\/456"}],"up":[{"embeddable":true,"href":"https:\/\/code.openark.org\/forge\/wp-json\/wp\/v2\/pages\/147"}],"wp:attachment":[{"href":"https:\/\/code.openark.org\/forge\/wp-json\/wp\/v2\/media?parent=442"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}