Skip To Content

Manage Monitor Agent machines

You can view and manage ArcGIS Monitor Agent machines from the Agents tab on the Monitoring page and access a Monitor Agent machine's Overview, Catalog, Metrics, Observers, and Settings pages by clicking the name of a Monitor Agent machine.

View Monitor Agent details

You can view details about a Monitor Agent machine, its associated components and their metrics, and its associated observers. You must be assigned the Administrator or Manager role to view Monitor Agent details and components.

To view a Monitor Agent machine's details and a list of its components, complete the following steps:

  1. Access ArcGIS Monitor if necessary.

    The Home page appears.

  2. Click the Monitoring tab.

    The Monitoring page appears with registered components listed alphabetically by name.

  3. Click the Agents tab.

    The Agents page appears with one of the following status indicators displayed next to the name of each Monitor Agent machine:

    StatusIconDescription

    Connected

    Status: Connected

    Monitor Agent is connected to Monitor Server.

    Disconnected

    Status: Disconnected

    Monitor Agent is not connected to Monitor Server.

  4. Optionally, do any or all of the following:
    • Click Sort and change the sorting method.
    • Click Filter and create a query to filter the list.
    • Click Columns and specify the columns to hide or show.
    • Position the pointer at the edge of a column's header and drag the column's edge to resize it.
    • Type a keyword in the Search by agent name text box to search for specific Monitor Agent machines.
  5. Click the name of the Monitor Agent machine you want to view.

    The Monitor Agent machine's Overview page appears with its details and an overview of its component's metrics.

  6. Click the Catalog tab.

    The agent's Catalog page appears with a list of components sorted alphabetically by name.

    Learn more about managing components

  7. Optionally, do any or all of the following:
    • Click a category on the side of the page to filter the list by that category.
    • Click Sort and change the sorting method.
    • Click Filter and create a query to filter the list.
    • Click Columns and specify the columns to hide or show.
    • Position the pointer at the edge of a column's header and drag the column's edge to resize it.
    • Click Labels and filter the list by the specified labels.
    • Type a keyword in the Search by component name or address text box to search for specific components.
  8. Click the Metrics tab.

    A list of the component's metrics appears with the following status indicators displayed next to each metric:

    StatusIconDescription

    Incident active

    Status: Incident active

    There is an active incident and monitoring and alerting are paused.

    Monitoring off

    Status: Monitoring off

    One or more observers are turned off and monitoring is disabled.

    Alerting off

    Status: Alerting off

    Alerting is turned off.

    No data

    Status: No data

    The observer failed to collect data.

    Nominal

    Status: Nominal

    No alerts are open.

    Info

    Status: Info

    There is an open info alert.

    This may require further investigation.

    Warning

    Status: Warning

    There is an open warning alert.

    This requires further investigation.

    Critical

    Status: Critical

    There is an open critical alert.

    This requires immediate investigation.

  9. Optionally, do any or all of the following:
    • Click Sort and change the sorting method.
    • Click Filter and create a query to filter the list.
    • Click Columns and specify the columns to hide or show.
    • Position the pointer at the edge of a column's header and drag the column's edge to resize it.
    • Type a keyword in the Search by metric name text box to search for specific metrics.
  10. Click the Observers tab.

    The Observers page appears with a list of observers sorted by name.

  11. Optionally, do any or all of the following:
    • Click Sort and change the sorting method.
    • Click Filter and create a query to filter the list.
    • Click Columns and specify the columns to hide or show.
    • Position the pointer at the edge of a column's header and drag the column's edge to resize it.

Edit Monitor Agent settings

To edit Monitor Agent settings, such as its name and description, complete the following steps:

  1. Access Monitor if necessary.

    The Home page appears.

  2. Click the Monitoring tab.

    The Monitoring page appears with registered components listed alphabetically by name.

  3. Click the Agents tab.

    The Agents page appears with a list of Monitor Agent machines.

  4. Optionally, do any or all of the following:
    • Click Sort and change the sorting method.
    • Click Filter and create a query to filter the list.
    • Click Columns and specify the columns to hide or show.
    • Position the pointer at the edge of a column's header and drag the column's edge to resize it.
    • Type a keyword in the Search by agent name text box to search for specific Monitor Agent machines.
  5. Click More options More options for the Monitor Agent machine with the settings that you want to edit, and click Edit in settings.

    The Settings page appears.

  6. In the Agent details section, click Edit.

    The Agent details dialog box appears.

  7. Update the name and description of the Monitor Agent machine in the Name and Description text boxes as necessary.
  8. Click Save.

    The name and description of the Monitor Agent machine are updated.

Disconnect a Monitor Agent connection

To reconnect a Monitor Agent connection or transfer its responsibilities to another machine, you must disconnect it from ArcGIS Monitor Server. Once it is disconnected, you can register it as an existing Monitor Agent machine.

To disconnect a Monitor Agent connection, complete the following steps:

  1. Open a command prompt window on the Monitor Agent machine.
  2. Run the command below, editing the parameters where necessary, and note the agent ID.

    <Monitor Agent installation location>\bin\arcgis-monitor-agent.exe admin:system:info

    The following is an example:

    C:\Program Files\ArcGIS\Monitor\Agent\bin\arcgis-monitor-agent.exe admin:system:info

    Note:

    The agent ID is required when registering a Monitor Agent installation as an existing agent.

  3. Run the command below, editing the parameters where necessary, to disconnect the Monitor Agent machine from Monitor Server.

    <Monitor Agent installation location>\bin\arcgis-monitor-agent.exe admin:system:disconnect --confirm

    The following is an example:

    C:\Program Files\ArcGIS\Monitor\Agent\bin\arcgis-monitor-agent.exe admin:system:disconnect --confirm

    A confirmation message appears, indicating that Monitor Agent is disconnected from Monitor Server.

You can reconnect Monitor Agent to Monitor Server or transfer its responsibilities to another machine by registering it as an existing Monitor Agent machine.

Unregister Monitor Agent

You can unregister Monitor Agent to completely remove it from your Monitor deployment. All registered components associated with Monitor Agent, including their subcomponents, attributes, metrics, observers, and alerts, are deleted.

Caution:

Unregistering Monitor Agent is permanent and cannot be undone.

To unregister Monitor Agent, complete the following steps:

  1. Access Monitor if necessary.

    The Home page appears.

  2. Click the Monitoring tab.

    The Monitoring page appears with registered components listed alphabetically by name.

  3. Click the Agents tab.

    The Agents page appears with a list of Monitor Agent machines.

  4. Optionally, do any or all of the following:
    • Click Sort and change the sorting method.
    • Click Filter and create a query to filter the list.
    • Click Columns and specify the columns to hide or show.
    • Position the pointer at the edge of a column's header and drag the column's edge to resize it.
    • Type a keyword in the Search by agent name text box to search for specific Monitor Agent machines.
  5. Click More options More options for the Monitor Agent machine that you want to unregister and click Unregister.

    A confirmation message appears.

  6. Click Unregister to unregister the Monitor Agent machine.

    The Monitor Agent machine is unregistered and all of its associated components, including their subcomponents, attributes, metrics, observers, and alerts, are deleted.

Related topics