Page History
Format
All properties can be passed either as a environment variable or as a JVM parameter. The "." and "_" characters can be replaced with each other.
| Code Block | ||||
|---|---|---|---|---|
| ||||
SET aspire_.noSql_.elastic_.server=http://localhost:9200 //Setting a property as a environment variable java -Daspire.noSql.elastic.server=http://localhost:9200 //Passing a property like JVM parameter |
Elasticsearch NoSQL Provider
Bellow are the list of properties to configure the Elasticsearch NoSQL Provider
| Warning |
|---|
In the case of environment variables, property name should always use "_" instead of "." |
Memory settings
In Linux based systems, the memory usage can be changed with the following environment variables
Parameter | Required | ParameterDefault | Description | |
|---|---|---|---|---|
aspire.noSqlmax.elastic heap.server | http://localhost:9200 | (Required) The elasticsearch server url to use. It can be multiple urls separated by "," | ||
| aspire.noSql.elastic.authentication.basic | false | (Optional) Enables elasticsearch basic authentication | ||
| aspire.noSql.elastic.user | null | (Optional) The elasticsearch user to use for basic authentication | ||
| aspire.noSql.elastic.password | null | (Optional) The elasticsearch password to use for basic authentication | ||
memory | no | 2g | Maximum Heap the JVM will request and use from the host system | |
aspire.max.metaspace.size | no | 256m | Maximum metaspace the JVM will request and use from the host system. |
In windows-based systems, if using the aspire.bat file, the memory usage should be changed in the aspire.bat itself. Otherwise, if it is running as a Windows Service:
- Browse to
HKEY_LOCAL_MACHINE / SOFTWARE / WOW6432Node / Apache Software / Procrun2.0/ AspireService / Parameters / Java
- Modify JvmMs and JvmMx to what you need (in bytes), and then restart the service.
Elasticsearch NoSQL Provider
Below are the list of properties to configure the Elasticsearch NoSQL Provider
| Parameter | Required | Default | New & Available from | Description | |||||
|---|---|---|---|---|---|---|---|---|---|
| aspire.noSql.elastic.authentication.aws | false | (Optional) Enables elasticsearch AWS authentication | |||||||
| aspire.noSql.elastic.authentication.useCredentialsProviderChain | false | (Optional) Option to use the AWS credentials provider chain to get the credentials||||||||
| aspire.noSql.elastic. | aws.access.keynull | (Optional) AWS access key for authenticationserver | yes | http://localhost:9200 | The Elasticsearch server URL to use. It can be multiple URLs separated by "," | ||||
| aspire.noSql.elastic. | aws.secret.keynull | (Optional) AWS secret key forauthentication.basic | no | false | Enables Elasticsearch basic authentication | ||||
| aspire.noSql.elastic. | aws.regionuser | no | null | (Optional) The AWS regionThe Elasticsearch user to use for basic authentication | |||||
| aspire.noSql.elastic. | keepSearchContextAlivepassword | no | 5mnull | (Optional) The amount of time to keep elasticsearch scrolls requests search context alive using "m" as a unitThe Elasticsearch password to use for basic authentication | |||||
| aspire.noSql.elastic.authentication. | maxRequestSizeaws | 104857600B | (Optional) The maximum size for a bulk request. The value can be specified in B, K, M and G unitsno | false | Enables Elasticsearch AWS authentication | ||||
| aspire.noSql.elastic. | maxConnections100 | (Optional) The maximum amount of connections to mantain open. | aspire.noSql.elastic.maxConnectionsPerRoute | 10 | (Optional) The maximum amount of connections per serverauthentication.useCredentialsProviderChain | no | false | Option to use the AWS credentials provider chain to get the credentials | |
| aspire.noSql.elastic.aws. | maxRetriesassumeRole | 3 | (Optional) The amount of times to retry each request | aspire.noSql.elastic.retriesWaitTime | 5000 | (Optional) The time to wait in ms between retriesno | false | 5.0.3 | If a role must be assumed to access Elasticsearch. Must be true/false |
| aspire.noSql.elastic. | useThrottlingfalse | (Optional) Enables requests throttling to elasticsearchaws.roleArn | no | null | 5.0.3 | The Role ARN to be assumed. | |||
| aspire.noSql.elastic | .throttlingRate5000 | (Optional) The throttling rate in ms.aws.access.key | no | null | AWS access key for authentication | ||||
| aspire.noSql.elastic. | throttlingConnectionRate500 | (Optional) The maximum amount of requests allowed in the period specified by the throttlingRateaws.secret.key | no | null | AWS secret key for authentication | ||||
| aspire.noSql.elastic.aws. | waitTime429region | no | 3000null | (Optional) The time to wait in ms before retrying a 429 errorThe AWS region | |||||
| aspire.noSql.elastic. | bulkkeepSearchContextAlive | no | true | (Optional) Enables using bulk for requests5m | The amount of time to keep Elasticsearch scrolls requests search context alive using "m" as a unit | ||||
| aspire.noSql.elastic. | bulkSizemaxRequestSize | no | 50010485760B | (Optional)The maximum | number of documents to include in a bulk requestsize for a bulk request. The value can be specified in B, K, M and G units | ||||
| aspire.noSql.elastic. | bulkInactivityTimeoutmaxConnections | no | 5100 | (Optional) The inactivity in s before flushing a bulk requestThe maximum number of connections to keep open. | |||||
| aspire.noSql.elastic. | bulkRegularTimeoutmaxConnectionsPerRoute | no | 3010 | (Optional)The maximum | amount of time in s for a bulk request to be kept in memory before flushingnumber of connections per server | ||||
aspire.noSql.elastic. | debugFilereadTimeout | no | null30000 | (Optional) The path to the debug file, request to ES are logged in this fileThe socket timeout. | |||||
| aspire.noSql.elastic. | mappingFileconnectionTimeout | no | null15000 | (Optional) The file path (including file name) that includes the mapping for the indexes used by Aspire. By default mapping included in the provider is usedThe connection timeout. | |||||
| aspire.noSql.elastic | .index.prefixaspire | (Optional) The prefix to use for the indexes created by the provider |
SSL Certificates
Bellow are the list of properties to configure the SSL Certificates
Security and encryption
Bellow are the list of properties related to the Aspire security and encryption
| .maxRetries | no | 3 | The number of times to retry each request | |
| aspire.noSql.elastic.retriesWaitTime | no | 5000 | The time to wait in ms between retries | |
| aspire.noSql.elastic.useThrottling | no | false | Enables requests throttling to Elasticsearch | |
| aspire.noSql.elastic.throttlingRate | no | 5000 | The throttling rate in ms | |
| aspire.noSql.elastic.throttlingConnectionRate | no | 500 | The maximum number of requests allowed in the period specified by the throttlingRate | |
| aspire.noSql.elastic.waitTime429 | no | 3000 | The time to wait in ms before retrying a 429 error | |
| aspire.noSql.elastic.bulk | no | true | Enables using bulk for requests | |
| aspire.noSql.elastic.bulkSize | no | 500 | The maximum number of documents to include in a bulk request | |
| aspire.noSql.elastic.bulkInactivityTimeout | no | 5 | The inactivity in s before flushing a bulk request | |
| aspire.noSql.elastic.bulkRegularTimeout | no | 30 | The maximum amount of time in s for a bulk request to be kept in memory before flushing | |
| aspire.noSql.elastic.debugFile | no | null | The path to the debug file, request to ES are logged in this file | |
| aspire.noSql.elastic.mappingFile | no | null | The file path (including file name) that includes the mapping for the indexes used by Aspire. By default, the mapping included in the provider is used | |
| aspire.noSql.elastic.index.prefix | no | aspire | The prefix to use for the indexes created by the provider | |
| aspire.noSql.elastic.debug | no | false | Enables debug logging information | |
| aspire.noSql.elastic.usePooling | no | true | Enables HTTP connection pooling | |
| aspire.nosql.elastic.timeSeriesType | no | index | 5.0.3, 5.3 (Opensearch) | Enables rollover possibility for audit, error, log time series index. Value "index" - default without rollover, Value "dataStream" - rollover based on data stream. Value "dataStreamOpensearch" - rollover based on Opensearch data stream. |
| aspire.nosql.elastic.ilmPolicyFile | no | default provider policy file | 5.0.3 | The file path (including file name) that includes the ilm policy file for the indexes used by Aspire. Used only for the time series option "dataStream*". |
| aspire.nosql.elastic.indexTemplateFile | no | default provider template file | 5.0.3 | The file path (including file name) that includes the template file for the indexes used by Aspire. Used only for the time series option "dataStream*". |
Index Sharding and Replicas settings
Each index sharding and replicas settings can be changed by using a custom mappingFile and configuring the aspire.noSql.elastic.mappingFile property.
Since 5.0.1, when using the default mapping settings, you can use the following prefix parameter:
- aspire.noSql.elastic.index.shards.[indexName]
- Should hold an integer specifying the number of shards for the given index
- aspire.noSql.elastic.index.replicas.[indexName]
- Should hold an integer specifying the number of replicas for the given index
If none of these properties are specified, the default replicas and shard number of the cluster will be used (usually 1 shard and 1 replica).
The different index names available are:
audit
base
errors
hierarchy
log
map
queue
retryLog
set
settings
snapshot
updateQueue
identityCache
SSL Certificates
Bellow are the list of properties to configure the SSL Certificates
| Parameter | Required | Default | Description |
|---|---|---|---|
| aspire.ssl.trustAll | no | false | Configure if all certificates should be trusted |
| aspire.ssl.overwriteFactory | no | false | Configure if the created key managers should overwrite the Java connection factory |
| aspire.ssl.truststore.file | no | null | The path of the trust store file |
| aspire.ssl.truststore.password | no | null | The trust store file password |
| aspire.ssl.truststore.type | no | jks | The file format of the trust store file |
| aspire.ssl.keystore.file | no | null | The path of the key store file |
| aspire.ssl.keystore.password | no | null | The key store file password |
| aspire.ssl.keystore.type | no | jks | The file format of the key store file |
Security and encryption
Below are the list of properties related to the Aspire security and encryption
| Parameter | Required | Default | Description |
|---|---|---|---|
| aspire.ldap.bind.dn.password | no | null | The password of the User DN. Not required if the authentication is anonymous |
| aspire.security.api.auditing | no | true | It audits the Aspire API calls. It is available from Aspire 5.1 and on. |
Encryption
When a password/secret/token in a configuration must be persisted, Aspire encrypts it and stores it encrypted. The default encryption mechanism is AES 256 given a local key. AWS KMS encryption can be used instead as of version 5.0.3
Standard AES 256 Encryption with local key
| Parameter | Required | Default | Description |
|---|---|---|---|
| aspire.encryption.key.file | no | null | (Optional) Path (including file name) where the encryption key is located, if not provided a default in-memory key will be used, for production installations it must be always provided. This can also be passed as a JVM parameter or as an environment variable, aspire_encryption_key_file. This should be a 32 byte file, if longer, the first 32 bytes will be used as the encryption key. Grant read access to the Aspire user only (chmod 400 <file>) This file could be generated randomly
|
AWS KMS Encryption
Available since Aspire 5.0.3, Uses AWS Key Management Service (KMS) to encrypt the sensitive data. It uses a key in KMS to encrypt and decrypt data. See more details about this encryption provider at Aspire KMS encryption
| Parameter | Required | Default | Description |
|---|---|---|---|
| aspire.encryption.kms.roleARN | no | null | (Optional) If the KMS service must be accessed through the assumption of an IAM role, specify the role ARN. |
| aspire.encryption.kms.keyARN | yes | N/A | The KMS key ARN. See Aspire KMS encryption for more information about creating a KMS key for Aspire. |
| aspire.encryption.kms.region | yes | N/A | The AWS region on which the KMS service will be used |
| aspire.encryption.kms.accessKey | no | null | (Optional) Specify the access key if static credentials must be used. If this is not specified, the Default Credential Provider Chain will be used. |
| aspire.encryption.kms.secretKey | no | null | (Optional) Specify the secret key if static credentials must be used. If this is not specified, the Default Credential Provider Chain will be used. |
Worker Node
These properties will be used by all worker nodes in the cluster.
| Parameter | Required | Default | Description |
|---|---|---|---|
| aspire.node.worker.maxMemQueueSize | yes | 4000 | The maximum number of items to keep in the in-memory queue |
| aspire.node.worker.queueSizeThreshold | yes | 0.5 | The capacity threshold of the in memory queue before requesting more items to the managers |
| aspire.node.worker.cleanUpWaitTime | yes | 300000 | The wait time in ms for the thread that checks the connectors clean up threshold |
| aspire.node.worker.cleanUpThreshold | yes | 3600000 | The time in ms for a connector to be idle before being removed from memory |
| aspire.node.worker.maxEnqueueRetries | yes | 5 | The number of retries to enqueue an item into the framework pipeline |
| aspire.node.worker.workflow.appCleanUpWaitTime | yes | 60000 | The wait time in ms for the thread that checks the workflow application's clean-up threshold |
| aspire.node.worker.workflow.appCleanUpThreshold | yes | 3600000 | The time in ms for a workflow application to be idle before being removed from memory |
| aspire.node.worker.tags | no | The tags of the worker node. These tags will determine which items this node can process. It should be a comma separated list of tags. | |
| aspire.node.worker.entryProcessorBaseSleep | yes | 10 | The base sleep time in ms for the thread in charge of queuing received items into the connector framework pipelines |
| aspire.node.worker.entryProcessorMaxSleep | yes | 2000 | The maximum sleep in ms for the thread in charge of queuing received items into the connector framework pipelines |
| aspire.node.worker.entryProcessorMaxIterations | yes | 5 | The number of iterations without queuing items before in increasing the sleep time |
| aspire.node.worker.entryProcessorMultiplier | yes | 1.25 | The multiplier used to increase the sleep time after the specified iterations without queuing items |
| aspire.node.worker.batchLoaderBaseSleep | yes | 10 | The base sleep time in ms for the thread in charge of requesting batches to the manager nodes |
| aspire.node.worker.batchLoaderMaxSleep | yes | 2000 | The maximum sleep in ms for the thread in charge of requesting batches to the manager nodes |
| aspire.node.worker.batchLoaderMaxIterations | yes | 5 | The number of iterations without receiving batches from the managers nodes before in increasing the sleep time |
| aspire.node.worker.batchLoaderMultiplier | yes | 1.25 | The multiplier used to increase the sleep time after the specified iterations without receiving batches from the managers nodes |
| aspire.node.worker.connectionTimeout | yes | 20000 | The connection timeout for requests to other aspire nodes |
| aspire.node.worker.socketTimeout | yes | 20000 | The socket timeout for requests to other aspire nodes |
| aspire.node.worker.maxRetries | yes | 3 | The number of retries for requests to other aspire nodes |
| aspire.node.worker.proxyHost | no | null | The proxy host to use for requests to other aspire nodes |
| aspire.node.worker.proxyPort | no | 0 | The proxy port to use for requests to other aspire nodes. Must be provided if the proxyHost is configured |
| aspire.node.worker.proxyUser | no | null | The proxy user to use for requests to other aspire nodes |
| aspire.node.worker.proxyPassword | no | null | The proxy password to use for requests to other aspire nodes. |
| aspire.node.worker.pingFrequency | yes | 15000 | The frequency for the node to ping to Elasticsearch. The pings are used to determine if a node is alive and working properly |
| aspire.node.worker.nodeFailureTimeout | yes | 30000 | The ping timeout used to determine if a node is not working. The node will be marked as failed in this case and the node eventually will shut down itself |
Manager Node
These properties will be used by all manager nodes in the cluster.
| Parameter | Required | Default | Description |
|---|---|---|---|
| aspire.node.manager.scanBatchCreatorBaseSleep | yes | 30 | The base sleep time in ms for the thread in charge of creating batches from the scan queue |
| aspire.node.manager.scanBatchCreatorMaxSleep | yes | 2000 | The maximum sleep in ms for the thread in charge of creating batches from the scan queue |
| aspire.node.manager.scanBatchCreatorMaxIterations | yes | 10 | The number of iterations without creating new scan batches before in increasing the sleep time |
| aspire.node.manager.scanBatchCreatorMultiplier | yes | 1.25 | The multiplier used to increase the sleep time after the specified iterations without creating new scan batches |
| aspire.node.manager.processBatchCreatorBaseSleep | yes | 30 | The base sleep time in ms for the thread in charge of creating batches from the process queue |
| aspire.node.manager.processBatchCreatorMaxSleep | yes | 2000 | The maximum sleep in ms for the thread in charge of creating batches from the process queue |
| aspire.node.manager.processBatchCreatorMaxIterations | yes | 10 | The number of iterations without creating new process batches before in increasing the sleep time |
| aspire.node.manager.processBatchCreatorMultiplier | yes | 1.25 | The multiplier used to increase the sleep time after the specified iterations without creating new process batches |
| aspire.node.manager.crawlProgressManagerBaseSleep | yes | 100 | The base sleep time in ms for the thread in charge of monitoring active crawls |
| aspire.node.manager.schedulerBaseSleep | yes | 10000 |
Worker Node
These properties will be used by all worker nodes in the cluster.
Manager Node
These properties will be used by all manager nodes in the cluster.
| Parameter | Default | Description | |||
|---|---|---|---|---|---|
| com.accenture.aspire.node.manager.scanBatchCreatorBaseSleep | 200 | (Required) The base sleep time in ms for the thread in charge of creating batches from the scan queueexecuting seeds based on the configured schedules | |||
| aspire.node.manager.maxBatches | yes | 1000 | The maximum number of batches the manager will keep in memory | ||
| com.accenture.aspire.node.manager.scanBatchCreatorMaxSleepmaxBatchItems | yes | 10000100 | (Required) The maximum sleep in ms for the thread in charge of creating batches from the scan queuenumber of documents per batch | ||
| com.accenture.aspire.node.manager.scanBatchCreatorMaxIterationsconnectionTimeout | yes | 1020000 | The connection timeout for requests to other aspire nodes | ||
| aspire.node.manager.socketTimeout | yes | 20000 | The socket timeout for requests to other aspire nodes | ||
| (Required) The number of iterations without creating new scan batches before in increasing the sleep time | com.accenture.aspire.node.manager.scanBatchCreatorMultipliermaxRetries | yes | 23 | The number of retries for requests to other aspire nodes | |
| (Required) The multiplier used to increase the sleep time after the specified iterations without creating new scan batches | com.accenture.aspire.node.manager.processBatchCreatorBaseSleepproxyHost | no | 200null | The proxy host to use for requests to other aspire nodes | |
| (Required) The base sleep time in ms for the thread in charge of creating batches from the process queue | com.accenture.aspire.node.manager.processBatchCreatorMaxSleepproxyPort | no | 100000 | The proxy port to use for requests to other aspire nodes. Must be provided if the proxyHost is configured | |
| (Required) The maximum sleep in ms for the thread in charge of creating batches from the process queue | com.accenture.aspire.node.manager.processBatchCreatorMaxIterationsproxyUser | no | 10null | The proxy user to use for requests to other aspire nodes | |
| aspire.node.manager.proxyPassword | no | null | The proxy password to use for requests to other aspire nodes. | ||
| (Required) The number of iterations without creating new process batches before in increasing the sleep time | com.accenture.aspire.node.manager.processBatchCreatorMultiplierpingFrequency | yes | 15000 | The frequency for the node to ping to Elasticsearch. The pings are used to determine if a node is alive and working properly | |
| 2 | (Required) The multiplier used to increase the sleep time after the specified iterations without creating new process batches | com.accenture.aspire.node.manager.crawlProgressManagerBaseSleepnodeFailureTimeout | yes | 30000 | The ping timeout used to determine if a node is not working. The node will be marked as failed in this case and the node eventually will shutdown itself |
| 200 | (Required) The base sleep time in ms for the thread in charge of monitoring active crawls | com.accenture.aspire.node.manager.schedulerBaseSleepinProgressJobTimeout | yes | 100003600000 | (Required) The base sleep The maximum time in ms for the thread in charge of executing seeds based on the configured schedules, a job can be in "in-progress" status before being released. Default is 1 hour |
| com.accenture.aspire.node.manager.maxBatchesinProgressJobTimeoutCheckFrequency | yes | 1000 | (Required) The maximum number of batches the manager will keep in memory | ||
| com.accenture.aspire.node.manager.maxBatchItems | 100 | (Required) The maximum number of documents per batch | |||
| 1800000 | How frequently to verify for timed-out "in-progress" jobs | ||||
| aspire.node.manager.ackCleanBaseSleep | no | 5000 | How frequently the manager should check for Acknowledged Batches that need to be removed from memory. | ||
| com.accenture.aspire.node.manager.connectionTimeoutproxyCall | no | 20000 | (Required) The connection timeout for requests to other aspire nodes | false | Configure if you want to perform a proxy call to the main manager from a non-main manager and avoid redirect calls. |
| com.accenture.aspire.node.manager.socketTimeouttags | 20000no | (Required) The socket timeout for requests to other aspire nodes | |||
| com.accenture.aspire.node.manager.maxRetries | 3 | (Required) The number of retries for requests to other aspire nodes | |||
| The tags of the manager node. These tags will determine which seeds this node can process. It should be a comma separated list of tags. | |||||
| com.accenture.aspire.node.manager.proxyHostworkerRoundRobin | no | null | (Optional) The proxy host to use for requests to other aspire nodes | false | If round-robin should be applied when serving workers with batches |
| com.accenture.aspire.node.manager.proxyPortworkerRoundRobinTimeout | no | 0600000 | (Optional) The proxy port to use for requests to other aspire nodes. Must be provided if the proxyHost is configured | ||
| com.accenture.aspire.node.manager.proxyUser | null | (Optional) The proxy user to use for requests to other aspire nodes | |||
| com.accenture.aspire.node.manager.proxyPassword | null | (Optional) The proxy password to use for requests to other aspire nodes. | |||
| com.accenture.aspire.node.manager.pingFrequency | 15000 | (Required) The ping timeout used to determine if a node is not working. The node will be marked as failed in this case and the node eventually will shutdown itself | |||
| The time in ms after which the worker is considered timed out when round-robin is used. |
User Interface
Since 5.0.3, the following properties are also available for managing the behavior of the user interface.
| Parameter | Required | Default | Description |
|---|---|---|---|
| aspire.ui.refreshRate | no | 5s | How often trigger the auto-refresh for the listing pages. It can be defined with a time unit, i.e. 15s, 1 m. |
Dashboards
These properties will be used to generate the dashboard links in the UI
| Parameter | Required | Default | Description | |||
|---|---|---|---|---|---|---|
| aspire.dashboards.enabled | no | false | Enables the dashboard links on the UI | |||
| aspire.dashboards.base | no | Base URL to Kibana | ||||
| aspire.dashboards.main | no | Main Dashboard relative URL | ||||
| aspire.dashboards.metrics | no | Metrics Dashboard relative URL | com.accenture.aspire.node.manager.nodeFailureTimeout | 30000 | (Required) The frequency for the node to ping to Elastisearch. The pings are used to determine if a node is alive and working properly |
Overview
Content Tools