Manage components

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

View component details

To view component details and an overview of its metrics on the component's Overview page, complete the following steps:

1. Access ArcGIS Monitor if necessary.

   The Home page appears.

2. Click Monitoring.

   The Monitoring page appears. Registered components are listed alphabetically by name with one of the following status indicators displayed next to each component name:

   Status	Icon	Description
   Incident active		There is an active incident and monitoring and alerting are paused.
   Monitoring off		One or more observers are turned off and monitoring is disabled.
   Alerting off		Alerting is turned off.
   No data		The observer failed to collect data.
   Nominal		No alerts are open.
   Info		There is an open info alert. This may require further investigation.
   Warning		There is an open warning alert. This requires further investigation.
   Critical		There is an open critical alert. This requires immediate investigation.

   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, 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 to filter the list by the labels that you choose.
   • Type a keyword in the Search by component name or address text box to search for specific components.
4. Optionally, click a component's status button 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.

5. Click the name of the component that you want to view.

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

6. Optionally, click the Filter by date drop-down arrow, choose a predefined time range or use the date picker to define a custom time range, and click Apply to constrain the metric data to the specified time range.
7. Optionally, click More options and click View details to view more information about a metric, including its alert rules.
8. Optionally, click the Catalog tab to view a list of the related components and subcomponents.

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

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 troubleshoot problems with a component.

To view software log entries for a component, complete the following steps:

1. Access Monitor if necessary.

   The Home page appears.

2. Click Monitoring.

   The Monitoring page appears. Registered components are listed alphabetically by name.

3. 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 Refresh to refresh the list of log entries and show new log entries.
   • Click Labels to filter the list by the labels that you choose.
   • Type a keyword in the Search by component name or address text box to search for specific components.
4. Click the name of the component that contains the logs you want to view.

   The component's Overview page appears.

5. 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.

6. 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.
   • Click Refresh to refresh the list of log entries and show new log entries.
7. Click View details next to the time of the log entry that you want to view.

   The View details dialog box appears with detailed information about the log entry.

Edit components

You can edit the name and description of components on 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 the following steps:

1. Access Monitor if necessary.

   The Home page appears.

2. Click Monitoring.

   The Monitoring page appears. Registered components are listed alphabetically by name.

3. 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 to filter the list by the labels that you choose.
   • Type a keyword in the Search by component name or address text box to search for specific components.
4. Click More options for the component you want to edit and click Edit in settings.

   The component's Settings page appears.

5. On the Settings page, in the Component details section, click Edit.

   The Component details dialog box appears.

6. Edit the name and description in the Component name and Description text boxes as necessary.
7. Click Save.

   The component is updated.

Edit component connection information

You can edit component connection information on the Monitoring page. You must be assigned the Administrator or Manager role to edit component connection information.

To edit component connection information, complete the following steps:

1. Access Monitor if necessary.

   The Home page appears.

2. Click Monitoring.

   The Monitoring page appears. Registered components are listed alphabetically by name.

3. 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 to filter the list by the labels that you choose.
   • Type a keyword in the Search by component name or address text box to search for specific components.
4. Click More options for the component you want to edit and click Edit in settings.

   The component's Settings page appears.

5. On the Settings page, in the Connection section, click Edit.

   The Connection dialog box appears.

6. Edit the component's connection information as necessary.
7. Click Save.

   The component's connection information is updated.

Add components to your favorites

You can add components that you want to closely monitor to your favorites and access them using the Favorites category filter on the Monitoring page.

To add a component to your favorites, complete the following steps:

1. Access Monitor if necessary.

   The Home page appears.

2. Click Monitoring.

   The Monitoring page appears. Registered components are listed alphabetically by name.

3. 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 to filter the list by the labels that you choose.
   • Type a keyword in the Search by component name or address text box to search for specific components.
4. Click 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 .

Unregister components

You can unregister ArcGIS and database components on 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.

Tip:

To unregister a host component, unregister the Monitor Agent installation on the host machine.

To unregister ArcGIS and database components, complete the following steps:

1. Access Monitor if necessary.

   The Home page appears.

2. Click Monitoring.

   The Monitoring page appears. Registered components are listed alphabetically by name.

3. 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 to change the sorting method.
   • Click Filter to create a query to filter the list.
   • Click Columns to 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 to filter the list by the labels that you choose.
   • Type a keyword in the Search by component name or address text box to search for specific components.
4. Click More options for the component that you want to unregister and click Unregister.

   A confirmation message appears.

   Caution:

   Unregistering a component is permanent. To restore monitoring for a component, it must be registered again.

5. 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.