---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# MonitorMIDServer - Global

# MonitorMIDServer - Global {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read

The MonitorMIDServer script include provides methods to monitor MID Servers using the heartbeat probe to check for MID Servers that are down, sends heartbeat requests, and kills old heartbeat requests.

Use this script include in a server script to monitor MID Servers.

## MonitorMIDServer - MonitorMIDServer() {#ariaid-title2}

Creates an instance of MonitorMIDServer.
{#r_MNMS-MonitorMIDServer__table_ddf_y4m_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 1. Parameters]

{#r_MNMS-MonitorMIDServer__table_ddf_y4m_zt}

## MonitorMIDServer - killOldRequests() {#ariaid-title3}

If there are any heartbeat probe requests that haven't been processed, cancels them so
that they don't accumulate when a MID server is down for a while.
{#r_MNMS-killOldRequests__table_yhh_dqm_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 2. Parameters]

{#r_MNMS-killOldRequests__table_yhh_dqm_zt} {#r_MNMS-killOldRequests__table_zhh_dqm_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 3. Returns]

{#r_MNMS-killOldRequests__table_zhh_dqm_zt}  

    var mmsv = new MonitorMIDServer();
    mmsv.killOldRequests();

## MonitorMIDServer - markDowners() {#ariaid-title4}

Marks any non-responding MID servers as being down, by determining when the most recent
heartbeat was sent and finding all non-responding servers.
{#r_MNMS-markDowners__table_evf_4pm_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 4. Parameters]

{#r_MNMS-markDowners__table_evf_4pm_zt} {#r_MNMS-markDowners__table_fvf_4pm_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 5. Returns]

{#r_MNMS-markDowners__table_fvf_4pm_zt}  

    var mmsv = new MonitorMIDServer();
    mmsv.markDowners();

## MonitorMIDServer - monitor() {#ariaid-title5}

Performs the functions required for a scheduled MID server monitor cycle, including
killing old requests, marking the MID servers that are down, and sending heartbeat requests to
all servers.
{#r_MNMS-monitor__table_ygq_fpm_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 6. Parameters]

{#r_MNMS-monitor__table_ygq_fpm_zt} {#r_MNMS-monitor__table_zgq_fpm_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 7. Returns]

{#r_MNMS-monitor__table_zgq_fpm_zt}  

    var mmsv = new MonitorMIDServer();
    mmsv.monitor();

## MonitorMIDServer - sendHeartbeatRequests() {#ariaid-title6}

Sends heartbeat requests to all MID servers and notes when by updating the server
status record.
{#r_MNMS-sendHeartbeatRequests__table_yzn_vpm_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 8. Parameters]

{#r_MNMS-sendHeartbeatRequests__table_yzn_vpm_zt} {#r_MNMS-sendHeartbeatRequests__table_zzn_vpm_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 9. Returns]

{#r_MNMS-sendHeartbeatRequests__table_zzn_vpm_zt}  

    var mmsv = new MonitorMIDServer();
    mmsv.sendHeartbeatRequests();