Skip to main content
Process Manager
InfrastructureSourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the Processes panel with terminalsbooleanfalseOpen the panel by itself on hosts that have it.
Panel sideselect"right"Where the Processes panel opens beside a terminal.
Panel sizenumber360Width or height of the panel in pixels.
Show the edge buttonbooleantrueShow a small button on the edge of the terminal to open the panel.

Host​

Set per host in the host editor, on the plugin's tab. Host defaults can set them for many hosts at once.

SettingTypeDefaultWhat it does
Process ManagerbooleanfalseShow this host's processes, pm2 and supervisor apps and logs.
Use sudobooleantrueUse root or sudo when the login user is not root. Needed to see and stop other users' processes.
Read onlybooleanfalseLook but don't change anything.
Run pm2 asstringThe user that owns the pm2 apps. Leave empty for the login user. Needs root or sudo.
Show the side panelbooleantrueOffer the Processes panel beside terminals on this host.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
process-manager.useadmin, userSee processes and logs on hosts you can reach. Changing things also needs edit access to the host.

Actions​

Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.

ActionRuns onRiskInputs
process-manager.list-processes
List processes
A hostRead only
process-manager.list-apps
List pm2 and supervisor apps
A hostRead only
process-manager.signal-process
Send a signal
One item on a hostChangessignal, expectedCommand
process-manager.kill-process
Kill process
One item on a hostDestructiveexpectedCommand
process-manager.renice
Change priority
One item on a hostChangesnice, expectedCommand
process-manager.app-start
Start app
One item on a hostChanges
process-manager.app-stop
Stop app
One item on a hostChanges
process-manager.app-restart
Restart app
One item on a hostChanges
process-manager.app-reload
Reload app
One item on a hostChanges
process-manager.app-delete
Delete app
One item on a hostDestructive
process-manager.app-flush-logs
Clear app logs
One item on a hostChanges
process-manager.tail-logs
Read logs
A hostRead onlysource, target, fd, stream, lines, grep
process-manager.add-watch
Add a watch
A hostChangeskind, target, rule, threshold, autoRestart
process-manager.remove-watch
Remove a watch
A hostChangesid
process-manager.read-zombies
Zombie processes
A hostRead only
process-manager.read-busy
Busy processes
A hostRead only
process-manager.read-top-cpu
Busiest process
A hostRead only
process-manager.read-top-processes
Top processes
A hostRead only
process-manager.read-apps-down
Apps down
A hostRead only
process-manager.read-managers
Process managers
A hostRead only

Events​

Automations can start when one of these happens.

EventWhat it means
process-manager.process-downA watched process is down
process-manager.app-crashedA watched app is down
process-manager.restart-loopAn app keeps restarting

Capabilities​

What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.

CapabilityRiskWhat it means
credentials:readCriticalSee your passwords and keys. It can read the stored secret for any host you can reach.
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
users:impersonateHighAct as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
network:serveMediumAccept connections. It opens a port on the Termix server.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
operations:provideMediumOffer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
hosts:readLowSee your host list. Names and addresses for hosts you can already see.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

API​

The plugin's HTTP routes are in the API reference.

Platforms​

Linux, Windows, macOS