You can use the command line to perform platform administration tasks with the Synthetic Server, such as starting and stopping the services. This page describes the available commands, the log files, and the endpoints for testing the reachability and health of the Synthetic Server. Run the commands from the root directory of the Synthetic Server home.
Start and Stop the Synthetic Server
Start the Synthetic Server from the root directory of the Synthetic Server home as follows:
To check if the Synthetic Server services are running and accessible, run the following command and confirm that there is output:
To stop the Synthetic Server:
Increase the Synthetic Agent Support
By default, the machine hosting the Synthetic Server should be able to support 100 concurrent Synthetic Agents. To support more than 100 concurrent Synthetic Agents, modify the throttle configuring for the Synthetic Shepherd and Synthetic Scheduler. The default maximum number of requests per second is 60. By increasing the maximum number of requests per second, the Synthetic Server can support more Synthetic Agents.
To increase the maximum number of requests per second that the Synthetic Server can receive:
- Log on to the machine hosting the Synthetic Server.
- Change to the root directory of the Synthetic Server home.
Edit the file
synthetic-processor/conf/synthetic-shepherd.ymland increase the value for the property
maxRequestsPerSecondOverall. In this example configuration, the value is increased to 80.
Edit the file
synthetic-processor/conf/synthetic-scheduler.ymland increase the value for the property
maxRequestsPerSecondOverall. Again, in this example configuration, the value is increased to 80.
Restart the Synthetic Server:
You can verify that the settings have been updated by checking the logs for the Synthetic Server you changed:
You should also check the health of the Synthetic Server.
Create Preset Health Rules and Dashboards
Once you have monitored the Synthetic Server, run the following command to create the preset health rules and dashboards:
See Create Preset Dashboards and Health Rules to learn more about the preset health rules and dashboards.
Upgrade the Synthetic Server
You can update the Synthetic Server and the database schema without uninstalling and reinstalling the Synthetic Server using the
update command. See Upgrade the Synthetic Server for instructions.
Check the Health of the Synthetic Server
To check if the Synthetic Server is running, you can run the following. You should receive the response
To check the health of the Synthetic Server:
If the Synthetic Server is healthy, the response should be similar to the following:
Log Files for the Synthetic Server
The Synthetic Server creates the following error log files for each service:
For general (non-error) log files, see the following directories:
The naming convention for the general log files is
<log>-YYYY-MM-DD.log. You will need to set up a policy to archive or delete the general log files to prevent running out of disk space.