Skip to main content
This guide is for Laravel applications.
Follow these steps to manually configure Laravel Nightwatch in your Laravel application and run the agent as a background process in your Cloud environment. For more details, see the Nightwatch getting started guide.
You can connect all your App and Worker clusters by automatically integrating Nightwatch with your app environment.

​
Configure Nightwatch on Cloud

1

Install Nightwatch package

Install the Laravel Nightwatch package in your application locally using Composer:
Run composer require laravel/nightwatch on your local machine to update your composer.json and composer.lock files before deploying.
2

Add your Nightwatch token

Add your Nightwatch environment’s NIGHTWATCH_TOKEN to your .env file:
You can find this value in your Nightwatch dashboard when you create an application.
3

Configure the agent as a background process

To keep the Nightwatch agent running and sending data, configure it as a background process in your Cloud environment:
  1. Go to your App cluster in the Cloud dashboard.
Select the app cluster

Select the App cluster

  1. Click New background process.
Select “New Background Process”

Select “New Background Process”

  1. Choose Custom worker.
Add a custom worker that runs the `nightwatch:agent` command

Add a custom worker that runs the nightwatch:agent command

  1. Enter the following command:
  1. Save your changes and redeploy your application.
If you’re using a dedicated worker cluster, repeat these steps for the worker cluster so it also runs the agent.
4

Monitor the agent

To check the health of the running agent, use the following command:
The nightwatch:status command exits with a non-zero status code if there is an error. The command checks that the agent can accept connections and send data to Nightwatch.

​
Use Cloud and Nightwatch logs

To send your logs to both Laravel Cloud Logs and Nightwatch, use Laravel’s log stacks feature. To log to both services, update your .env file:

​
Frequently asked questions

Why would I want to run Nightwatch manually? If you only want the Nightwatch agent to run on specific instances, you can manually set up the background process for each one. Can I log to both Nightwatch and Cloud Logs? Yes, you can use Laravel Cloud Logs simultaneously with Nightwatch Logging by setting a log stack in your .env in your Cloud environment settings. Do you need a background process running for each worker cluster? Yes. Configure a background process for each worker cluster that needs to run the Nightwatch agent. Can you run the command from the Commands dashboard of Laravel Cloud? No. The Nightwatch agent must run as a background process to collect and send data continuously. Running the agent from the Commands dashboard does not keep it running.