Skip To Content

Manage components

You can view and manage components from the Monitoring page and access a component's Overview, Metrics, Catalog, Logs, and Settings pages by clicking the name of a component. The Overview page provides information related to status, collected attributes, important metrics, and number of open alerts. The Metrics page provides a list of a component's metrics. The Catalog page is only available for select component types and provides a list of a component's related components and subcomponents. The Logs page is only available for select component types and allows you to view software logs to help troubleshoot problems with a component. The Settings page allows you to edit a component's settings and observers.

View component details

You can view component details and an overview of its metrics from the component's Overview page. To view component details, complete these steps:

  1. Access ArcGIS Monitor, if necessary.

    The Home page appears.

  2. Click Monitoring.

    The Monitoring page appears with a list of components and the following status icons:

    IconDescription

    Status: Nominal

    Indicates that there are no open alerts.

    Status: Info

    Indicates an open info alert that may require further investigation.

    Status: Warning

    Indicates an open warning alert that requires further investigation.

    Status: Critical

    Indicates an open critical alert that requires immediate investigation.

    Status: Unknown

    Indicates that alerting is turned off for a subcomponent's metric.

    Status: Error

    Indicates that the metric's observer failed to run.

    Note:

    The status of a component is inherited from its metrics and reflects the status of the metric with the most severe status.

  3. Optionally, click a component's status icon to display a pop-up with a list of metrics with open alerts.
    Tip:

    Click the name of an alert in the pop-up to view more information about the alert.

  4. Click the name of the component that you want to view.
    Tip:

    Click Sort to change the sorting method, click Filter to create a query to filter the list, click Hide to choose which columns to hide or show, click Labels to filter the list by the chosen labels, and click the categories at the side of the page to filter the list by the chosen category. You can also search for specific components by typing a keyword in the Search by component name or address text box.

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

  5. Optionally, click one of the predefined range buttons to constrain the metrics to the chosen time range, or use the date picker to define a custom time range.
  6. Optionally, click the More options button More options and click View metric details to view more information about a metric, including its alert rules.
  7. Optionally, click the Catalog tab to view a list of the component's related components and subcomponents.

    The Catalog tab is only available for component types that have related components and subcomponents.

View component metrics

You can view a complete list of metrics associated with a component from the component's Metrics page. To view a component's metrics, complete these steps:

  1. Access Monitor, if necessary.

    The Home page appears.

  2. Click Monitoring.

    The Monitoring page appears with a list of components sorted alphabetically by component name.

    Tip:

    Click Sort to change the sorting method, click Filter to create a query to filter the list, click Hide to choose which columns to hide or show, click Labels to filter the list by the chosen labels, and click the categories at the side of the page to filter the list by the chosen category. You can also search for specific components by typing a keyword in the Search by component name or address text box.

  3. Click the name of the component that contains the metrics you want to view.

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

  4. Click the Metrics tab.

    A list of the component's metrics appears with the following status icons:

    IconDescription

    Status: Nominal

    Indicates that there are no open alerts.

    Status: Info

    Indicates an open info alert that may require further investigation.

    Status: Warning

    Indicates an open warning alert that requires further investigation.

    Status: Critical

    Indicates an open critical alert that requires immediate investigation.

    Status: Unknown

    Indicates that alerting is turned off for the metric.

    Status: Error

    Indicates that the metric's observer failed to run.

  5. Optionally, click a metric's status icon to display a pop-up with a chart that shows the metric's most recent data values and alert information.
  6. Optionally, click the name of a metric to view more information about the metric, including its alert rules.
    Tip:

    Click Sort to change the sorting method, click Filter to create a query to filter the list, and click Hide to choose which columns to hide or show. You can also search for specific metrics by typing a keyword in the Search by metric name or address text box.

View component logs

Components with the Logs observer collect software log entries at regular intervals for display in Monitor. You can view these software logs to help troubleshoot problems with a component. To view software log entries for a component, complete these steps:

  1. Access Monitor, if necessary.

    The Home page appears.

  2. Click Monitoring.

    The Monitoring page appears with a list of components sorted alphabetically by component name.

    Tip:

    Click Sort to change the sorting method, click Filter to create a query to filter the list, click Hide to choose which columns to hide or show, click Labels to filter the list by the chosen labels, and click the categories at the side of the page to filter the list by the chosen category. You can also search for specific components by typing a keyword in the Search by component name or address text box.

  3. Click the name of the component that contains the logs you want to view.

    The component's Overview page appears.

  4. Click the Logs tab.
    Note:

    The Logs tab is only available for components with the Logs observer.

    A list of the component's software log entries appears and is sorted chronologically.

    Tip:

    Click Sort to change the sorting method, click Filter to create a query to filter the list, click Hide to choose which columns to hide or show, and click Refresh to refresh the list of log entries and show new log entries.

  5. Click View Details View Details next to the time of the log entry that you want to view.

    The Log Details dialog box appears with detailed information about the log entry.

Edit components

You can edit the name and description of components from the Monitoring page. You must be assigned the Administrator or Manager role to edit components. To edit the name and description of a component, complete these steps:

  1. Access Monitor, if necessary.

    The Home page appears.

  2. Click Monitoring.

    The Monitoring page appears with a list of components sorted alphabetically by component name.

    Tip:

    Click Sort to change the sorting method, click Filter to create a query to filter the list, click Hide to choose which columns to hide or show, click Labels to filter the list by the chosen labels, and click the categories at the side of the page to filter the list by the chosen category. You can also search for specific components by typing a keyword in the Search by component name or address text box.

  3. Click the More options button More options for the component you want to edit and click Edit in Settings.

    The component's Settings page appears.

  4. Click Edit next to Name on the Settings page.

    The Edit Component dialog box appears.

  5. Update the component's name and description as necessary in the Component Name and Description text boxes.
  6. Click Save.

    The component is updated.

Edit component connection information

You can edit a component's connection information from the Monitoring page. You must be assigned the Administrator or Manager role to edit component connection information. To edit the connection information of a component, complete these steps:

  1. Access Monitor, if necessary.

    The Home page appears.

  2. Click Monitoring.

    The Monitoring page appears with a list of components sorted alphabetically by component name.

    Tip:

    Click Sort to change the sorting method, click Filter to create a query to filter the list, click Hide to choose which columns to hide or show, click Labels to filter the list by the chosen labels, and click the categories at the side of the page to filter the list by the chosen category. You can also search for specific components by typing a keyword in the Search by component name or address text box.

  3. Click the More options button More options for the component you want to edit and click Edit in Settings.

    The component's Settings page appears.

  4. Click Edit next to Address on the Settings page.

    The Component Credentials dialog box appears.

  5. Update the component's connection information as necessary.
  6. Click Save.

    The component's connection information is updated.

Add a component to your favorites

You can add components that you want to closely monitor to your list of favorite items and instantly access them from the My Favorites page. To add a component to your favorites, complete these steps:

  1. Access Monitor, if necessary.

    The Home page appears.

  2. Click Monitoring.

    The Monitoring page appears with a list of components sorted alphabetically by component name.

    Tip:

    Click Sort to change the sorting method, click Filter to create a query to filter the list, click Hide to choose which columns to hide or show, click Labels to filter the list by the chosen labels, and click the categories at the side of the page to filter the list by the chosen category. You can also search for specific components by typing a keyword in the Search by component name or address text box.

  3. Click Add to Favorites Add to Favorites next to a component to add it to your favorites list.
    Tip:

    To remove a component from your favorites list, click Remove from Favorites Remove from Favorites.

Unregister components

You can unregister components from the Monitoring page. You must be assigned the Administrator or Manager role to unregister components. When a component is unregistered, all of its subcomponents are also unregistered, and no further metrics data is collected for the component or its subcomponents. To unregister a component, complete these steps:

  1. Access Monitor, if necessary.

    The Home page appears.

  2. Click Monitoring.

    The Monitoring page appears with a list of components sorted alphabetically by component name.

    Tip:

    Click Sort to change the sorting method, click Filter to create a query to filter the list, click Hide to choose which columns to hide or show, click Labels to filter the list by the chosen labels, and click the categories at the side of the page to filter the list by the chosen category. You can also search for specific components by typing a keyword in the Search by component name or address text box.

  3. Click the More options button More options for the component you want to unregister and click Unregister.

    A confirmation message appears.

    Caution:

    Unregistering a component is permanent and can't be undone.

  4. Click Unregister to unregister the component.

    The component is unregistered, all of its subcomponents are also unregistered, and no further metrics data is collected for the component or its subcomponents.

Related topics