<- Return to getpimp.org

Tutorial: How to use the Miner.farm Web Application


  • Staff

    Farm View

    Farm View is the primary view of your farm. There is a Summary section, a Problems section, and an Agents section. You can click many items on the screen to "drill down" for more detailed information. For example, if you click on a rig, it expands to show the miner instances running in it. Then if you click one of those, it will take you to the Miner view to show you the devices and their stats.

    0_1506026754442_farmviewmain.jpg

    Summary Section

    In the Summary Section you will see the name of your farm, number of Agents, Miners, and Devices in the farm, and the total farm hashrate and graph.

    0_1506026940600_farmviewmainsummary.jpg

    Problem Section

    In the Problem Section you will see Current Problems and a chart of Problems per hour. If you click on a Problem it will take you to that Miner to see more information.

    Problem data refreshes every few minutes, so allow some time after a rig is fixed for the Problem Section to update.

    0_1506027126440_farmviewmainarrowcurrentandhour.jpg

    Agents Section

    In the Agents Section, each agent that connects or has connected to your farm is listed. Each Agent is shown as: Agent Name, Agent hashrate, # miner instances, PiMP version (if this Agent is running PiMP OS) and the Agent uptime (Time that the minerfarm service has been running on the rig.)

    The Agents are colored based on Status:

    • Green means mining and within Alert Profile parameters.
    • Yellow means one or more miners is outside of the Alert Profile parameters or not running.
    • Red means Agent down, or all miner instances are stopped.

    Inside each Agent, you will see a header row and a row for each mining instance running on the rig. For example if you use pimp --start 1 or minerfarm --start 1 Then this will be the first miner listed on the agent.

    Each mining instance is shown as Agent Name (dot) ID number, example: m171-6x1070.1 is the ID 1 on the m171-6x1070 agent (rig). Then that particular mining instance's Hashrate, Devices, Active Pool, Miner software and version, and the uptime of the mining instance itself is shown for each mining instance.

    If you click the Mining Instance row it will take you to the Miner View for that instance with even more detailed information. See "Miner View" below for details.

    0_1506027314760_pimpfarmviewunpaid.jpg

    On Paid accounts, there is also a button here called Agent Settings:

    0_1506027399187_agent settings.jpg

    Clicking this button will bring up a window with the ability to control settings on the agent rig.

    • On PiMP OS rigs, the GPUs on the Agent Host are displayed.
    • You can add miners via a dropdown, like minerfarm --add (pimp --add) commands on the rig, but using the Miner.farm GUI.
    • You can change the agent name like minerfarm --setname on the rig, but using the Miner.farm GUI.
    • You can turn Email alerts on for when the Agent is down or not seen by miner.farm. (Reminder for Agent Down alerts: Agent Down E-mail alerts are set ON or OFF here, on the Farm View page, under Agent Settings. However, the email address used for agent down alerts is the one specified in the default profile in the Alert View.)
    • You can restart the minerfarm agent service on the agent host rig.
    • You can reboot the rig!

    0_1506027458828_agent settingsclicked.jpg

    Removing Agents:

    You can remove agents that are no longer reporting for some time. You must be logged in and you will see the Remove button to the right.

    Note: Pro plans also have Custom View Options at the bottom of the Agent view: Sort by, and Collapsed View. These allow larger farmers to manage long lists of agents.

    0_1525787209340_how-to-remove-an-agent-from-miner-farm-pimp-mining.png

    Miner View (AKA Profile View or Mining instance View)

    The Miner View has combined and streamlined the Summary and Problem sections into one section (details below). Below that is the Devices Section which lists all devices used by this mining instance and the stats that are available from that mining instance.

    Depending on API skill set of the miner author as well as the hardware used, we may not get all values. For details, see: https://miner.farm/apifaq

    Summary/Problem Section

    In the combined Summary/Problem Section, there are a few differences from the Farm View:

    • You can see a summary and graph of the stats for this instance. These stats are specific to the miner running and more detailed than the stats on the Farm View.

    • Clicking the Problems per Hour Chart will provide a History Log for the Problems that have happened.

    • (Requires Farmer or above subscription) To the right of the Problems Chart you can see and change the current Alert Profile. The Alert Profiles are configured in Alert View and allow you to receive alerts based on fan rpm, temperature, etc.

    • There is a Miner Controls button and the current conf file is shown:

    0_1506027792051_minerclickedin farmview minercontrolbutton.jpg

    Clicking this button will bring up a window with the ability to Start, Stop, Restart (if running), and Remove the miner (minerfarm --delete or pimp --delete the miner)

    0_1506027845619_minercontrolclicked.jpg

    Devices Section

    The mining instance has a mini-summary at the dop of the device listing with some important details such as the Pool, partial PiMP key (if using PiMP OS), Algorithm, and Reject Rate. Below that are all available stats.

    The Agents are colored based on Status:

    • Green means mining and within Alert Profile parameters.
    • Yellow means this mining instance is outside of the Alert Profile parameters.
    • Red means miner instance is stopped.

    0_1506028877583_farmviewwith all colors.jpg

    Note: If you are using a Dual Miner such as Claymore-Dual you will see one device listing for each of the two algorithms, with the available stats for each.

    0_1506029050707_farmview.jpg

    Pool View

    Pool View allows you to view your farm per pool connection instead of per agent. This allows you to see where your hashes are going at a glance so it can help you make your profit calculations. You can also give the pools names so it is easier to manage your farm. The layout has a Summary Section similar to the other Views, followed by the Pools Section.

    0_1506029090573_poolview.jpg

    Summary Section

    In the Pool View, the Summary Section simply shows the total farm hashrate and the graph is per-pool.

    0_1506029203352_poolviewsummary.jpg

    Pools Section

    In the Pools Section, each pool that is defined by the current confs or has been used on this farm before is shown in the list, and has a little sub-section.

    In each Pool sub-section, it will show the Pool url/port at the top, then it will list each mining instance that is mining to that pool.

    0_1506029622523_poolviewsubsection.jpg

    Pools are sorted Newest at the Top but grouped in the following order: Pools with miners assigned that have problems, then current active (Blue) pools, then inactive or old pools that no longer have miners assigned to them.

    The Pool sub-sections are colored based on Status:

    • BLUE means all mining instances assigned to this pool are mining and within Alert Profile parameters. All mining instances inside the pool section show green.
    • Yellow means this Pool has mining instance(s) outside of the Alert Profile parameters.
    • Red means there are 1 or more stopped miners, or no miners at all, assigned to this pool.

    Each mining instance shown in a pool, if it is mining, will show the total stats for that mining instance. You can click one of the miner instances to go to the Miner View for it whether it is stopped or mining.

    There is also a Pool Settings button in each Pool sub-section:

    0_1506029719562_poolviewpoolsettings.jpg

    Clicking this button will bring up a new window with the available options for this Pool:

    • You can set an alias for the Pool.
    • You can show all available miners in this Pool's sub-section so that you can easily switch them to this Pool.
    • You can set Alerts for Reject % per Pool.
    • You can Delete the pool.

    0_1506029849254_poolviewpoolsettingsclicked.jpg

    Alert View

    Alert View is available on all subscription levels, even free. However, having multiple Alert Profiles, and getting Alert E-mails, those features require Farmer and higher subscriptions.

    Alert View allows you to make profiles of min/max threshold values. When your miners go outside of these values that you set, the miner will show a Problem in the Problem Sections, and the mining instance will show yellow color instead of green. If you have Farmer and above, again, you can get e-mail when these events occur.

    Summary Section

    The Summary Section on the Alert View is the same as the Problems Section on the Farm View, except for the addition of the "Add profile" type selection and button. To add a profile, pick a type and click Add Profile.

    Alert Profiles Section

    In the Alert Profiles Section, each profile created is shown in the list, and has a little sub-section.

    In each Alert Profile sub-section, it will show the Profile name, number of miners using it, and the settings for the profile at the top, then it will list each mining instance that is using that Alert Profile.

    0_1506029931868_alertviewpage.jpg

    Each mining instance shown in a Profile, if it is mining, will show the total stats for that mining instance. You can click one of the miner instances to go to the Miner View for it whether it is stopped or mining.

    There is also a Profile Settings button in each Pool sub-section:

    0_1506030146403_alertviewpageprofilesettingspointed.jpg

    Clicking this button will bring up a new window with the available options for this Profile:

    • You can set the various minimum and maximum thresholds for when the miner will alert you.
    • Set a value to 0 to disable it.
    • You can set the recipient e-mail address for this profile, and turn e-mail alerts on and off.
    • You can rename the profile. (Including the default)
    • You can delete the profile. (Except for the first profile which is the Default)

    0_1506030190338_alertviewpagegraphclicked.jpg

    Reminder for Agent Down alerts

    Agent Down E-mail alerts are set on the Farm View page under Agent Settings. The email address used for agent down alerts is the one specified in the default profile in the Alert View.



  • Can you explain the custom views feature available at Farmer level and above?


  • Staff

    The 'Custom Views' feature controls how your Farm View appears. The examples here show the 'collapsed view', which is available with Farmer level and above. The default view shows each agent uncollapsed in the Farm View.


 



Want 10% more hash from your rigs?



We promise to keep your email safe and never spam you.



Copyright (c) 2017 PiMP LLC. All rights Reserved.

Looks like your connection to PiMP Forum was lost, please wait while we try to reconnect.