Skip To Content

Collection feature service schema

ArcGIS Monitor collections allow you to serve feature service tables over the internet or your intranet. This allows you to make collection data available for use in other ArcGIS applications, such as ArcGIS Dashboards. The following sections list the tables available in the collection feature service.

Hosts

The Hosts table contains attributes for all host components within a collection.

NameDescriptionNullableType

address

The network address of the host

False

String

class

The underlying classification and size of the host, if applicable

True

String

cpu_cores_logical

The CPU's total number of logical cores as reported by the host component's operating system (OS)

True

Float

cpu_cores_physical

The CPU's total number of physical cores as reported by the host component's OS

True

Integer

cpu_name

The CPU's vendor and type as reported by the host component's OS

True

String

cpu_speed

The CPU speed as reported by the host component's OS

True

Float

description

The long-form description of the host component

True

String

location

The host component's cloud region, if applicable

True

String

memory_total

The total amount of physical memory as reported by the host component's OS

True

Float

memory_page_total

The total pagefile or swap memory resources available

True

Float

name

The name of the host component

False

String

network_speed

The negotiated network speed as reported by the host component's OS

True

Float

started_at

The last boot time recorded by the host component's OS

True

Datetime

status

The current alert status of the host component

False

Integer

subtype

The host component's OS type (Windows or Linux)

False

String

version

The host component's OS version

True

String

Databases

The Databases table contains attributes for all database and geodatabase components in a collection.

NameDescriptionNullableType

address

The network address of the database component

False

String

description

The long-form description of the database component

True

String

gdb_version

The underlying geodatabase schema version of the database component, if applicable

True

String

memory_total

The total amount of physical memory allocated as reported by the database software

True

Float

name

The name of the database component

False

String

started_at

The last start time recorded by the database software

True

Datetime

status

The current alert status of the database component

False

Integer

subtype

The general database vendor classification (PostgreSQL, Oracle, or SQL Server)

False

String

version

The database component's database software version

True

String

ArcGIS Portals

The ArcGIS Portals table contains attributes for all Portal for ArcGIS components in a collection.

NameDescriptionNullableType

address

The network address of the Portal for ArcGIS component

False

String

cert_expires_at

The expiration date and time of the configured SSL certificate for Portal

True

Datetime

description

The long-form description of the Portal for ArcGIS component

True

String

license_expires_at

The most recent expiration date and time across all configured Portal licenses

True

Datetime

name

The name of the Portal for ArcGIS component

False

String

started_at

The last start time recorded by Portal

True

Datetime

status

The current alert status of the Portal for ArcGIS component

False

Integer

version

The Portal for ArcGIS component's software version

True

String

ArcGIS Servers

The ArcGIS Servers table contains attributes for all ArcGIS Server components in a collection.

NameDescriptionNullableType

address

The network address of ArcGIS Server

False

String

cert_expires_at

The expiration date and time of the configured SSL certificate for ArcGIS Server

True

Datetime

description

The long-form description of the ArcGIS Server component

True

String

instances_shared_max

The configured maximum shared instance pool for ArcGIS Server, if applicable

True

Integer

instances_shared_min

The configured minimum shared instance pool for ArcGIS Server, if applicable

True

Integer

license_expires_at

The most recent expiration date and time across all configured ArcGIS Server licenses

True

Datetime

name

The name of ArcGIS Server component

False

String

started_at

The last start time recorded by ArcGIS Server

True

Datetime

status

The current alert status of the ArcGIS Server component

False

Integer

version

The ArcGIS Server software version

True

String

Services

The Services table contains attributes for GIS services from all ArcGIS Server components in a collection.

NameDescriptionNullableType

address

The network address of the service

False

String

idle_time_max

The service's configured SOC idle timeout, if applicable

True

Integer

instance_type

The underlying service provider (shared, dedicated, or hosted)

True

String

instances_max

The service's configured maximum SOC instances, if applicable

True

Integer

instances_min

The service's configured minimum SOC instances, if applicable

True

Integer

is_service_cached

Specifies whether the service is a map or a vector cache

True

Boolean

name

The name of the service

False

String

status

The current alert status of the service

False

Integer

subtype

The general service classification (map, geoprocessing, and so on)

False

String

system_state

The configured state of the service (stopped or running)

True

String

wait_time_max

The service's configured SOC wait timeout, if applicable

True

Integer

Metrics

The Metrics table contains attributes for metrics that are associated with components in a collection.

NameDescriptionNullableType

aggregation

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

True

String

component_id

The unique ID of the component associated with the metric

False

Integer

component_name

The name of the component associated with the metric

False

String

critical_threshold

The metric threshold value that results in a critical alert being opened

True

Float

description

The long-form description of the metric

True

String

info_threshold

The metric threshold value that results in an info alert being opened

True

Float

is_alerting_enabled

Specifies whether the metric is configured to alert

False

Boolean

name

The name of the metric

False

String

observer_id

The unique ID of the observer that recorded the metric

False

Integer

operator

The mathematical operator used to compare the aggregated metric samples with the alert thresholds

True

String

r_id

The namespaced reference ID of the metric

False

String

samples

The total number of consecutive historical metric samples used to determine the alert status

True

Integer

status

The current alert status of the metric

False

Integer

unit

The unit of measure used to describe the metric, if applicable

True

String

warning_threshold

The metric threshold value that results in a warning alert being opened

True

Float

Alerts

The Alerts table contains attributes for alerts that are associated with components in a collection.

NameDescriptionNullableType

aggregation

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

True

String

closed_at

The date and time the alert was closed

True

Datetime

component_address

The IP address, host name, or URL of the component associated with the alert

False

String

component_id

The unique ID of the component associated with the alert

False

Integer

component_name

The name of the component associated with the alert

False

String

component_subtype

The subtype of component associated with the alert

False

String

component_type

The type of component associated with the alert

False

String

critical_threshold

The metric threshold value that results in a critical alert being opened

True

Float

duration

The alert's duration in minutes

False

Integer

info_threshold

The metric threshold value that results in an info alert being opened

True

Float

metric_id

The unique ID of the metric associated with the alert

False

Integer

metric_name

The name of the metric associated with the alert

False

String

metric_r_id

The reference ID of the metric associated with the alert

False

String

observer_id

The unique ID of the observer associated with the component that triggered the alert

False

Integer

opened_at

The date and time the alert was first opened

False

Datetime

operator

The mathematical operator used to compare the aggregated metric samples against the alert thresholds

True

String

samples

The total number of consecutive historical metric samples used to determine the alert's status

True

Integer

state

The current state of the alert

False

String

status

The status of the alert when it was opened

False

Integer

warning_threshold

The metric threshold value that results in a warning alert being opened

True

Float

Connectors

The Connectors table contains attributes for connector components in a collection.

NameDescriptionNullableType

address

The network address of the service

False

String

name

The name of the service

False

String

status

The current alert status of the service

False

Integer

Storage

The Storage table contains attributes for storage components in a collection.

NameDescriptionNullableType

address

The network address of the service

False

String

name

The name of the service

False

String

status

The current alert status of the service

False

Integer

storage_total

The total amount of storage space

False

Float

Related topics