Register ArcGIS GeoEvent Server

You can register ArcGIS GeoEvent Server to collect system health and performance metrics.

Prerequisites for monitoring

The following prerequisites are necessary for monitoring GeoEvent Server:

• GeoEvent Server must be running on ArcGIS Enterprise 10.6 or later.
• The ArcGIS Server primary site administrator or an equivalent user account that is assigned an administrator role type is required to register GeoEvent Server for monitoring.
• Authentication requires ArcGIS Server token-based security. Other forms of authentication such as Integrated Windows Authentication (IWA) and Security Assertion Markup Language (SAML) are not supported.
• The firewall must allow communication between GeoEvent Server and the ArcGIS Monitor machine where it will be registered on ports 6080 and 6180 for an HTTP connection or ports 6143 and 6443 for an HTTPS connection.

Register GeoEvent Server for monitoring

You must be assigned the Administrator or Manager role to register components.

1. Access ArcGIS Monitor, if necessary.

   The Home page appears.

2. Click Monitoring.

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

3. Click Register component.

   The Register component wizard appears.

   Note:

   If you don't have sufficient privileges, Register component is not available.

4. Choose the ArcGIS Monitor Server or ArcGIS Monitor Agent machine that has network access to the component that you want to register and click Next.

   The Component type page appears.

5. Under ArcGIS, choose GeoEvent Server and click Next.

   The Component details page appears.

6. Type a name for the component in the Component name text box.
7. Optionally, type a description for the component in the Description text box.
8. Optionally, click Apply Labels and choose the labels that you want to apply to the component.

   Tip:

   Type the name of a label in the Enter label name text box to search for a specific label. If the label that you want to add doesn't exist, type the name of the label that you want to create in the Enter label name text box and click Create new label to add the label and apply it to the component.

9. Click Next.

   The Connection page appears.

10. Type the public URL to the GeoEvent Server that you want to register in the Address text box.
11. Provide the credentials for GeoEvent Server in the Username and Password text boxes.
12. Click Register component.

    The component is added to the list of monitored components on the Monitoring page.

Once a component is registered, you can configure alert rules and add the component to collections.

Note:

Other component types, such as the enterprise GIS implementation's underlying hardware infrastructure and databases, must be registered individually to enable monitoring.

Observers

The following table describes the observers that are responsible for collecting GeoEvent Server attribute and metric data:

Observer name	Description
Discover	The Discover observer scans for changes and manages attribute data across GeoEvent Server. The default interval for this observer is 5 minutes; however, you can configure it to run at longer intervals since changes to the underlying site configuration are expected to be infrequent.
Metrics	The Metrics observer collects GeoEvent Server metric data. The default interval for this observer is 1 minute to retrieve data frequently. It is recommended that you do not run this observer at longer intervals.

Collected attributes

The subsections below describe the attributes that are collected for GeoEvent Server and its connectors and services.

GeoEvent Server attributes

The following table lists the attributes that are collected for GeoEvent Server:

Attribute name	Description	Data type
Version	The software version of GeoEvent Server	String

GeoEvent Server connector and service attributes

The following table lists the attributes that are collected for GeoEvent Server connectors and services:

Attribute name	Description	Data type
Configured state	The state of the GeoEvent Server connector or service	String

Collected metrics

The subsections below describe the metrics that are collected for GeoEvent Server and its connectors and services.

GeoEvent Server metrics

The following table lists the metrics that are collected for GeoEvent Server:

Metric name	Description	Data type	Unit
Connectivity - <Discover observer r_id>	The observer's ability to successfully connect to the component	Float	Percent
Connectivity - <Metrics observer r_id>	The observer's ability to successfully connect to the component	Float	Percent
Events Received	The total number of received events	Float	Total
Events Received Rate	The receive rate of received events	Float	Events/second
Events Sent	The total number of sent events	Float	Total
Events Sent Rate	The send rate of sent events	Float	Events/second

GeoEvent Server connector and service metrics

The following table lists the metrics that are collected for GeoEvent Server connectors and services:

Metric name	Description	Data type	Unit
Events Received	The total number of received events	Float	Total
Events Received Rate	The receive rate of received events	Float	Events/second
Events Sent	The total number of sent events	Float	Total
Events Sent Rate	The send rate of sent events	Float	Events/second

Default alert rules

The following table lists the default alert rules that are configured for GeoEvent Server and its connectors and services:

Metric name	Aggregation	Operator	Info threshold	Warning threshold	Critical threshold	Samples
Connectivity - <Discover observer r_id>	Average	Is less than	—	—	100	2
Connectivity - <Metrics observer r_id>	Average	Is less than	—	—	100	2

Note:

The default alert rules in the table above are the rules that are configured for components when Monitor is first deployed. If your Monitor administrator has configured default alert rules for the Monitor deployment, the values for the rules above may vary.