Skip to main content

Register ArcGIS Velocity

You can register ArcGIS Velocity to collect attribute and performance metric data for a deployment and its feeds, real-time analytics, outputs, streams, and service processes.

Prerequisites for monitoring

To monitor Velocity, you need the following:

  • Install ArcGIS Monitor Agent on the machine where Velocity is installed and register it with ArcGIS Monitor Server.

  • ArcGIS Velocity 12.2 is supported for monitoring. This version is the minimum certified version. Newer minor versions are supported, but are not certified unless otherwise stated.

  • All six of the following Velocity services must be running. Monitor Agent checks for these services to discover Velocity and to distinguish it from other ArcGIS components, such as ArcGIS Server and Portal for ArcGIS, installed on the same machine. If any of the services are not running, Velocity will not be automatically discovered.

    • ArcGIS Velocity Enterprise Control Plane
    • ArcGIS Velocity Enterprise Feeds
    • ArcGIS Velocity Enterprise Gateway
    • ArcGIS Velocity Enterprise Metrics
    • ArcGIS Velocity Enterprise Real-Time Analytics
    • ArcGIS Velocity Enterprise Stream Server
    • ArcGISVelocityControlPlane
    • ArcGISVelocityFeed
    • ArcGISVelocityGateway
    • ArcGISVelocityMetrics
    • ArcGISVelocityRealtimeAnalytic
    • ArcGISVelocityStreamServer
  • You must use the primary site administrator (PSA) account in order to register Velocity for monitoring.

Discover ArcGIS Velocity

ArcGIS Monitor Agent discovers Velocity when all six services are running on the machine. The deployment then appears in the Discovered components list on the Monitoring page. Velocity is discovered separately from other ArcGIS components installed on the same machine.

You can register the discovered component or register it manually using the steps below.

Register an ArcGIS Velocity component for monitoring

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

To register a Velocity component, complete the following steps:

  1. Access ArcGIS Monitor if necessary.

    The Home page appears.

  2. Click Monitoring.

    The Monitoring page appears with registered components listed alphabetically by 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 Monitor Agent machine where Velocity is installed, and click Next.

    The Component type page appears.

  5. Under ArcGIS, choose ArcGIS Velocity, and click Next.

    The Component details page appears.

  6. Provide a name for the component in the Component name text box.
  7. Optionally, provide 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:

    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.

  9. Click Next.

    The Connection page appears.

  10. Provide the Velocity primary site administrator credentials in the Username and Password text boxes.

  11. Click Register component.

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

During registration, Monitor does the following:

  • Generates a token using the primary site administrator credentials.

  • Confirms that the account has the ADMINISTER privilege.

  • Confirms that the Velocity version is 12.2 or later.

  • Generates a unique system ID for the deployment from the names of its machines.

If any of these checks fail, an error message appears and the component is not registered.

Once the 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 Velocity attribute and metric data:

Observer name

Description

Inventory - ArcGIS Velocity

This observer scans for changes and manages attribute data and component relationships across Velocity and its feeds, real-time analytics, outputs, and streams.

The default interval for this observer is 15 minutes; however, you can configure it to run at longer intervals since changes to Velocity are typically infrequent.

Metrics - ArcGIS Velocity

This observer collects rate, error, CPU, and memory metric data for Velocity and its feeds, real-time analytics, outputs, streams, and service processes.

The default interval for this observer is 5 minutes; however, you can configure it to run at shorter intervals to retrieve data more frequently.

Collected attributes

The subsections below describe the attributes that are collected for Velocity and its feeds, real-time analytics, outputs, and streams.

ArcGIS Velocity attributes

The following table lists the attributes that are collected for ArcGIS Velocity:

Attribute name

Description

Data type

Address

The URL of the Velocity home page. The URL uses the machine's fully qualified domain name (FQDN) or, if the FQDN cannot be resolved, the machine's IP address.

String

License expiration

The earliest expiration date of the Velocity licenses.

Datetime

SSL certificate expiration

The earliest expiration date of the SSL certificates used by Velocity.

Datetime

System ID

The unique identifier of the Velocity deployment, generated from the names of the deployment's machines.

String

Version

The software version of Velocity.

String

Feed attributes

The following table lists the attributes that are collected for feeds:

Attribute name

Description

Data type

Address

The URL of the feed's details page in Velocity

String

Name

The name of the feed

String

Schedule type

The type of feed based on how it ingests data, either streaming or polling

String

State

The current state of the feed, either started or stopped

String

System ID

The unique identifier of the feed

String

Type - Subtype

The component type and subtype of the feed, either Feed - Streaming or Feed - Polling

String

Output attributes

The following table lists the attributes that are collected for outputs. Only outputs that write to an ArcGIS feature layer or stream layer are monitored.

Attribute name

Description

Data type

Address

The URL of the feature layer or stream layer service that the output writes to

String

Name

The name of the output

String

State

The current state of the real-time analytic that produces the output

String

System ID

The unique identifier of the output

String

Type - Subtype

The component type and subtype of the output, such as Output - Feature Layer or Output - Stream Layer

String

Real-time analytic attributes

The following table lists the attributes that are collected for real-time analytics:

Attribute name

Description

Data type

Address

The URL of the real-time analytic's details page in Velocity

String

Name

The name of the real-time analytic

String

State

The current state of the real-time analytic, such as started, stopped, initializing, pending, or failed

String

System ID

The unique identifier of the real-time analytic

String

Type - Subtype

The component type and subtype of the real-time analytic, which is Real-Time Analytic - Real-time

String

Stream attributes

The following table lists the attributes that are collected for streams. Streams are monitored as stream services.

Attribute name

Description

Data type

Address

The REST URL of the stream service

String

Name

The name of the stream

String

System ID

The unique identifier of the stream

String

Type - Subtype

The component type and subtype of the stream, which is Service - Stream Service

String

Collected metrics

The subsections below describe the metrics that are collected for Velocity and its feeds, real-time analytics, outputs, streams, and service processes.

ArcGIS Velocity metrics

Rate metrics are reported per second and are calculated from the change in ArcGIS Velocity counters between consecutive metric collections. Rates are reported as 0 for the first collection after Monitor Agent starts and for feeds, outputs, and streams that are stopped or have no activity.

The following table lists the metrics that are collected for ArcGIS Velocity. Aggregate rate metrics are the sums of the corresponding feed and output metrics.

Metric name

Description

Data type

Unit

Attribute Rate

The sum of the incoming and outgoing attribute rates

Float

Attributes/second

Attribute Rate In

The sum rate of attributes ingested across all feeds

Float

Attributes/second

Attribute Rate Out

The sum rate of attributes emitted across all outputs

Float

Attributes/second

Bytes Processed

The sum of the incoming and outgoing byte rates

Float

Bytes/second

Bytes Processed In

The sum rate of bytes ingested across all feeds

Float

Bytes/second

Bytes Processed Out

The sum rate of bytes emitted across all outputs

Float

Bytes/second

Connectivity

The agent's ability to successfully connect to the component

Float

Percent

CPU Utilized

The sum of the CPU utilization of the six ArcGIS Velocity service processes, as a percentage of the machine's total CPU capacity

Float

Percent

Error Rate

The sum rate of errors across all feeds

Float

Errors/second

Feature Rate

The sum of the incoming and outgoing feature rates

Float

Features/second

Feature Rate In

The sum rate of features ingested across all feeds

Float

Features/second

Feature Rate Out

The sum rate of features emitted across all outputs

Float

Features/second

Feeds Total

The total number of feeds, regardless of state

Float

Total

Memory Utilized

The sum of the memory utilization of the six ArcGIS Velocity service processes, as a percentage of the machine's total physical memory

Float

Percent

Outputs Total

The total number of outputs that write to an ArcGIS feature layer or stream layer, regardless of state

Float

Total

Real-time Analytics Total

The total number of real-time analytics, regardless of state

Float

Total

ArcGIS Velocity service process metrics

The following table lists the CPU and memory metrics that are collected for each ArcGIS Velocity service process. These metrics are reported on the ArcGIS Velocity component, and each metric name includes the service process name.

CPU and memory utilization are reported as a percentage of the machine's total CPU capacity and total physical memory. CPU utilization is reported as 0 for the first collection after Monitor Agent starts or after a service process restarts. If a service process is not running, no value is reported for its metrics.

Metric name

Description

Data type

Unit

CPU Utilized - control_plane

CPU utilization of the Control Plane service process

Float

Percent

CPU Utilized - feeds

CPU utilization of the Feeds service process

Float

Percent

CPU Utilized - gateway

CPU utilization of the Gateway service process

Float

Percent

CPU Utilized - metrics_service

CPU utilization of the Metrics Service process

Float

Percent

CPU Utilized - real_time_analytics

CPU utilization of the Real-Time Analytics service process

Float

Percent

CPU Utilized - stream_server

CPU utilization of the Stream Server service process

Float

Percent

Memory Utilized - control_plane

Memory utilization of the Control Plane service process

Float

Percent

Memory Utilized - feeds

Memory utilization of the Feeds service process

Float

Percent

Memory Utilized - gateway

Memory utilization of the Gateway service process

Float

Percent

Memory Utilized - metrics_service

Memory utilization of the Metrics Service process

Float

Percent

Memory Utilized - real_time_analytics

Memory utilization of the Real-Time Analytics service process

Float

Percent

Memory Utilized - stream_server

Memory utilization of the Stream Server service process

Float

Percent

Feed metrics

The following table lists the metrics that are collected for feeds:

Metric name

Description

Data type

Unit

Attribute Rate

The rate of attributes ingested by the feed per second, averaged over the collection interval

Float

Attributes/second

Bytes Processed

The rate of bytes ingested by the feed per second, averaged over the collection interval

Float

Bytes/second

Error Rate

The rate of errors reported by the feed

Float

Errors/second

Feature Rate

The rate of features ingested by the feed per second, averaged over the collection interval

Float

Features/second

Real-time analytic metrics

The following table lists the metrics that are collected for real-time analytics:

Metric name

Description

Data type

Unit

Attribute Rate In

The sum rate of attributes ingested across the analytic's feeds

Float

Attributes/second

Attribute Rate Out

The sum rate of attributes emitted across the analytic's outputs

Float

Attributes/second

Bytes Processed In

The sum rate of bytes ingested across the analytic's feeds

Float

Bytes/second

Bytes Processed Out

The sum rate of bytes emitted across the analytic's outputs

Float

Bytes/second

Feature Rate In

The sum rate of features ingested across the analytic's feeds

Float

Features/second

Feature Rate Out

The sum rate of features emitted across the analytic's outputs

Float

Features/second

Output metrics

The following table lists the metrics that are collected for outputs:

Metric name

Description

Data type

Unit

Attribute Rate

The rate of attributes emitted by the output per second, averaged over the collection interval

Float

Attributes/second

Bytes Processed

The rate of bytes emitted by the output per second, averaged over the collection interval

Float

Bytes/second

Feature Rate

The rate of features emitted by the output per second, averaged over the collection interval

Float

Features/second

Stream metrics

The following table lists the metrics that are collected for streams:

Metric name

Description

Data type

Unit

Connected Users

The number of users currently connected to the stream service

Float

Users

Request Rate

The rate of stream service requests

Float

Requests/second

Default alert rules

The following table lists the default alert rules that are configured for Velocity and its feeds and outputs:

Metric name

Aggregation

Operator

Info threshold

Warning threshold

Critical threshold

Samples

Connectivity

Average

Is less than

—

—

100

2

Attribute Rate

Average

Is greater than

—

—

—

2

Bytes Processed

Average

Is greater than

—

—

—

2

Feature Rate

Average

Is greater than

—

—

—

2

CPU Utilized

Average

Is greater than

—

75

90

3

CPU Utilized - <service_process>

Average

Is greater than

—

75

90

3

Memory Utilized

Average

Is greater than

—

75

90

3

Memory Utilized - <service_process>

Average

Is greater than

—

75

90

3

The CPU Utilized - <service_process> and Memory Utilized - <service_process> rules are configured for each of the six Velocity service process metrics, such as CPU Utilized - control_plane and Memory Utilized - feeds.

Alerting is enabled for the Attribute Rate, Bytes Processed, and Feature Rate metrics, but no thresholds are configured by default because expected throughput varies by deployment. No alerts are opened for these metrics until you provide info, warning, or critical thresholds that are appropriate for the deployment. The directional metrics, such as Feature Rate In and Feature Rate Out, do not have alerting enabled by default.

To customize the alert rules for the Velocity component, configure alert rules from the component's Metrics tab, or, on the component's Overview page, click More options on the Feature Rate, Attribute Rate, or Bytes Processed card and click Edit alert rules. You must be assigned the Administrator or Manager role to edit alert rules.

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 configured default alert rules for the Monitor deployment, the values for the rules may be different from the values listed in the table above.

Component relationships

The subsections below describe relationships that are automatically formed with registered Velocity components.

Feeds, real-time analytics, outputs, and streams

The Velocity inventory observer detects the feeds, real-time analytics, outputs, and streams in the Velocity deployment and forms individual relationships between the Velocity component and each subcomponent.

Only outputs that write to an ArcGIS feature layer or stream layer are monitored. Outputs that do not have an ArcGIS service URL, such as HTTP outputs, are not added as subcomponents.

Note:

If the Velocity component is unregistered in Monitor, its feeds, real-time analytics, outputs, and streams are also unregistered.

Real-time analytic feeds and outputs

The Velocity inventory observer forms relationships between each real-time analytic and the feeds it consumes and the outputs it produces. A feed can be related to more than one real-time analytic.

ArcGIS Server services

The Velocity inventory observer forms relationships between feeds and outputs and the ArcGIS Server services they use:

  • A feed that reads from an ArcGIS feature layer or stream layer is related to the source service.

  • An output that writes to an ArcGIS feature layer or stream layer is related to the destination service.

Relationships are only formed with services that are monitored by Monitor. If a feed's source or an output's destination changes, the relationship is updated during the next inventory scan.

Host

The host's inventory observer detects Velocity running on the host machine and forms a relationship between the host component and the registered Velocity component.

Portal for ArcGIS

When Velocity is federated with a monitored Portal for ArcGIS deployment, the portal inventory observer detects the federated Velocity deployment and forms a relationship between the Portal for ArcGIS component and the Velocity component.

Note:

If Velocity is unfederated from the portal, the relationship is removed, but monitoring of the Velocity component continues.