ArcGIS Server allows you to use either shared instances or dedicated instances for each compatible map service published to an ArcGIS Server site from ArcGIS Pro. Using shared instances conserves memory usage by pooling several active server processes for use by multiple services. By doing so, it reduces the memory usage of services that are not actively handling requests.
Legacy:
Prior to 10.7, all services used the model now called dedicated instances.
Shared instances are recommended for services that receive infrequent requests, particularly when the server site hosts many services. Dedicated instances, on the other hand, make a service always available to handle requests using one or more server processes and are ideal to use for services that receive constant or particularly compute-intensive requests.
This topic explains service instances and processes, describes best practices for shared and dedicated instances, and provides steps to set up your service instance settings.
Introduction to service instances
When a request is made to a service in your ArcGIS Server site, such as to pan a map or navigate to an address, it is handled by an instance of the published service running on a server machine. Service instances are powered by Esri proprietary server processes called ArcSOC processes. Each ArcSOC process takes a certain amount of your machine's memory to run.
If you have many services on your ArcGIS Server site, and each uses one or more service instances that are always running, your available computer memory could eventually reach its limit. There is also an energy cost for your organization to run service instances, and if you deploy ArcGIS Server on cloud infrastructure, there is a direct monetary cost to each service instance you are running.
Accordingly, it's important for ArcGIS Server administrators to monitor the number of instances their site is running, and to limit running instances when performance is inhibited by memory usage.
Users expect quick results when they interact with your services (including products built atop services, such as web maps and apps). Adequate ArcSOC processes are required to handle the traffic your services receive. However, provisioning more server resources than a service needs wastes computer memory, energy, and money. A good goal for administrators is to pare down the number of running service instances to as many as are needed without affecting performance.
To learn more about active management strategies to optimize ArcGIS Server performance, see Anticipate and accommodate users.
Note:
You can inspect ArcSOC processes in your environment to detect which ArcSOCs are running for each server-based service on your ArcGIS Server machine.
You can open your task manager and enable the command line option. The command line parameter will have the service name associated with any ArcSOC process.
Minimum and maximum service instances
For each service published to your ArcGIS Server site that uses dedicated instances, you can specify a minimum number of dedicated instances running, and a maximum number of instances that can run for the service using ArcGIS Server Manager. For example, if you set this parameter to three instances, there will always be at least three instances running on ArcSOC processes at any given time, even when the service is not being used.
If you set the minimum number of instances to zero, the service will not have any instances running if it is not being used. This saves memory usage by powering down an unused service, but there's a drawback: The next time a user sends a request to the service, they will experience a delayed response. This cold start while ArcGIS Server powers up an instance to handle the service request may be noticeable to the user making the request.
Shared and dedicated instances
A shared instance pool runs on each machine in your site when services are configured to use it. Services that use the shared instance pool no longer incur resource usage costs when they are not handling requests, and there is no cold start drawback.
Tip:
To determine which application a map service has been published from, see step 3 in Configure the instance type for a service below.
The following restrictions limit what services can use the shared instance pool:
- Only map services published from ArcGIS Pro can be configured to use the shared instance pool. Other service types, such as geoprocessing services, are not supported.
- Only certain capabilities of map services—feature access, WFS, WMS, and KML—can be enabled. Turn off all other capabilities before continuing.
- Cached map services published from ArcGIS Pro that meet the above requirements can use shared instances.
Legacy:
Prior to 10.8.1, services with server object extensions (SOEs) or server object interceptors (SOIs) could not use the shared instance pool.
Shared instances are distinct from dedicated instances, which only run a specific service until they are powered down. Dedicated instances are still a valid option for administrators, particularly with high-traffic services. This is both to ensure optimal performance for these services by providing dedicated server resources for them and to prevent high-traffic services from using all the processes in your pool.
Note:
When you upgrade ArcGIS Server to 11.3 from 10.6.1 or earlier, your minimum instances settings for services will not change, but a default pool of ArcSOC processes will be set aside for shared instances. If you want to configure shared instances for some or all of your services, you can do so after upgrading.
When to use each instance type
Neither instance type is uniformly best for all of your map services. As a server site administrator, you can decide which instance pool each service published to your site should use.
You can configure shared instances for some of your services while choosing to give other services their own dedicated ArcSOC processes. You might choose this split configuration if you know some of your services receive continuous requests, while others are used less frequently. If all your services receive requests only occasionally, consider configuring shared instances for all services to conserve memory usage.
Tip:
Usage patterns often change, so as you monitor your site, adjust the instance type settings as you see fit, based on traffic and server performance.
The shared instance pool is suitable for compatible map services such as these:
- Services that are infrequently used. This will vary by deployment, but for most deployments, this means fewer than one service request per minute on average.
- Services for which you have already set the minimum dedicated instances to zero.
- Most cached map services.
By contrast, the dedicated instance pool remains the best option for services such as these:
- Services you contract under a service-level agreement.
- Services that receive heavy use (nearly constant requests or compute-extensive requests).
- Services for which you have set the minimum dedicated instances to a high number.
- All services that are not compatible with the shared instance pool, as defined above.
Configure the shared instance pool
Administrators can configure settings for the shared instance pool in their site using Server Manager. The available settings are the number of shared instances per machine and the cache size per shared instance.
The first time a new installation of ArcGIS Server 11.3 hosts a compatible map service that uses the shared instance pool, the site starts running shared instances. By default, the number of shared instances in the pool is set to an appropriate number based on the number of physical CPU cores on each machine.
If most or all of your site's services use the shared instance pool, consider setting the number of service instances in the shared pool to twice the number of physical CPU cores on the individual machines in your ArcGIS Server site (for example, if you're using 4-core machines, consider setting the pool size to eight instances).
Note:
If you are using hyperthreading, vCPUs, or logical cores (such as if your site is in a virtual or cloud environment), consider each logical core equal to one-half of a physical core.
In server sites where many services use dedicated instances, if you want more system resources to be allotted to those services, you can consider decreasing the size of the shared instance pool. The number of shared instances in the pool should not be less than the number of physical CPU cores on your machine, unless no services are using the pool. If no services in your site are using shared instances, you can set the number of instances per machine to zero.
Each instance in the shared pool caches information about the services that have received requests because caching this information improves the performance of subsequent requests for those same services. Each service that is cached takes up a small amount of memory.
The cache size setting controls how many services are cached by each instance in the shared instance pool. Unless you have a large amount of memory and a large number of services that are all regularly receiving requests, it's recommended that you keep the default value of 50 cached services per instance.
You may consider raising the cache size value if you have more than 50 services that are regularly receiving requests, you are experiencing performance problems, and you have available memory you wish to use for this purpose.
These suggestions are meant as starting points. Monitor your ArcGIS Server site to ensure that you make the most of your available resources and to ensure the site is not overloaded by traffic. The optimal number of instances in the pool and the optimal cache size for the instances depend on the amount of traffic serviced by the shared pool, the amount and type of data being served, and the amount of available computing resources.
Follow these steps to specify the number of instances in the shared instance pool and their cache size.
- Sign in to ArcGIS Server Manager as an administrator. The URL is formatted https://webadaptor.domain.com/arcgis/manager.
- Browse to Site > Settings. You can access these settings from the Pooling page.
- Click the edit button for Shared Instance Settings.
- On the dialog box, change the values for Number of shared instances per machine or Cache size per shared instance as desired.
- Confirm your selection by clicking Apply.
Modify the schema lock setting
For some organizations that operate under strict service level agreements (SLAs), schema changes must be made while still allowing the map service to remain accessible. To minimize the amount of time that a map service is not running, you can disable schema locking for the map service, which will allow you to modify the referenced dataset's schema without stopping the map service.
Consider the following before disabling schema locking:
- When schema locking is disabled, it is recommended that you only update a schema when a service is idle. If you update a schema when a service is under load, users of the map service can experience unexpected behavior, such as missing layers and fields, failing queries, and unavailable services.
- Changing the schema locking setting requires you to restart the service. Additionally, for changes to be reflected if you disable schema locking for the service, you must either restart the map service after schema changes that alter the definition of existing fields are completed or overwrite the map service if you added or deleted a field.
- Disabling schema locking will do so for all services running shared instances.
Complete the following steps to allow schema edits while a map service is running:
- Sign in to ArcGIS Server Manager.
- Click Site > Settings > Pooling.
- Click Edit to edit the Shared Instance Settings.
- Click Parameters.
- Uncheck Lock Database Schema.
Note:
Lock database schema for shared instances will be checked by default.
- Click Apply.
Configure default service instance settings
Administrators can specify a default instance type setting for compatible map services published from ArcGIS Pro. When such a service is published to your server, it uses the default instance type. You can then change the instance type for the individual service using the steps in the next section.
The initial setting of the default instance type of your ArcGIS Server 11.3 site depends on whether the site was newly installed or upgraded:
- New ArcGIS Server sites created at 11.3 assign all compatible map services to the shared instance pool as the default instance setting.
- ArcGIS Server sites upgraded from 10.7 or 10.7.1 keep their current default instance setting. The initial setting at these versions was dedicated instances, with the option to use shared instances.
- In ArcGIS Server sites upgraded from 10.6.1 or earlier, the initial setting of the default instance type is dedicated instances. The shared instance pool will be created the first time you configure a compatible map service to use shared instances.
If you select shared instances to be the default instance type for your services, the setting only applies to compatible map services. Services that cannot use the shared instance pool continue to use their dedicated instance pool.
Changing the default instance type setting only affects services published in the future. It does not change the instance type settings for existing services.
Note:
The shared instance pool consumes a small amount of memory based on the number of services that receive requests. For a shared instance pool that handles requests for a large number of services, you will see memory rise gradually as more services receive requests. This increase in memory consumption levels off after 50 or more services have received requests within a single recycle period.
Follow these steps to specify the default instance type for compatible map services.
- Sign in to ArcGIS Server Manager as an administrator. The URL is formatted https://webadaptor.domain.com/arcgis/manager.
- Browse to Site > Settings. You'll access these settings from the Pooling page.
- To change the default instance type for compatible map services, click the edit button for Default Instance Type. Select the instance type you want to have be the default setting:
- Select Dedicated instances if you anticipate that most of your services will receive frequent traffic or if you will not have enough services running in your server site to present a significant load on machine memory.
- Select Shared instances if you publish many services that only receive infrequent requests or if you are concerned about additional services being published that will strain your memory resources.
- Confirm your selection by clicking Apply.
Configure the instance type for a service
Administrators can also specify the instance type for an individual service after it has been published, overriding the default setting. Follow these steps to change the instance type for an individual service. To use the shared instance pool, a map service must have been published from ArcGIS Pro and meet the other requirements as given above.
- Share a web layer (as a map image layer) or a web map from ArcGIS Pro to your ArcGIS Enterprise portal. A map service is created on your federated ArcGIS Server.
Note:
Only certain capabilities of map services—feature access, WFS, WMS, and KML—can be enabled on a map service that uses the shared instance pool.
- Sign in to ArcGIS Server Manager as an administrator. The URL is formatted https://webadaptor.domain.com/arcgis/manager.
- Locate the map service.
- Click Edit Service.
- On the left side of the page, click the Pooling tab.
This tab allows you to specify the range of dedicated instances for the services (if applicable), set service timeout properties, and designate whether the service uses dedicated instances or shared instances.
- Specify whether the service should use the Shared instance pool or its own Dedicated instance pool.
- When a service is configured to use the shared instance pool, some map service capabilities (on the Capabilities tab) will be unavailable. If you are unable to select the Shared instance pool option, ensure that you do not have any unsupported capabilities enabled on the map service. See the note in step 1.
- When a service is configured to use the shared instance pool, the Specify Number of Instances section (for dedicated instance pools) becomes unavailable.
- When you are ready, click Save and restart. When the instance pool option has been changed on a map service, the service must restart.
You can change the instance pool used by a map service at any time; you may need to do so when service traffic patterns change.