{"id":556,"date":"2010-09-06T09:49:05","date_gmt":"2010-09-06T07:49:05","guid":{"rendered":"http:\/\/code.openark.org\/forge"},"modified":"2011-04-07T13:10:04","modified_gmt":"2011-04-07T11:10:04","slug":"quick-startup-guide","status":"publish","type":"page","link":"https:\/\/code.openark.org\/forge\/mycheckpoint\/documentation\/quick-startup-guide","title":{"rendered":"Quick startup guide"},"content":{"rendered":"

mycheckpoint<\/em> is becoming larger and loaded with features. This page will help the new comer answering these questions:<\/p>\n

How do I start using mycheckpoint and what are the most interesting functionalities?<\/h4>\n

This short page will describe how to set up mycheckpoint and quickly view HTML reports with interactive charting.<\/p>\n

The steps you will follow are:<\/p>\n

    \n
  1. Install mycheckpoint<\/em>.<\/li>\n
  2. Create a monitoring user and schema.<\/li>\n
  3. Setup monitoring for your database via crontab<\/em>.<\/li>\n
  4. View charts using mycheckpoint HTTP server<\/em>.<\/li>\n<\/ol>\n

    Install mycheckpoint<\/h4>\n

    You’ll need to install MySQL-Python: the python driver for MySQL. You can easily do so with apt-get<\/em> or yum<\/em> or up2date<\/em>.<\/p>\n

    After that, proceed to install mycheckpoint<\/em>.<\/p>\n

    Follow these short<\/a> or detailed<\/a> instructions.<\/p>\n

    Create a monitoring user and schema<\/h4>\n

    You’ll need a schema (via CREATE DATABASE<\/strong>) for each server you wish to monitor. You’ll need to create a user with privileges on this schema.<\/p>\n

    Follow these short<\/a> or detailed<\/a> onstructions.<\/p>\n

    Setup monitoring for your database via crontab<\/em><\/h4>\n

    In your crontab, issue something like this:<\/p>\n

    \n
    *\/5 * * * * mycheckpoint --user=my_user --password=my_password --host=my_host --socket=\/path\/to\/mysql.sock<\/pre>\n<\/blockquote>\n
    Of course, you must replace option values with your own data. But the idea is to have mycheckpoint<\/em> run every 5<\/strong> minutes. Try one execution outside crontab<\/em> to see that it works. Depending on your OS\/distro, you may wish to specify full path for the mycheckpoint<\/em> binary (e.g. \/usr\/local\/bin\/mycheckpoint<\/strong>) within crontab<\/em>.<\/p>\n
    Later on, you may wish to create a defaults file<\/a>, and avoid passing the options on command line.<\/p>\n
    View charts using mycheckpoint HTTP server<\/em><\/h4>\n
    Wait for some time. There is no point in looking at charts when you’ve only taken a few samples. Actually, the charts won’t even show within the first hour. Things become interesting after several hours<\/em> have passed.<\/p>\n
    Invoke mycheckpoint<\/em> from the command line with the http<\/strong> argument (regardless of your crontab<\/em> setup):<\/p>\n
    \n
    mycheckpoint --user=... --password=... --host=... --socket=... http<\/strong><\/pre>\n<\/blockquote>\n
    This starts mycheckpoint<\/em> as HTTP service, by default listening on port 12306<\/strong>. Point your browser at:<\/p>\n
    \n
    http:\/\/host_running_mycheckpoint_server:12306\/<\/pre>\n<\/blockquote>\n
    And start browsing through HTML reports!<\/p>\n
    What’s next?<\/h4>\n
    You may want to look at human reports<\/a>; create alert conditions<\/a>; generate custom queries<\/a>. Read the complete documentation<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
    mycheckpoint is becoming larger and loaded with features. This page will help the new comer answering these questions: How do I start using mycheckpoint and what are the most interesting functionalities? This short page will describe how to set up mycheckpoint and quickly view HTML reports with interactive charting. The steps you will follow are: […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":147,"menu_order":-20,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-556","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/code.openark.org\/forge\/wp-json\/wp\/v2\/pages\/556","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=556"}],"version-history":[{"count":18,"href":"https:\/\/code.openark.org\/forge\/wp-json\/wp\/v2\/pages\/556\/revisions"}],"predecessor-version":[{"id":606,"href":"https:\/\/code.openark.org\/forge\/wp-json\/wp\/v2\/pages\/556\/revisions\/606"}],"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=556"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}