Welcome To The Foreman Knowledge Base

Quick Guide: Workers

The Workers Page provides an overview of all available workers associated with your account, along with aggregated statistics about the workers and miners. This page allows for efficient monitoring and management of your workers, providing key insights into their activity and performance across your miners.

Screenshot 2025-02-05 at 10.33.17 AM.png

  1. Worker Overview:

    • Each worker may consist of one or more miners. Workers are aggregated by miner names, so if multiple miners share the same name, they will be combined into one worker record.
    • In most cases, each worker listed here corresponds to a unique miner listed on the Miners Page.
  2. Worker Identifiers:

    • A worker’s ID is made up of two parts: [account].[name].
  3. Aggregated Stats:

    • Worker Accounts: Displays the total number of distinct accounts associated with miners.

    • Active Worker Names: Shows the number of distinct worker names that are currently active, compared to the total number of worker names (active or inactive).

    • Found Worker Names: Displays the number of workers detected by a Pickaxe, compared to the total number of miners.

    • Status Indicators:

      • If all numbers match, the status displays normally.
      • If there are fewer workers than miners, an orange warning appears.
      • If no workers are found, a red failure indicator will be shown.

Worker Table Features:

  • Search: Easily search the list of workers across all visible columns.
  • Pagination: Navigate through multiple pages of workers.
  • Sorting: Sort workers by any of the table columns.
  • Page Size: Default shows 100 workers per page, but this can be customized.
  • Export: Export worker data to CSV format for further analysis.

Actions

Each worker row includes actions that:

  • Apply global filters.
  • Redirect you to the Miners Page, showing only miners related to the selected worker action.
Available Actions:
  • Show Active: Filters to show only active workers.
  • Show Configured: Filters to show workers that are configured.

Columns

  • Worker Name: The name of the worker.
  • Active Miners: The number of active miners associated with the worker.
  • Configured Miners: The number of miners that have been configured for the worker.
  • Worker Hash Rate: The hash rate of the worker.
  • Miner Hash Rate: The combined hash rate of the miners.

API Endpoints:

  1. Get All Workers: Retrieves all worker data, with options for search, sorting, pagination, and exporting.
  2. Get Aggregated Stats: Fetches the three separate aggregated statistics for workers.

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.