Braiins Manager Agent - Management

Overview

Agent management differs based on the version you are using:

Agent v4.0.0+ includes a built-in Graphical User Interface (GUI) for convenient configuration and control directly from the desktop.
Agent v3.x is managed via the command line using PM2 process manager commands.

Refer to the appropriate section below based on your installed agent version.

Agent Management

Update Agent ID & Secret Key

If you need to reassign the agent to a different location or reconfigure its credentials.

Stop Agent Service

Use the State toggle in the GUI to temporarily stop the agent. You can reactivate it later using the same switch. Activation and deactivation are persistent. Make sure to reactivate the agent when needed.

Disable Autostart

Toggle Autostart off in the GUI to prevent the agent from starting automatically on system boot. For a good experience, we do not recommend disabling it.

Download Logs

Click the Download Logs button in the GUI to export a ZIP archive containing the agent's logs for diagnostic purposes.

Agent Auto-Update

If a newer version of the agent is available, the GUI will notify you. Click the Update button to download and apply the latest version.

See more in the Upgrade & Uninstallation Guide.

Commands Concurrency

Starting with Agent v4.3.0, you can fine-tune how many commands are processed in parallel to optimize speed and stability.

What is Concurrency?

Concurrency controls how many commands the agent executes simultaneously. Adjusting these values helps balance:

Fast execution (higher concurrency)
Gradual execution (lower concurrency), useful for staged resumes or reducing power spikes

Default Values

pause_concurrency: 250     # For pause commands
resume_concurrency: 50     # For resume commands
concurrency: 250           # For all other commands

These defaults work well for up to 5,000 miners in typical environments.

Configuring Concurrency

To customize, edit the agent's daemon.yml config file and add the commands section:

commands:
  pause_concurrency: 250
  resume_concurrency: 50
  concurrency: 250

Estimate Execution Time

T = \frac{N}{k} \cdot \frac{X}{1000}

Where:

N = number of miners
k = concurrency
X = average execution time (ms)
T = estimated total duration (seconds)

Example: For 5,000 miners, 1s per command, and resume_concurrency = 50:

T = \frac{5000}{50} \cdot \frac{1000}{1000} = 100 seconds

Or calculate needed concurrency

If you want to determine the concurrency required to complete execution within a target time T:

k = \frac{N \cdot X}{T \cdot 1000}

Quick Reference

Concurrency	Execution Time (5,000 miners @ 1s)
50	100 s
100	50 s
250	20 s
500	10 s
1000	5 s

Best Practices

Stick with defaults unless specific use cases require tuning.
Lower resume_concurrency for smoother, but slower, startup.

The Braiins Manager Agent in version Agent v3.x or lower is a NodeJS application that acts as an interface between Braiins Manager's backend and your mining hardware. It runs as a service managed by PM2, a process manager that ensures the agent operates smoothly. Although Braiins Manager automates the management of PM2, users can still control the agent using PM2 commands for troubleshooting or maintenance.

Key PM2 Commands:

Start the Agent:
```
pm2 start /path/to/pm2.config.js
```

Starts the Braiins Manager Agent from within the installation folder represented in the command as /path/to/.

List Running Processes:
```
pm2 list
```

Lists all running processes managed by PM2.

Restart a Process:
```
pm2 restart /path/to/pm2.config.js
```

Restarts the PM2 process and forces an Agent configuration update from within the installation folder represented in the command as /path/to/.

Stop and Delete a Process:
```
pm2 delete [id]
```

Stops and removes the specified process from the PM2 list.

Save Process State:
```
pm2 save
```

Saves the current state of all PM2 processes to be restored after a reboot.

Restore Saved Processes:
```
pm2 resurrect
```

Restores all processes saved by pm2 save.

Enable PM2 at Startup:
```
pm2 startup
```

Ensures PM2 and the saved processes start automatically on system boot.

View Logs:
```
pm2 logs --lines [numberOfLines] [id]
```

View logs for a specific process, with [id] being the process ID and [numberOfLines] specifying how many lines of logs you want to view.

Was this helpful?

Braiins Manager Agent - Management#

#Overview

#Agent Management

#What is Concurrency?

#Default Values

#Configuring Concurrency

#Estimate Execution Time

#Or calculate needed concurrency

#Quick Reference

#Best Practices