Skip to main content
Version: 3.6.0

Managing application with Watt

Watt provides several commands to manage Platformatic runtime applications. You can stop, restart, and debug your applications in a local development environment.

Enabling application management API​

Before you can Watt to manage your application, you need to enable the application management API in your application's configuration file. This will allow the CLI to communicate with your application.

To enable the application management API, add the following configuration to your application's platformatic.json file:

{
  "managementApi": true
}

Installing​

You can install Watt by running the following command:

npm install -g wattpm

Listing running applications​

To list all running applications, run the following command:

wattpm ps

This will display a list of all running applications, including their PID, npm package name, Platformatic version, running time, URL, and working directory.

PID    NAME        Version Uptime  URL                  Directory
38898  my-app-foo  3.0.0   1m 52s  http://0.0.0.0:3042  /Users/test-user/foo
38899  my-app-bar  3.0.0   4m 53s  http://0.0.0.0:3043  /Users/test-user/bar

Stopping a running application​

To stop a running application, run the following command:

wattpm stop [<PID> | <NAME>]

You can stop a running application by specifying either its PID or its name.

Restarting a running application​

To restart a running application, run the following command:

wattpm restart [<PID> | <NAME>]

You can restart a running application by specifying either its PID or its name. Note that after restarting, the application parent process will be changed to the current CLI process.

Reloading a running application​

To reload a running application, run the following command:

wattpm reload [<PID> | <NAME>]

The difference between reload and restart is that reload does not kill the application process. It stops and starts all the application services. Some configurations will not be updated.

You can reload a running application by specifying either its PID or its name.

Displaying logs for a running application​

To display logs for a running application, run the following command:

wattpm logs [<PID> | <NAME>]

You can display logs for a running application by specifying either its PID or its name.

You can filter logs by specifying a log level or application name:

Display logs for a specific application

wattpm logs [<PID> | <NAME>] <APPLICATION>

To see the list of applications in a running application, you can use the wattpm applications subcommand.

Display logs for a specific log level

wattpm logs [<PID> | <NAME>] -l <LEVEL>

Supported log levels are trace, debug, info, warn, error, and fatal.

Listing environment variables for a running application​

To list environment variables for a running application, run the following command:

wattpm env [<PID> | <NAME>]

You can list environment variables for a running application by specifying either its PID or its name.

Printing application config file​

To print the application config file, run the following command:

wattpm config [<PID> | <NAME>]

To print the application config file, run the following command:

wattpm config [<PID> | <NAME>] <APPLICATION>

You can print the application config file for a running application by specifying either its PID or its name.

Injecting an HTTP request into a running application​

To inject an HTTP request into a running application, run the following command:

wattpm inject [<PID> | <NAME>] [<APPLICATION>] -m <method> -p <URL> -H <header> -d <data>

With the inject command you can make requests not only to endpoints that are exposed by the application, but also to internal endpoints that are not exposed via the application entrypoint. To do so, you can append the application name before URL arguments.

Example:

wattpm inject my-app-foo my-application
  -m POST
  -H "Content-Type: application/json"
  -d '{"foo": "bar"}'
  -p /api/v1/foo

As you can see there is no need to specify a full URL, you can just specify the path of the endpoint you want to call.

Listing applications in a running application​

To list all applications in a running application, run the following command:

wattpm applications [<PID> | <NAME>]

The list command shows all applications that are currently running in the application.

NAME      Workers   Type      Entrypoint
movies    1         db        no
payment   1         db        no
gateway   1         gateway  yes

You can list all applications in a running application by specifying either its PID or its name.