Docs Menu
Docs Home
/ /
Atlas App Services
/

Monitor Edge Server

On this page

  • Before You Begin
  • Get Edge Server Instance Status
  • Edge Server Logs
  • Edge Server Metrics

You can view metrics and logs for your Edge Server instances to get a general health status, or information about usage, performance, and errors.

You can monitor an instance:

  • In the Atlas UI

  • In a UI on the local hardware

  • Through Admin API calls

You can also forward logs to a MongoDB collection or an external service.

This page contains details about how to view metrics and logs for your Edge Server instances, and what information is available.

You can get details about the status of Edge Server instance in a few ways:

  • View the Edge Server instance details in the Atlas UI

  • View the status details in the local UI

  • Use edgectl to check the status

  • Make a request to the relevant Admin API endpoint

The available details vary depending on how you access them.

Edge Server uses the following log types:

  • Authentication Logs: When an Edge Server instance attempts to authenticate with Atlas, or clients attempt to authenticate with an Edge Server instance, this generates an authentication log.

  • Device Sync Logs: When an Edge Server instance syncs with Atlas, or an Atlas Device SDK client syncs with Edge Server, this generates a Device Sync log.

You can access your logs with the Admin API's Admin API Retrieve App Services logs endpoint. Filter for the user_id matching the Edge Server instance user_id. Or you can view logs when viewing Edge Server Instance Details in the Atlas UI.

You can configure log forwarders to store logs in a MongoDB collection or send them to an external service. For more information, refer to Forward Logs to a Service.

An Edge Server instance tracks a variety of metrics about:

  • The host hardware

  • Requests

  • Wire Protocol connections, and their activity

  • Sync

You can access your metrics data with the Admin API's Admin API Get Edge Server information endpoint. Or you can view a subset of these metrics when viewing Edge Server Instance Details in the Atlas UI.

The exact metrics returned may be subject to change.

Metric key
Name
Category
Unit
Description
edge_host_memory_percent
Memory Usage
Host
Percent (%)
Percentage of memory used by the Edge Server containers.
edge_host_cpu_percent
CPU Usage
Host
Percent (%)
Percentage of CPU used by the Edge Server containers.
overall_request_success
Successful Requests
Overall
Int
The total number of successful requests.
overall_request_fail
Failed Requests
Overall
Int
The total number of failed requests.
wire_protocol_request_success
Successful Wire Protocol Requests
Wire Protocol
Int
The total number of successful Wire Protocol requests.
wire_protocol_request_fail
Failed Wire Protocol Requests
Wire Protocol
Int
The total number of failed Wire Protocol requests.
wire_protocol_egress_bytes
Wire Protocol Data Transfer
Wire Protocol
Bytes
The total number of bytes returned by Wire Protocol.
edge_wire_protocol_connection_count
Wire Protocol Connection Count
Wire Protocol
Int
The total number of clients currently connected using the Wire Protocol. These connections include MongoDB Drivers, MongoDB Shell, MongoDB Compass, and other tools that use the Wire Protocol connection.
sync_requests_success
Successful Sync Requests
Sync
Int
The total number of successful sync requests.
← Permissions Guide