Monitor Edge Server - Preview

You need the following to manage Edge Servers in the Atlas UI:

• A MongoDB Atlas account with Project Owner permissions. To learn how to sign up for a free account, see Get Started with Atlas.

The local UI is enabled by default, and only requires a running Edge Server instance.

On an untrusted host, you can disable the local UI by running the following edgectl command:

edgectl config --disable-local-ui=true

You need the following to manage Edge Servers with the Admin API:

• A MongoDB Atlas account with Project Owner permissions. To learn how to sign up for a free account, see Get Started with Atlas.

• A MongoDB Atlas Admin API public/private key pair. The API key must have Project Owner permissions to work with App Services Admin API.

• Your App's internal ObjectId hex string and the Project ID of the Atlas Project that contains your App. To learn how to find these, see Get App Metadata.

The Edge Server dashboard lists a brief summary for each Edge Server instance, including the date and time of the last connection, and a snapshot of its status. You can optionally view details or logs for each instance.

To view the Edge Server dashboard, choose Edge Server in the left navigation sidebar.

To view the details for a specific Edge Server instance, click View Details for that Edge Server instance. Alternately, click App Logs to browse logs associated with the instance.

The information available when viewing an Edge Server instance varies depending on the instance state. For details, refer to Edge Server Instance Details.

To access the local UI, open a web browser and go to localhost on the http-port. You can access the local UI on the default port at: http://localhost:80

You can change the port by providing an alternative port as an Int with the following edgectl flag:

edgectl config --http-port=<YOUR-PORT-INT>

When the Edge Server instance is running, you can see the status of the instance with:

edgectl status

This gives you information about the state of the Edge Server containers, and a detailed status for the Sync server with a breakdown of important information. It may look similar to:

{
   "mongoContainerStatus": {
      "message": "running"
   },
   "mongoDBStatus": {
      "message": "ready"
   },
   "syncServerContainerStatus": {
      "message": "running"
   },
   "syncServerStatus": {
      "message": "ACTIVE"
   },
   "syncServerDetailedStatus": {
      "version": "v0.22.3",
      "status": "ACTIVE",
      "cloud_connected": true,
      "num_local_clients": 0,
      "query": {
         "Item": "truepredicate"
      }
   }
}

The syncServerDetailedStatus contains information about the state of the Edge Server instance. This includes details about its connection to Atlas, and the clients connected to it, as follows: