ArcGIS Monitor Information Model

The ArcGIS Monitor Information Model supports the management of data necessary to monitor the system health, usage, and performance of an enterprise GIS implementation.

The following diagram shows the entity relationships in the information model:

The sections below list the tables and fields that compose the information model.

Agents

The Agents table includes the following fields:

Field name	Display name	Description	Nullable	Type
address	Address	The host name or IP address of the ArcGIS Monitor Agent machine.	False	String
created_at	Created at	The date and time the entity was created.	False	Datetime
description	Description	The long-form description of the Monitor Agent machine.	True	String
id	ID	The primary key.	False	Integer
is_connected	Connected	Specifies whether Monitor Agent is connected to Monitor Server.	False	Boolean
name	Name	The name of the Monitor Agent machine.	False	String
platform	Platform	The host operating system (OS) where Monitor Agent is installed.	False	String
version	Version	The software version of Monitor Agent.	False	String

Alerts

The Alerts table includes the following fields:

Field name	Display name	Description	Nullable	Type
aggregation	Aggregation	The mathematical function used to aggregate metric samples for comparison with the alert rule.	True	String
closed_at	Closed at	The date and time the alert was closed.	True	Datetime
component_address_internal	Component address internal	The common network address.	False	String
component_id	Component ID	The unique ID of the component associated with the alert.	False	Integer
component_name	Component name	The name of the component.	False	String
component_subtype	Component subtype	The secondary category used to categorize components.	True	String
component_type	Component type	The primary category used to categorize components.	False	String
created_at	Created at	The date and time the entity was created.	False	Datetime
critical_threshold	Critical threshold	The metric threshold value that results in the opening of a critical alert.	True	Float
duration	Duration	The number of minutes the alert was open.	False	Integer
id	ID	The primary key.	False	Integer
info_threshold	Info threshold	The metric threshold value that results in the opening of an info alert.	True	Float
metric_id	Metric ID	The unique ID of the metric associated with the alert.	False	Integer
metric_name	Metric name	The name of the metric.	True	String
metric_r_id	Metric registry ID	The namespace registry ID of the metric.	True	String
observer_id	Observer ID	The unique ID of the observer associated with the component that triggered the alert.	False	Integer
opened_at	Opened at	The date and time the alert was opened.	False	Datetime
operator	Operator	The mathematical operator used to compare the aggregated metric samples with the alert thresholds.	True	String
samples	Samples	The total number of consecutive historical metric samples used to determine the alert status.	True	Integer
state	State	The current state of the alert.	False	String
status	Status	The status of the alert when it was opened.	True	Integer
warning_threshold	Warning threshold	The metric threshold value that results in the opening of a warning alert.	True	Float

Analysis

The Analysis table includes the following fields:

Field name	Display name	Description	Nullable	Type
configuration	Configuration	The persisted configuration for an analysis view's visual elements.	False	Object
created_at	Created at	The date and time the entity was created.	False	Datetime
description	Description	The long-form description of the analysis view.	True	String
id	ID	The primary key.	False	Integer
name	Name	The name of the analysis view.	False	String
user_id	User ID	The ID of the user who created the analysis view.	True	Integer

Collections

The Collections table includes the following fields:

Field name	Display name	Description	Nullable	Type
created_at	Created at	The date and time the entity was created.	False	Datetime
description	Description	The long-form description of the collection.	True	String
id	ID	The primary key.	False	Integer
is_security_enabled	Security enabled	Specifies whether the collection's feature service requires a token.	False	Boolean
is_service_enabled	Service enabled	Specifies whether the collection's data is available through a feature service.	False	Boolean
name	Name	The name of the collection.	False	String
service_url	Service URL	The URL of the collection's feature service.	True	String
status	Status	The collection's current criticality as evaluated from its attached components.	True	Integer

Comments

The Comments table includes the following fields:

Field name	Display name	Description	Nullable	Type
alert_id	Alert ID	The unique ID of the related alert.	True	Integer
created_at	Created at	The date and time the entity was created.	False	Datetime
id	ID	The primary key.	False	Integer
incident_id	Incident ID	The unique ID of the related incident.	True	Integer
message	Message	The comment's message content.	False	String
type	Type	The comment's origin.	False	String
user_id	User ID	The ID of the user who created the comment.	False	Integer

Components

The Components table includes the following fields:

Field name	Display name	Description	Nullable	Type
address_internal	Internal address	The common network address.	False	String
agent_id	Agent ID	The ID of the agent to which the component is registered.	True	Integer
created_at	Created at	The date and time the entity was created.	False	Datetime
description	Description	The long-form description of the component.	True	String
id	ID	The primary key.	False	Integer
name	Name	The name of the component.	False	String
cert_expires_at	Cert expires at	The date and time the component's configured server certificate expires.	True	Datetime
class	Class	The system classification (virtual or physical).	True	String
cpu_cores_logical	CPU cores logical	The system's total number of logical CPU cores.	True	Float
cpu_cores_physical	CPU cores physical	The system's total number of physical CPU cores.	True	Integer
cpu_name	CPU name	The CPU manufacturer name and model information.	True	String
cpu_speed	CPU speed	The speed of the system's CPU.	True	Float
created_at	Created at	The date and time the entity was created in the component.	True	Datetime
gdb_version	GDB version	The ArcGIS software version of the geodatabase.	True	String
idle_time_max	Idle time max	The maximum time a service instance remains idle before shutting down.	True	Integer
instance_type	Instance type	The type of service instance (dedicated or shared).	True	String
instances_max	Instances max	The maximum number of allowed service instances.	True	Integer
instances_min	Instances min	The minimum number of allowed service instances.	True	Integer
instances_shared_max	Instances shared max	The service's maximum number of shared instances.	False	Integer
instances_shared_min	Instances shared min	The service's minimum number of shared instances.	False	Integer
is_service_cached	Is service cached	Specifies whether the service is cached.	True	Boolean
license_expires_at	License expires at	The date and time the component's software license expires.	True	Datetime
location	Location	The availability zone where the component is located.	True	String
memory_page_total	Memory page total	The total amount of page file memory.	True	Float
memory_total	Memory total	The total amount of system memory.	True	Float
network_speed	Network speed	The network adapter's negotiated network speed.	True	Float
started_at	Started at	The date and time the service was last started.	True	Datetime
storage_total	Storage total	The total amount of storage space of a storage subcomponent.	True	Float
version	Version	The current software version of the component.	True	String
wait_time_max	Wait time max	The maximum time a client will wait for the service to respond before it times out.	True	Integer
status	Status	The current criticality of the component as evaluated from its attached metrics.	True	Integer
strategy_r_id	Strategy registry ID	The component's monitoring strategy.	True	String
subtype	Subtype	The secondary category used to categorize components.	True	String
system_id	System ID	The ID used to uniquely identify the component within its monitoring scope.	True	String
type	Type	The primary category used to categorize components.	False	String
system_state	System state	The value of the entity's system state configuration.	True	String

Component logs

The Component logs table includes the following fields:

Field name	Display name	Description	Nullable	Type
code	Code	The log code associated with the log entry.	True	Integer
component_id	Component ID	The unique ID of the related component.	True	Integer
level	Level	The log level associated with the log entry.	True	String
logged_at	Logged at	The date and time the logged event occurred.	True	Datetime

Incidents

The Incidents table includes the following fields:

Field name	Display name	Description	Nullable	Type
created_at	Created at	The date and time the entity was created.	False	Datetime
description	Description	The long-form description of the incident.	True	String
id	ID	The primary key.	False	Integer
name	Name	The name of the incident.	False	String
state	State	The current state of the incident.	True	String

Labels

The Labels table includes the following fields:

Field name	Display name	Description	Nullable	Type
color	Color	The background color of the label.	True	String
created_at	Created at	The date and time the entity was created.	False	Datetime
description	Description	The long-form description of the label.	True	String
id	ID	The primary key.	False	Integer
name	Name	The name of the label.	False	String

Metrics

The Metrics table includes the following fields:

Field name	Display name	Description	Nullable	Type
aggregation	Aggregation	The mathematical function used to aggregate metric samples for comparison with the alert rule.	True	String
component_id	Component ID	The unique ID of the component associated with the metric.	True	Integer
created_at	Created at	The date and time the entity was created.	False	Datetime
critical_threshold	Critical threshold	The metric threshold value that results in the opening of a critical alert.	True	Float
description	Description	The long-form description of the metric.	True	String
id	ID	The primary key.	False	Integer
info_threshold	Info threshold	The metric threshold value that results in the opening of an info alert.	True	Float
is_alerting_enabled	Alerting enabled	Specifies whether alerts are created using status evaluation.	False	Boolean
name	Name	The name of the metric.	True	String
observer_id	Observer ID	The unique ID of the observer that recorded the metric.	True	Integer
operator	Operator	The mathematical operator used to compare the aggregated metric samples with the alert thresholds.	True	String
r_id	Registry ID	The namespace registry ID of the metric.	True	String
samples	Samples	The total number of consecutive historical metric samples used to determine the alert status.	True	Integer
status	Status	The current alert status of the metric.	True	Integer
warning_threshold	Warning threshold	The metric threshold value that results in the opening of a warning alert.	True	Float
agent_id	Agent ID	The ID of the ArcGIS Monitor Agent machine where the component is registered.	False	Integer
units	Units	The metric's unit of measure.	False	String

Metrics data

The Metrics data table includes the following fields:

Field name	Display name	Description	Nullable	Type
metric_id	Metric ID	The ID of the related metric.	True	Integer
observed_at	Observed at	The date and time the metric was measured.	True	Datetime
value	Value	The metric's measured value.	True	Float

Notifications

The Notifications table includes the following fields:

Field name	Display name	Description	Nullable	Type
collection_id	Collection ID	The unique ID of the collection by which notifications are scoped.	True	Integer
created_at	Created at	The date and time the entity was created.	False	Datetime
description	Description	The long-form description of the notification.	True	String
email_interval	Email interval	The number of minutes between email notifications.	True	Integer
id	ID	The primary key.	False	Integer
is_email_enabled	Email enabled	Specifies whether email notifications are enabled.	False	Boolean
is_webhook_enabled	Webhook enabled	Specifies whether webhooks are configured for the notification.	False	Boolean
name	Name	The name of the notification.	False	String
webhook_delivery_failures	Webhook delivery failures	The maximum number of retry attempts before the webhook fails.	False	Integer
webhook_delivery_on_empty	Webhook delivery on empty	Specifies whether delivery will occur on the interval, even if there were no captured events.	True	Boolean
webhook_delivery_reattempt_interval	Webhook delivery reattempt interval	The time between redelivery attempts when a delivery failure occurs.	False	Integer
webhook_delivery_timeout	Webhook delivery timeout	The maximum wait time for a response from the receiver.	False	Integer
webhook_secret	Webhook secret	The secret used by the receiver to verify the payload.	True	String
webhook_status	Webhook status	The current status of the webhook.	True	Integer
webhook_url	Webhook URL	The URL of the webhook receiver.	True	String

Observers

The Observers table includes the following fields:

Field name	Display name	Description	Nullable	Type
component_id	Component ID	The unique ID of the component associated with the observer.	True	Integer
created_at	Created at	The date and time the entity was created.	False	Datetime
description	Description	The long-form description of the observer.	True	String
id	ID	The primary key.	False	Integer
interval	Interval	The time between observer runs.	False	Integer
is_enabled	Enabled	Specifies whether the observer is enabled.	False	Boolean
r_id	Registry ID	The registry ID of the observer.	True	String
status	Current status	The current running health of the observer.	True	Integer
agent_id	Agent ID	The ID of the Monitor Agent machine where the component is registered.	False	Integer
name	Name	The name of the observer.	False	String
strategy_r_id	Strategy registry ID	The registry ID of the component's monitoring strategy.	False	String