Skip To Content

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 high-level entity relationships in the information model:

ArcGIS Monitor Information Model entity relationship diagram

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

Agents

The Agents table includes the following fields:

Field nameDisplay nameDescriptionNullableType

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 nameDisplay nameDescriptionNullableType

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 nameDisplay nameDescriptionNullableType

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 nameDisplay nameDescriptionNullableType

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

expression

Expression

The query expression used to dynamically group components into a collection.

False

Object

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 status as evaluated from its attached components.

True

Integer

Comments

The Comments table includes the following fields:

Field nameDisplay nameDescriptionNullableType

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 nameDisplay nameDescriptionNullableType

address_internal

Internal address

The common network address.

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.

False

Datetime

description

Description

The long-form description of the component.

True

String

gdb_version

GDB version

The ArcGIS software version of the geodatabase.

True

String

id

ID

The primary key.

False

Integer

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

name

Name

The name of the component.

False

String

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

state

State

The current registration state of the component.

False

String

status

Status

The current status of the component as evaluated from its attached metrics.

True

Integer

storage_total

Storage total

The total amount of storage space of a storage subcomponent.

True

Float

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

system_state

System state

The value of the entity's system state configuration.

True

String

type

Type

The primary category used to categorize components.

False

String

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

Component logs

The Component logs table includes the following fields:

Field nameDisplay nameDescriptionNullableType

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

Dataviews

The Dataviews table includes the following fields:

Field nameDisplay nameDescriptionNullableType

created_at

Created at

The date and time the entity was created.

False

Datetime

created_by

Created by

The ID of the user who created the dataview.

True

Integer

description

Description

The long-form description of the dataview.

True

String

expression

Expression

The persisted configuration for a dataview query expression.

False

Object

id

ID

The primary key.

False

Integer

name

Name

The name of the dataview.

False

String

updated_by

Updated by

The ID of the user who updated the dataview

True

Integer

Incidents

The Incidents table includes the following fields:

Field nameDisplay nameDescriptionNullableType

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

occurrence

Occurrence

The occurrence configuration used to determine when an incident is active.

False

Object

state

State

The current state of the incident.

True

String

Labels

The Labels table includes the following fields:

Field nameDisplay nameDescriptionNullableType

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 nameDisplay nameDescriptionNullableType

aggregation

Aggregation

The mathematical function used to aggregate metric samples for comparison with the alert rule.

True

String

base_r_id

Base registry ID

The registry name of the metric that defines its core attributes.

False

String

component_id

Component ID

The unique ID of the component associated with the metric.

True

Integer

component_name

Component name

The name of the component.

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

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

units

Units

The metric's unit of measure.

False

String

warning_threshold

Warning threshold

The metric threshold value that results in the opening of a warning alert.

True

Float

Metrics data

The Metrics data table includes the following fields:

Field nameDisplay nameDescriptionNullableType

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 nameDisplay nameDescriptionNullableType

collection_id

Collection ID

The unique ID of the collection used to scope notifications.

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

events

Events

The configured events that cause a notification to be sent.

False

Object

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 webhook notifications are enabled.

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 no events were captured.

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 nameDisplay nameDescriptionNullableType

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

name

Name

The name of the observer.

False

String

r_id

Registry ID

The registry ID of the observer.

True

String

status

Current status

The current running health of the observer.

True

Integer

strategy_r_id

Strategy registry ID

The registry ID of the component's monitoring strategy.

False

String

Related topics