Simple Cgminer Remote Monitoring Script - now with email alerts

[p4xil]

SIMPLE CGMINER REMOTE MONITORING SCRIPT NOW WITH ALERTS



I made this script so I can check status for my rigs from anywhere not just my local computer.
I know there is ANUBIS but it is too heavy for me. I just needed a simple status script.

You will need:
- Webserver / webhosting with PHP (with socket support enabled)
- Crontab access for Alerts
- Postfix or Sendmail for sending Email Alerts
- Miners using Cgminer

1. CONFIGURING CGMINER

Enable API support with adding this to the cgminer.conf:

Code:

"api-port" : "4001",
"api-listen" : true,
"api-allow" : "YOUR_WEBSERVER_IP",

or cgminer command line:

Code:

--api-port 4001 --api-listen --api-allow "YOUR_WEBSERVER_IP"

Change YOUR_WEBSERVER_IP to your webserver REMOTE IP.
With --api-allow only webserver remote IP has the read only access to the cgminer API. This has to be set for security reasons.
Each rig needs its own api-port! Ports numbers can be ANYTHING you want as long the are not already taken. For example you can set port 4001 for Rig #1, 4002 for Rig #2, 4003 for Rig #3, etc.

2. OPEN PORTS ON ROUTER / FIREWALL



If you have a router or a firewall you will need to open ports you have chosen for your rigs. In my example you will need to open ports 4001, 4002, 4003.
To do this you will have to know your rigs local IPs and set the port forwarding on router to these IPs.
You get the rig's local IP number with:

on windows open command prompt and run:

Code:

ipconfig

Look at "IPv4 Address" of your network adapter.


on linux run command:

Code:

ifconfig

Look at "inet addr:"  of your network adapter.


3. SETUP MONITORING PHP SCRIPTS

Download files from here:
https://github.com/Paxxil/cgminer_remote_monitoring

Open functions.inc.php in your text editor.
Follow the instructions inside and add your miner rigs settings there.
After you made the changes, FTP to your webserver, navigate to your public www directory, create subdirectory "monitoring" and upload the files to it.

If you set everything right you should get the monitoring stats when you navigate to http://your_webserver_ip/monitoring/ (or if you have a domain http://wwww.your_domain.com/monitoring/)

4. CONFIGURING ALERTS
Open functions.php.inc in your text editor.
Edit the settings (email, alert configs) in the # SETUP ALERTS # Section.

Next you will have to make the file email.lock writable by the script.
In linux you do it with command:

Code:

chmod 666 email.lock

Now open crontab editor:

Code:

crontab -e

And put ABSULUTE path to the monitoring_cron.php script

Code:

*/2 * * * *     php /path/to/your/monitoring_cron.php >/dev/null 2>&1

This will execute monitoring_cron.php every 2 minutes.
If you want to check the server less frequently change */2 * * * * part.
Some examples:

Code:

* * * * *   => every minute
*/5 * * * * => every 5 minutes
0 * * * *   => every hour
0 0 * * *   => once a day at midnight server time

Save the file and shut down one cgminer to test the script. If you receive the email then everything works.

If you can not get it to work just PM me and I will help you.

If you like it please support it with donating:
LTC : LdQ1UHiRy24Tvmm8NHbhAdHL3Qf3JqrUbG
BTC : 1EA8UrpifP9hi7LZHjJphCJQ6Hh45mb5pP

Good Luck!
--p4xil

EDIT
2014-01-02 : v2.1.1 Fixed some bugs
2013-12-29 : v2.1 Added ASC and PGA support
2013-06-13 : Fixed some bugs
2013-06-04 : v2.0 Added Email Alerts

[3ham3]

Getting an error from the index file, fails to operate at all.

[01BTC10]

File is suspicious.

SHA256:   33bfc4e9478de38255b307ae725dd5a7a940d3a2bb47bf9028f57a5493e55598
File name:   monitoring.rar.exe
Detection ratio:    4 / 47
Analysis date:    2013-06-02 05:38:24 UTC ( 0 minut ago )

https://www.virustotal.com/cs/file/33bfc4e9478de38255b307ae725dd5a7a940d3a2bb47bf9028f57a5493e55598/analysis/1370151504/

[p4xil]

Getting an error from the index file, fails to operate at all. You Sir, are you trying to steal my coins?

Follow the tutorial and you should get it working.
I posted project to github now so you can check the files.

post it on github.  Your link is asking me to download exe which I'd never do without seeing the source code.

Looks nice.

I'd like to try it.  Post your script on github.

I posted project to github now.

File is suspicious.

SHA256:   33bfc4e9478de38255b307ae725dd5a7a940d3a2bb47bf9028f57a5493e55598
File name:   monitoring.rar.exe
Detection ratio:    4 / 47
Analysis date:    2013-06-02 05:38:24 UTC ( 0 minut ago )

https://www.virustotal.com/cs/file/33bfc4e9478de38255b307ae725dd5a7a940d3a2bb47bf9028f57a5493e55598/analysis/1370151504/

I don't know where did you find EXE, but well it is on github now so do not worry about it anymore.

[Jazkal]

Any chance this can be modified to use the default port of 4028 for all miners?

[p4xil]

you can change port to default in port section, but it won't work if you set same port for all miners.

[p4xil]

I have added EMAIL ALERTS support.

[af_newbie]

I have added EMAIL ALERTS support.

The emails will be sent out by whatever mail server you configure in php.ini, right?
Have you tried this on Windows under IIS?

[p4xil]

I have added EMAIL ALERTS support.

The emails will be sent out by whatever mail server you configure in php.ini, right?
Have you tried this on Windows under IIS?

yes... you need postfix or sendmail installed on the server where webserver is.
I haven't tried with IIS.... but I am sure it can be done.

[christov84]

Nice work

[servicelabs]

monitoring_cron.php on line 48
postdrop: warning: unable to look up public/pickup: No such file or directory

[servicelabs]

I have done according to your guide, Thanks!
http://www.service-labs.com/miner_monitoring/

[PSL]

This patch adds these features to monitoring script 2.0:

- fix temperature when card is hot (cosmetic).
- display correct active pool (bug)
- display user (new)

Code:

$ git diff -p
diff --git a/index.php b/index.php
index 7587ad7..b5c8145 100644
--- a/index.php
+++ b/index.php
@@ -148,12 +148,13 @@ for ($i=0; $i<$nr_rigs; $i++)
 <?php
 for ($i=0; $i<$nr_rigs; $i++)
 {
+        $pool_priority = 999;
        foreach ($r[$i]['pools'] as $pool)
        {
-               if ($pool['Stratum Active'] == 'true')
+               if (($pool['Status'] == 'Alive') and ($pool['Priority'] < $pool_priority))
                {
-                       $pool_active = '<span style="font-weight:normal">Pool ' . $pool['POOL'] . ' - ' . $pool['URL'] . '</span>';
-                       break;
+                        $pool_priority = $pool['Priority'];
+                       $pool_active = '<span style="font-weight:normal">Pool ' . $pool['POOL'] . ' - ' . $pool['URL'] . ', user - ' . $pool['User'] . '</span>';
                }
        }
        ?>
@@ -187,7 +188,7 @@ for ($i=0; $i<$nr_rigs; $i++)
                                        <tr>
                                                <td style="text-align:center"><?php echo $gpu['GPU'] ?></td>
                                                <td style="text-align:center"><?php echo $gpu['Status'] == 'Alive' ? '<span class="ok">' . $gpu['Status'] . '</span>' : '<span class="error">' . $gpu['Status'] . '</span>' ?></td>
-                                               <td style="text-align:center"><?php echo $gpu['Temperature'] > ALERT_TEMP ? '<span class="error">' . round($gpu['Temperature']) . '°C</span>' : round($gpu['Temperature']) ?>°C</td>
+                                               <td style="text-align:center"><?php echo $gpu['Temperature'] > ALERT_TEMP ? '<span class="error">' . round($gpu['Temperature']) . '°C</span>' : round($gpu['Temperature']) . '°C' ?></td>
                                                <td style="text-align:center"><?php echo $gpu['Fan Percent']?>%</td>
                                                <td style="text-align:center">
                                                        <?php

[p4xil]

Thanks!
I've commited the changes.

[grobbes]

For some reason the degrees symbol wasn't registering right for me so I swapped it out with ° but was most likely due to my editor

[p4xil]

Yes probably.
You should save the files using UTF8 without BOM encoding.

[tuckertz1992]

I really can not get this to work....

http://tomsmining.yzi.me/test

[PSL]

I post a patch, that address an issue that wrong pool and user is displayed for miner that is offline:

Code:

$ git diff -p
diff --git a/index.php b/index.php
index 4ca2063..b4a031f 100644
--- a/index.php
+++ b/index.php
@@ -149,6 +149,7 @@ for ($i=0; $i<$nr_rigs; $i++)
 for ($i=0; $i<$nr_rigs; $i++)
 {
        $pool_priority = 999;
+       $pool_active = '';
        foreach ($r[$i]['pools'] as $pool)
        {
                if (($pool['Status'] == 'Alive') && ($pool['Priority'] < $pool_priority))

[forum2005]

only GPU support ? and Icarus boards ?

[gjpminingco]

I am getting this Error

under the USB section

Warning: Division by zero in /home/a1628273/public_html/index.php on line 181

0 Alive 54°C 100% 0.00 | 0.00 0 0 0 0% 2013-09-17 22:36:28 Alive 0°C % 335.61 | 335.03 1 1 2 100% 2013-09-17 22:46:11