The pool configuration provides a way to tune the setting used to setup the connection pooling associated with various for other configuration items. For example a Data Source and ArcGIS Server Map Engine.
The pool tag itself is not used as a top level configuration item but is instead embedded within other tags.
...
- maxActive controls the maximum number of objects that can be borrowed from the pool at one time. When non-positive, there is no limit to the number of objects that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted. If 'whenExhaustedAction' is 'grow' this value is not used.
- maxIdle controls the maximum number of objects that can sit idle in the pool at any time. When negative, there is no limit to the number of objects that may be idle at one time.
- whenExhaustedAction specifies the behavior when the pool is exhausted:
- When whenExhaustedAction is 'fail', pool will throw an Exception.
- When whenExhaustedAction is 'grow', pool will create a new object and return it, essentially making maxActive meaningless.
- When whenExhaustedAction is 'block', pool will block. If a positive maxWait value is supplied, the pool will block for at most that many milliseconds, after which an Exception will be thrown. If maxWait is non-positive, the server method will block indefinitely. You should always set a positive maxWait value if you use 'block'.
- When testOnBorrow is set, the pool will attempt to validate each object before it is returned from the pool. Objects that fail to validate will be dropped from the pool, and a different object will be borrowed.
- When testOnReturn is set, the pool will attempt to validate each object before it is returned to the pool. Objects that fail to validate will be dropped from the pool.
Optionally, one may configure the pool to examine and possibly evict objects as they sit idle in the pool. This is performed by an "idle object eviction" thread, which runs asychronously. The idle object eviction thread may be configured using the following attributes: - timeBetweenEvictionRunsMillis indicates how long the eviction thread should sleep before "runs" of examining idle objects. When non-positive, no eviction thread will be launched.
- minEvictableIdleTimeMillis specifies the minimum amount of time that an object may sit idle in the pool before it is eligible for eviction due to idle time. When non-positive, no object will be dropped from the pool due to idle time alone.
- testWhileIdle indicates whether or not idle objects should be validated. Objects that fail to validate will be dropped from the pool.
- maxAgeMillis is only available for ArcGIS map engine pools and specifies how log Weave should keep and connection to the server open for, it should be less than the "The maximum time a client can use a service" setting in ArcGIS Server. ArcGIS Server Settings - Pooling and Processes
When Weave makes a request to map engine or database it needs to establish a connection to the resource and creating a connection each time Weave needs to make an interaction with the resource will cause a delay and use additional memory as the number of connections increases, to mitigate this Weave uses an object ‘pool’ where each request shares a pre-allocated connection object with other requests.
Using a pre-allocated collection of resource connections provides two benefits to Weave, firstly it means that the overhead of creating a new connection on each request is removed, resulting in better response times for the user.
And, secondly, it means that Weave can use less resources on the backend server by limiting the total number of connections that can be allocated at once, so for example if 50 requests are being processed at the same time then without connection pooling Weave would need to create 50 connections to the backend resource, but with a connection pool that's limited to a maximum of 10 connections then only 10 connections will be created to the backend service. The downside of this is that user requests will have to wait until a connection becomes available in the pool before it can proceed.
Determining the correct setting for a connection pool is not something that can be easily done without knowledge about how the backend service is configured and possibly other information about the general IT infrastructure.
Namespace
urn:com.cohga.server.pool#1.0
...
Name | Type | Required | Default | Description |
maxActive | number | no | 8 | The maximum number of objects that can be borrowed from the pool at one time. The cap on the total number of active instances from my pool. Use a negative value for an infinite number of instances. |
maxIdle | number | no | 8 | The maximum number of idle connections in the pool. The cap on the number of "idle" instances in the pool. Use a negative value to indicate an unlimited number of idle instances. |
maxWait | number | no | 1000 | The maximum amount of time to wait, in milliseconds, for an object when the pool is exhausted an and whenExhaustedAction is 'block' (otherwise ignored). |
minEvictableIdleTimeMillis | number | no | 1800000 | The minimum number of milliseconds an connection can sit idle in the pool before it is eligible for eviction. Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any). When non-positive, no objects will be evicted from the pool due to idle time alone. |
minIdle | number | no | 0 | The minimum number of idle connections in the pool. Sets the minimum number of objects allowed in the pool before the evictor thread (if active) spawns new objects. (Note no objects are created when: numActive + numIdle >= maxActive). |
numTestsPerEvictionRun | number | no | 3 | The number of idle objects to examine per run within the idle object eviction thread (if any). Sets the max number of objects to examine during each run of the idle object evictor thread (if any). When a negative value is supplied, ceil(numIdle)/abs(numTestsPerEvictionRun) tests will be run. I.e., when the value is -n, roughly one nth of the idle objects will be tested per run. |
softMinEvictableIdleTimeMillis | number | no | -1 | The minimum number of milliseconds an connection can sit idle in the pool before it is eligible for eviction with the extra condition that at least "minIdle" amount of connections remain in the pool. Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any), with the extra condition that at least "minIdle" amount of object remain in the pool. When non-positive, no objects will be evicted from the pool due to idle time alone. |
testOnBorrow | boolean | no | false | Should the connection be checked for validity when being borrowed from the pool. When true, objects will be validated before being returned to the pool. If the object fails to validate, it will be dropped from the pool, and we will attempt to borrow another. |
testOnReturn | boolean | no | false | Should the connection be checked for validity when being returned to the pool. When true, objects will be validated before being returned to the pool. |
testWhileIdle | boolean | no | false | Should the connection be checked for validity when just sitting in the pool. When true, objects will be validated by the idle object evictor (if any). If an object fails to validate, it will be dropped from the pool. |
timeBetweenEvictionRunsMillis | number | no | -1 | Sets the number of milliseconds to sleep between runs of the idle connection evictor. Sets the number of milliseconds to sleep between runs of the idle object evictor thread. When non-positive, no idle object evictor thread will be run. |
whenExhaustedAction | 'fail', 'grow' or 'block' | no | block | Sets the action to take when the pool is exhausted (the maximum number of "active" objects has been reached) |
| lifo | boolean | no | false | "last in first out" if true then the last connection used should be the next one allocated from the pool, or if false then the oldest connection will be the next one given out. Prior to Weave 2.5.21 this setting was not available and defaulted to true. |
Sub-tags
None
Content
None
Examples
...