Welcome To The Foreman Knowledge Base

Quick Guide: Alerts & Triggers (Classic View)

This guide serves as a supplement to the existing Alerts & Triggers documentation and is designed to support you during the rollout of our new Triggers UI. If you prefer the layout you’re already familiar with, you can easily toggle to Classic View at any time.

The Triggers feature allows you to automate responses to miner performance issues and receive proactive alerts—eliminating the need for constant monitoring. With the updated experience, you can now also create tickets directly from a trigger and duplicate existing triggers with just a few clicks, making setup and troubleshooting faster than ever.

Note: If you don’t see the option to Add Trigger, it’s likely due to your current permission level. Please contact your organization’s Foreman administrator to request the necessary access.

Note: Any actions you take in either Classic View or the new UI will appear in both. You're just selecting your preferred interface — the actions themselves stay the same.

Navigation

From the left hand menu, select Alerts & Triggers then toggle on Classic View. 

toggle.gif

 

Triggers Page

When you're in the Classic View, the page is divided into two main sections. The first is Triggers, where you can see all active and inactive Triggers. The second is Trigger History, which displays recent events triggered by those active Triggers.

Screenshot 2025-05-13 at 11.30.34 AM.png

 

Trigger Components

Triggers are highly customizable items that are composed of different pieces. In the next section, we'll cover how to create one, this section will focus on what the different pieces are and why they're important.

  • Miners to Check
    • This defines which miners the Trigger will apply to. You can target all miners, specific miners, or miner groups. For more advanced setups, use AND/OR logic to combine multiple conditions—giving you flexible, granular control over which devices are monitored.
  • What to Check For
    • Here you specify the conditions that will activate the Trigger. These can include events like a hash rate drop, hardware error, or missed update. You can stack multiple checks, adjust time intervals, and fine-tune the criteria to match your operational priorities.
  • What to Do
    • This defines the action that should be taken when the Trigger conditions are met. You can choose from a variety of responses, such as sending an alert, adjusting overclock or power mode settings, rebooting or restarting miners, or running a custom script. These automated actions help you respond quickly to issues and keep operations running smoothly.

Add Trigger

To add a new trigger, follow the below steps:

  1. Click Add Trigger from the Trigger portion of the page to open the modal
    add trigger.gif
  2. Name your trigger (required)
  3. Miners to Check (required)
    1. First box (single select)
      1. Any - any miner that meets the next box's criteria
      2. All - all miners that meet the next box's criteria
      3. A Count Of - opens a new field where you'll indicate the numerical number of miners
      4. A Percentage Of - opens a new field where you'll indicate the percentage of miners
        Screenshot 2025-05-13 at 11.52.50 AM.png
    2. Second box (single select)
      1. Miner(s) - includes all miners 
      2. Miner(s) Matching - includes all miners meeting specific criteria *see note below
      3. Miner(s) Excluding - includes all miners except those meeting specific criteria *see note below
        criteria.gif

        - Note: A new field will appear allowing you to choose how you’d like to categorize your miners. Based on your selection, a second field will populate where you can select one or more values within that category.
    3. Add Condition (optional)
      1. Clicking this button allows a second layer of specification choosing either AND/OR and repeating the same steps as abovecondition.gif
  4. What to Check For (required)
    1. First box (single select)
      1. Trips a(n) - the trigger will activate when the selected condition occurs
      2. Doesn't Trips a(n) - the trigger will activate when the selected condition fails to occur (only available for certain conditions)
    2. Second box (single select)
      1. Miner Health Trigger - checks for any miner reporting a general health issue
      2. Miner Hash Rate Trigger - activates based on a miner’s hash rate falling below a defined threshold
      3. Miner Fan Speed Trigger - tiggers when fan speed exceeds or drops below a set range
      4. No Submitted Shares Trigger - detects when a miner stops submitting valid shares
      5. Not Updating Trigger - flags when a miner hasn’t sent data for a defined period
      6. Miner Rebooted Trigger - triggers when a miner unexpectedly reboots
      7. Miner Hardware Errors Trigger - activates if a miner reports hardware errors
      8. Missing Hash Board Trigger - detects when one or more hash boards are not recognized
      9. Missing Fan Trigger - flags when one or more fans are not detected by the system
      10. Time Interval Trigger - fires at a regular time interval (e.g., every X minutes); not available with Doesn’t Trip a(n)
      11. Minute Of Hour Trigger - triggers at a specific minute within each hour (e.g., at :15 past); not available with Doesn’t Trip a(n)
      12. Minute of Day Trigger - activates at a specific time of day (e.g., 10:30 AM); not available with Doesn’t Trip a(n)
      13. Pickaxe Offline Trigger - fires when a Pickaxe agent goes offline
      14. Zero Hash Rate Trigger - detects when a miner reports a hash rate of zero
      15. No Pools Configured - triggers when a miner has no mining pools set
      16. Invalid Pools Configured - activates when a miner has incorrect or unreachable pool settings
      17. Remote File Contains - fires if a specific string or pattern is found in a remote log or file
    3. Remaining fields (single select)
      1. Depending on your prior selection of condition, you may see an additional box appear asking if you want to be triggered on Failure or Warning
      2. Depending on your prior selection of condition, you may see an additional box appear asking how many intervals this condition should happen prior to action being taken (intervals are approximately 1 minute long)
        remaining fields.gif
    4. Add Condition (optional)
      1. Clicking this button allows a second layer of specification choosing either AND/OR and repeating the same steps as aboveconditionn.gif
  5. What to Do (required)
    1. First box (single or multi-select)
      1. Send Alert - sends a notification to alert you or your team when the trigger conditions are met. Great for staying informed without constant monitoring.
        Note: Upon selection, further options will appear which are also single or multi-select
        send alert.gif
      2. Change Client  - reassign miners when trigger conditions are met to a different client
        Screenshot 2025-05-13 at 2.13.17 PM.png
      3. Change Overclock - automatically adjusts the overclock profile on affected miners. Useful for scaling performance up or down in response to changing conditions.
        Note: Upon selection, further options will appear to indicate the Frequency and Voltagechange overclock.gif
      4. Change Pools - switches the active mining pool configuration. Ideal for redirecting hash power or responding to pool-level issues.
        Note: Upon selection, a button will appear to Configure Pools, add in the URL, username, and password of your pool before saving
        change pools.gif
      5. Change Power Mode - modifies the power mode of the miner (e.g., low power or performance mode). Helps manage energy consumption during peak hours or throttling scenarios.
        Note: Upon selection, more fields will open up allowing you to choose your power mode options with an optional amount of minutes to pass before changing
        change power mode.gif
      6. Factory Reset - resets the miner to its default settings. Should be used with caution—typically for recovering misconfigured or unstable devices.
        Note: Upon selection, a button will appear to Configure Pools, add in the URL, username, and password of your pool before saving
        factory reset.gif
      7. Fan Adjustments - changes fan speed settings. Useful for managing cooling in response to temperature changes or hardware performance.
        Note: Upon selection, you'll be able to choose between Manual (then select the specific fan speed) or Auto (based on compatibility list)
        fan adjust.gif
      8. Set Power Target - sets a specific power usage target for the miner. Great for maintaining consistent energy usage within infrastructure or contract limits.
        Note: Upon selection, you'll be able to set the Power Target in watts 
        power.gif
      9. Reboot Miners - performs a full power cycle of the miner. Useful for recovering unresponsive devices.
        Screenshot 2025-05-13 at 12.54.46 PM.png
      10. Restart Miners - restarts the mining process without a full reboot. Typically quicker than a full reboot and helpful for resetting software-level issues.Screenshot 2025-05-13 at 12.55.14 PM.png
      11. Run Script - more details can be found in this article.Screenshot 2025-05-13 at 12.55.31 PM.png

Managing Triggers

Once a trigger is created, you can then click into the trigger and make one of the following actions:

  • View details - click into the name of the trigger to open the details viewopen.gif
  • Change status - by default, new triggers are set to active. You can toggle this setting to deactivate or reactivate the trigger at any time. Just make sure to click Save to apply your changesstatus.gif
  • Edit - you may edit any of the details of your trigger, just make sure to click Save to apply your changes
  • Delete - to delete your trigger, click the trashcan icon and then Save  to apply your removaldelete.gif

 

Trigger History

The Trigger History section displays a log of recent events where triggers were activated. This helps you monitor when and why a trigger was tripped. For more context on a specific event, you can click “See Details” to view additional information, including the miners involved and the actions taken.history.gif

 

Ready to upgrade?

We're rolling out the new Triggers UI. If you're ready to enable the new interface for your operation, reach out to us and we’ll get you set up. 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.