Register ArcGIS GeoEvent Server
You can register ArcGIS GeoEvent Server to collect system health and performance metrics.
Prerequisites for monitoring
To monitor GeoEvent Server, you need the following:
Install ArcGIS Monitor Agent on the GeoEvent Server machine and register it with ArcGIS Monitor Server.
The following versions of GeoEvent Server are supported for monitoring. The specific versions listed are the minimum certified versions. Newer minor versions are supported but are not certified unless otherwise stated.
ArcGIS GeoEvent Server 12.1
ArcGIS GeoEvent Server 12.0
ArcGIS GeoEvent Server 11.5
ArcGIS GeoEvent Server 11.3
ArcGIS GeoEvent Server 11.1
Use an ArcGIS Server primary site administrator account or an equivalent user account with an Administrator role type to register GeoEvent Server.
Use ArcGIS Server token-based security for authentication. Do not use other unsupported forms of authentication such as Integrated Windows Authentication (IWA) or Security Assertion Markup Language (SAML).
Register a GeoEvent Server component for monitoring
Your user account must have the Administrator or Manager role to register components.
To register an ArcGIS GeoEvent Server component, complete the following steps:
Access ArcGIS Monitor if necessary.
The Home page appears.
Click Monitoring.
The Monitoring page appears with registered components listed alphabetically by name.
Click Register component.
The Register component wizard appears.
Note:
If you don't have sufficient privileges, Register component is not available.
Choose the Monitor Agent machine where the component is installed, and click Next.
The Component type page appears.
Under ArcGIS, choose GeoEvent Server, and click Next.
The Component details page appears.
- Provide a name for the component in the Component name text box.
- Optionally, provide a description for the component in the Description text box.
Optionally, click Apply Labels
and choose the labels that you want to apply to the component.Tip:
Provide the name of a label in the Enter label name text box to search for a specific label. If the label doesn't exist, click Create new label to add the label and apply it to the component.
Click Next.
The Connection page appears.
Provide the credentials for GeoEvent Server in the Username and Password text boxes.
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 collect GeoEvent Server attribute and metric data:
|
Observer name |
Description |
|---|---|
|
Inventory - ArcGIS GeoEvent Server |
This observer scans for changes and manages attribute data and component relationships 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 GeoEvent Server are typically infrequent. |
|
Metrics - ArcGIS GeoEvent Server |
This 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 attribute that is 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 attribute that is 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 |
The agent's ability to successfully connect to the component. |
Float |
Percent |
|
Connectors |
The total number of GeoEvent Server connectors. |
Float |
Total |
|
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 |
|
Events Total Ratio |
The ratio of all sent to received events. Values approaching one indicate the rate of sent events is equal to that of received events. |
Float |
Total |
|
Events Rate Ratio |
The ratio of sent to received event rates. Values approaching one indicate the rate of sent events is equal to that of received events. |
Float |
Total |
|
Services |
The total number of GeoEvent Server services. |
Float |
Total |
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 rule that is configured for GeoEvent Server and its connectors and services:
|
Metric name |
Aggregation |
Operator |
Info threshold |
Warning threshold |
Critical threshold |
Samples |
|---|---|---|---|---|---|---|
|
Connectivity |
Average |
Is less than |
— |
— |
100 |
2 |
Note:
The default alert rule in the table above is the rule that is configured for components when Monitor is first deployed. If your Monitor administrator configured default alert rules for the Monitor deployment, the values for the rule above may vary.
Component relationships
The subsections below describe relationships that are automatically formed with registered ArcGIS GeoEvent Server components.
GeoEvent Server connector
The GeoEvent Server inventory observer detects GeoEvent Server connectors created by GeoEvent Server and forms individual relationships between the GeoEvent Server component and its connectors.
Note:
If the ArcGIS GeoEvent Server component is unregistered in ArcGIS Monitor, its connectors are also unregistered.
GeoEvent Server service
The GeoEvent Server inventory observer detects GeoEvent Server services created by GeoEvent Server and forms individual relationships between the GeoEvent Server component and its service.
Note:
If the ArcGIS GeoEvent Server component is unregistered in Monitor, its services are also unregistered.
Host
The host's inventory observer detects instances of GeoEvent Server running on the host machine and forms a relationship between the host component and the registered ArcGIS GeoEvent Server component.
ArcGIS Server
When you register GeoEvent Server with a monitored ArcGIS Server site, the ArcGIS Server inventory observer discovers and manages relationships between the ArcGIS Server site and the ArcGIS GeoEvent Server component.
Note:
If the ArcGIS GeoEvent Server component is unregistered in Monitor, the relationship between the ArcGIS Server site and the ArcGIS GeoEvent Server component is removed.