Post installation MID Server administration

You can manually start, stop, restart, and monitor the MID Server after it is installed.

The status of each MID Server activity appears in the MID Servers page. Additional log information appears in the following places:

  • The MID Server log is available on the instance.
  • The corresponding agent0.log.0 and wrapper logs (wrapper.log) are available in the MID Server agent\logs folder.

Start the MID Server

Manually start the MID Server to initiate communication with the instance.

Before you begin

Role required: admin, mid_server

About this task

You can manually start the MID Server.

Procedure

  1. Do one of the following:
    • Windows command line: From the MID Server home directory, for example the agent folder, type start.bat.
    • Windows Services console: From the Windows Services console, right-click the ServiceNow MID Server name and then select Start.
    • Linux: From the MID Server home directory, for example the agent folder, type start.sh.
  2. Monitor the MID Server to ensure that it is operating properly.

Stop the MID Server

Stop the MID Server to terminate communication with the instance.

Before you begin

Role required: admin

About this task

Consider pausing the MID Server instead. Pausing the MID Server from the instance still allows you to run certain commands on the MID server.

Procedure

  1. Do one of the following:
    • Windows command line: From the MID Server home directory, for example the agent folder, type stop.bat.
    • Windows Services console: From the Windows Services console, right-click the ServiceNow MID Server name and then select stop.
    • Linux: From the MID Server home directory, for example the agent folder, type stop.sh.
  2. Restart the MID Server when ready.

Restart the MID Server

You can restart the MID Server if it has been stopped.

Before you begin

Role required: admin

About this task

You can manually restart the MID Server.

Procedure

  1. Do one of the following:
    • MID Server instance: Navigate to the MID Servers and click a Name. Under Related Links, click Restart MID.
    • Windows command line: From the MID Server home directory, for example the agent folder, type Restart.bat.
    • Windows Services console: From the Windows Services console, right-click the ServiceNow MID Server name and then select Start.
    • Linux: From the MID Server home directory, for example the agent folder, run the restart-service.sh script using one of these commands:
      • ./restart-service.sh
      • sh restart-service.sh
      • bash restart-service.sh
  2. Monitor the MID Server to ensure that it is operating properly.

Monitor the MID Server

Monitoring MID Servers involves verifying entries in log files, confirming network connectivity, and checking MID server status.

Before you begin

Role required: agent_admin or admin

About this task

You can monitor MID Servers hosted by Windows or Linux MID servers.

Procedure

  1. For Windows only, navigate to the Windows Services console, locate the service name that matches the name that appears from the wrapper-override.conffile. If the MID Server process is the only Java process running on the host, monitor the memory used by java.exe and alert on less than the maximum configured memory defined in the ~\agent\conf\wrapper-override.conf folder.
  2. Ensure that the agent0.log.0.lck file appears in the ~\agent\logs folder to confirm that the MID Server running and logging system activity in the agent0.log.0 file.
  3. Review the following logs for warning, critical, and severe errors:
    • ~\agent\logs\agent0.log.0
    • ~\agent\logs\wrapper.txt
    See Manage ECC Queue content for a MID Server to see how to open log entries from the instance.
  4. Confirm network connectivity.
  5. From the MID Server instance, navigate to the MID Servers page, and review the status of the MID Server. For additional information, click a Name.
  6. Use Windows or Linux tools to monitor:
    • CPU
    • Disk utilization
    • Events
    • Memory
    • syslog

What to do next

Set up email, SMS, and push notifications to alert you when issues occur with MID servers. The MID Server Down notification is enabled by default. See Notifications for details.