The following table describes the ZooKeeper properties for the Merchandising microservice:
| S.NO | PROPERTY | DESCRIPTION |
|---|---|---|
| 1 | hystrix.command.user-key.circuitBreaker.requestVolumeThreshold | This property sets the minimum number of requests in a rolling window that will trip the circuit. |
| 2 | hystrix.command.user-key.circuitBreaker.sleepWindowInMilliseconds | This property sets the amount of time, after tripping the circuit, to reject requests before allowing attempts again to determine if the circuit should again be closed. |
| 3 | hystrix.command.user-key.execution.isolation.thread.timeoutInMilliseconds | This property sets instance-specific values dynamically which overrides the preceding three levels of defaults. |
| 4 | skava.cors.enabled | This property is used to enable or disable the cors. |
| 5 | skava.cors.pathPattern | This property holds the pattern for the cors request. |
| 6 | skava.cors.allowedHeaders | This property contains the value of the allowed header. |
| 7 | skava.cors.allowedMethods | This property contains the allowed methods for Spring controller. |
| 8 | skava.cors.allowedOrigins | This property is used to set allowedOrigins for the cors request |
| 9 | skava.cors.exposedHeaders | This property is used to set exposedHeaders for the cors request. |
| 10 | skava.cors.maxAge | This property is used to set maxAge for the cors request in seconds. |
| 11 | skava.merchandise.liveEnvironment | This property specifies whether the deployment environment is live or authoring/staging environment. The value can be:
false. |
| 12 | skava.authorization.authExpiryTimeMins | This property holds the expiry time of authorization token generated using the getTestToken API call. The value is mentioned in minutes. |
| 13 | skava.authorization.authHeader | This property holds the HTTP request header name in which the authorization token (JWT) is passed by the caller. Since the functionality of validating token is inherited from the framework, this property's value is used for identifying the correct header and its value is considered for access/authorization checks. |
| 14 | skava.authorization.enabled | This property indicates whether the authorization component is enabled or disabled for the corresponding microservice. If the value is set as false, then all APIs are open to access without any authorization check and this is not recommended for the production or public APIs. For the production, production-like, or public environments, this property should be enabled (true). |
| 15 | skava.authorization.gettesttoken | This property indicates whether the authorization endpoint for test JWT tokens is enabled or not. If it is set to true, an API will be exposed to obtain test JWT tokens. |
| 16 | skava.authorization.tokenSecret | This property holds the secret which will be used to verify the signature of the JWT passed by the caller. Only if the JWT passed by the caller found valid with respect to signature, expiry and having necessary privileges, the request will be processed further. |
| 17 | skava.authorization.superAdminRoleName | The property indicates the Super Admin role name for the corresponding microservice. |
| 18 | skava.localization.default-locale | This property holds the default locale to be used for all response messages if it has not been provided in the request. |
| 19 | skava.localization.enabled | This property indicates whether the localization component is enabled or not. The value true indicates it is enabled and false indicates it is disabled. |
| 20 | skava.localization.externalPath | This property holds the external path from where the localized messages are to be read from. |
| 21 | skava.localization.param-name | This property holds the parameter name in which the localization component is used. |
| 22 | skava.localization.resourceBundleBaseName | This property holds the resource bundle's base name. |
| 23 | skava.localization.cookieEnabled | This property is used to enable or disable the localization component. |
| 24 | skava.auditlog.enabled | This property enables or disables the audit log component. |
| 25 | skava.auditlog.enabled.password | This property is used to connect to the MySQL DB for the audit logs. |
| 26 | skava.auditlog.file-location | This property holds the path to store the audit logs. |
| 27 | skava.auditlog.layout-type | This property is used to denote the layout type. |
| 28 | skava.auditlog.mongodb.enabled | This property is used to enable the mongo component for the audit log. |
| 29 | skava.auditlog.mongodb.database | This property holds the Mongo database name for the audit log. |
| 30 | skava.auditlog.mongodb.host | This property holds the value of mongo hostname for the audit log. |
| 31 | skava.auditlog.mongodb.port | This field has the port number of the Mongo server for the audit log. |
| 32 | skava.auditlog.mongodb.mongoAuthRequired | This property indicates the authorization of the Mongo server. |
| 33 | skava.auditlog.mongodb.username | This field holds the username of the Mongo DB. |
| 34 | skava.auditlog.mongodb.password | This property has the password of the Mongo DB for the audit log. |
| 35 | skava.auditlog.mongodb.sslEnabled | This field denotes whether the SSL is enabled or not for the MongoDB in the audit log. |
| 36 | skava.log.enabled | This property is used to set the resource bundle's base name. |
| 37 | skava.log.fileAppenderEnabled | This property indicates whether the log needs to be appended to a log file or not. If it is set to true the log is written to the log file as specified in log4j2.yml. |
| 38 | skava.log.fluentdAppenderEnabled | This property indicates whether the log file should be aggregated to Fluentd directly rather than to a file or not. |
| 39 | skava.log.fluentdHost | This property holds the hostname of Fluentd server instance where the log will be aggregated. |
| 40 | skava.log.fluentdPort | This property holds the port of Fluentd server instance where the log will be aggregated. |
| 41 | skava.log.fluentdPattern | This property holds the pattern for writing logs into the Fluentd server. |
| 42 | skava.log.fluentdTagName | This property holds the tag name to be added to the logs. |
| 43 | skava.mongo.enabled | This property indicates whether the Mongo database is enabled or not . |
| 44 | skava.mongo.host | This property denotes the hostname for Mango database by Hibernate component to connect to the database. |
| 45 | skava.mongo.port | This property holds the port number for the Mongo database by Hibernate component to connect to the database. |
| 46 | skava.mongo.database | This property denotes the name of the Mongo database for this service user by Hibernate to connect. |
| 47 | skava.mongo.mongoAuthRequired | This property is used to enable or disable the authorization for the Mongo server. |
| 48 | skava.mongo.username | This property holds the username to access the Mongo when the Mongo authorization is enabled. |
| 49 | skava.mongo.password | This property has the password for the Mongo username, used for Mongo authorization. |
| 50 | skava.mongo.connectTimeout | This property has the maximum connection timeout for the Mongo database. The value is mentioned in milliseconds. |
| 51 | skava.mongo.connectionsPerHost | This property limits the number of connections to the port based on the input. |
| 52 | skava.mongo.sslEnabled | This value indicate whether SSL is enabled or disabled for the Mongo. This should be a boolean value. |
| 53 | skava.event.className | This property is used to set the fully qualified name of the custom implementation class. |
| 54 | skava.event.enabled | This property is used to enable or disable the event component. |
| 55 | skava.event.rabbitmq.concurrentConsumers | This property holds the maximum allowed concurrent consumers. |
| 56 | skava.event.rabbitmq.enabled | This property is used to enable or disable the RabbitMQ server for the event component. |
| 57 | skava.event.rabbitmq.host | This property holds the hostname of the RabbitMQ server. |
| 58 | skava.event.rabbitmq.userName | This property has the username of the RabbitMQ server. |
| 59 | skava.event.rabbitmq.password | This property holds the password of the RabbitMQ server. |
| 60 | skava.event.rabbitmq.port | This property tells the port of the RabbitMQ server. |
| 61 | skava.event.rabbitmq.queueName | This property is used to set the queue name used by the event component. |
| 62 | skava.event.rabbitmq.routingKey | This property is used to set the routing key for the RabbitMQ server. |
| 63 | skava.event.rabbitmq.topicExchange | This property is used to set the topic exchange for the RabbitMQ server. |
| 64 | skava.event.rabbitmq.virtualHost | This property is used to set the virtual host for the RabbitMQ server. |
| 65 | skava.cache.redis.cacheNames | This property holds the Redis cache names used by the application. |
| 66 | skava.cache.redis.clearCacheEventName | This property is used to set the event name for cache clear operation. |
| 67 | skava.cache.redis.database | This property holds the Redis database index used by the connection factory. |
| 68 | skava.cache.redis.enabled | This property indicates whether the Redis component needs to be enabled or disabled for this application. It is recommended that it should be enabled (true) for the production and production-grade environments (like performance). |
| 69 | skava.cache.redis.expTimeTolive | This property holds the expiration time of Redis entries. That is the maximum time the objects are requested to be held in the Redis server. Using this property you are requesting Redis to hold the objects for the specified time but it is the LRU/LCU which will determine how long an entry survives in the cache. |
| 70 | skava.cache.redis.host | This property holds the Redis server's hostname/IP for caching objects. |
| 71 | skava.cache.redis.password | This property holds the password for connecting to the Redis server. This is required if the authentication is enabled for the Redis server. It is recommended that it should be enabled for the production environment. |
| 72 | skava.cache.redis.port | This property holds the Redis server's port for the application to connect for both read and write cache operations. |
| 73 | skava.cache.redis.timeout | This property holds the connection timeout value of all Redis connections for both read and write. |
| 74 | skava.cache.redis.pool.minIdle | This property holds the minimum number of idle connections to maintain in the pool. This setting only has an effect if it is positive. |
| 75 | skava.cache.redis.pool.maxIdle | This property holds the maximum number of idle connections in the pool. Use a negative value to indicate an unlimited number of idle connections. |
| 76 | skava.cache.redis.pool.maxActive | This property holds the maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. |
| 77 | spring.application.name | This property holds the application name of the Spring Boot application. |
| 78 | spring.autoconfigure.exclude | This property holds the classes that are to be excluded from the Spring's autoconfiguration. |
| 79 | spring.cloud.zookeeper.enabled | This property is used to enable or disable the ZooKeeper server. |
| 80 | spring.cloud.connect-string | This property specifies the location of the server when it locates somewhere other than localhost:2181. This configuration is required to locate the server. |
| 81 | spring.cloud.config.enabled | This property is used to enable or disable the ZooKeeper's base path. |
| 82 | spring.cloud.root | This property is used to configure the ZooKeeper's base path. |
| 83 | spring.cloud.watcher | This property indicates whether the ZooKeeper watcher has been enabled or not. If it is set to true, the watcher is enabled and if there is any change in the ZooKeeper configuration is communicated to the server. Updated properties are loaded automatically if the implementation allows it. |
| 84 | spring.sleuth | This property is used to enable or disable the sleuth 128-bit trace ID in the logs. |
| 85 | server.servlet.contextPath | This property holds the Spring Boot application's context path. |
| 86 | server.tomcat.accesslog.enabled | This property controls the Tomcat logs for the Boot application. |
| 87 | server.tomcat.accesslog.pattern | This property holds the pattern of the access logs to be printed. This will follow the Apache Tomcat parameters. |
| 88 | server.tomcat.accesslog.directory | This property holds the directory in which log files are created. It can be absolute or relative to the Tomcat's base directory. |
| 89 | server.tomcat.basedir | This property holds the Tomcat base directory location and this needs to be an absolute path. |
| 90 | server.ssl.enabled | This property controls the SSL configuration of the Boot application. When it is set to true, the application is started in HTTPS protocol only and all HTTP request will be rejected. |
| 91 | server.ssl.tomcat.max-http-header-size | This property holds the maximum header size of SSL Tomcat. |
| 92 | server.ssl.key-store | This property holds the key store's PrivateKeyEntry which will be used as the SSL certificate for the microservice. |
| 93 | server.ssl.key-store-password | This property holds the key store password for accessing the key store as mentioned in the key-store property. |
| 94 | server.ssl.key-store-type | This property holds the key store type. |
| 95 | server.ssl.key-alias | This property holds the key store alias name set during the import using keytool utility. |
| 96 | skava.merchandise.milestonePageSize | This property sets the maximum number of milestones can be returned in get call. |
| 97 | skava.swaggerglobalparams.enabled | This property indicates the Swagger global params. The default value is false. If this property value is set to true, the Swagger global params from the application .yml will be referred and added in the Swagger UI. |
| 98 | skava.event.rabbitmq.ssl.enabled | This property enables or disables the SSL support for RabbitMQ server. |
| 99 | skava.event.rabbitmq.ssl.algorithm | This property sets the SSL algorithm, which is used for the RabbitMQ server. |
| 100 | skava.event.rabbitmq.cluster-enabled | This property enables or disables the cluster for the RabbitMQ server. |
| 101 | skava.event.rabbitmq.addresses | This property sets the addresses for the RabbitMQ server cluster. |
| 102 | skava.hibernate.hikari.enabled | This property enables or disables the Hibernate Hikari component. |
| 103 | skava.hibernate.hikari.poolname | This property represents a user-defined name for the connection pool. It appears mainly in the logging and JMX management consoles to identify pools and pool configurations. The default value is auto-generated. |
| 104 | skava.hibernate.hikari.dataSourceClassName | This property is available only via programmatic configuration or IoC container. This property allows you to directly set the instance of the DataSource to be wrapped by the pool, rather than having HikariCP construct it via reflection. This can be useful in some dependency injection frameworks. When this property is specified, the dataSourceClassName property and all DataSource-specific properties will be ignored. There is no default value. |
| 105 | skava.hibernate.hikari.maximumPoolSize | This property controls the maximum size of the pool, including both idle and in-use connections. This value determines the maximum number of actual connections to the database backend. The value is determined by your execution environment. When the pool reaches to this size and no idle connections are available, the call getConnection() block for up to connectionTimeout milliseconds before timing out. The default value is 10. |
| 106 | skava.hibernate.hikari.maximumlifetime | This property controls the maximum lifetime of a connection in the pool. An in-use connection will never be retired, only when it is closed, it will then be removed. On a connection-by-connection basis, minor negative attenuation is applied to avoid mass-extinction in the pool. It is strongly recommend to set this value, and it should be several seconds shorter than any database or infrastructure imposed connection time limit. A value of 0 indicates no maximum lifetime (infinite lifetime), subject of course to the idleTimeout setting. The default value is 1800000 ms (30 minutes). |
| 107 | skava.hibernate.hikari.idleTimeout | This property controls the maximum amount of time that a connection is allowed to sit idle in the pool. This setting only applies when minimumIdle is defined to be less than maximumPoolSize. The idle connections will not be retired until the pool reaches minimumIdle connections. Whether a connection is retired as idle or not is subject to a maximum variation of +30 seconds, and average variation of +15 seconds. A connection will never be retired as idle before this timeout. A value of 0 indicates the idle connections are never removed from the pool. The minimum allowed value is 10000ms (10 seconds). The default value is 600000 ms (10 minutes). |
| 108 | skava.hibernate.hikari.prepStmtCachesize | This property sets the cache size of the PreparedStatement. |
| 109 | skava.hibernate.hikari.prepStmtCacheSqlLimit | This property sets the SQL limit of the PreparedStatement to be cached. |
| 110 | skava.hibernate.hikari.cache.prepStmts | This property sets whether the PreparedStatement is used or not. |
| 111 | skava.hibernate.hikari.useServerPrepStmt | This property sets whether the server side PreparedStatement is used or not. |
| 112 | skava.cache.enabled | This property is used to enable cache. |
| 113 | skava.cache.enableCascade | This property is used to enable cascade cache. |
| 114 | skava.cache.useOnlyL2Cache | This property is used to enable L2 cache. |
| 115 | skava.cache.cascadeCacheNames | This property is used to enable cascade cache by its name. |
| 116 | skava.cache.localCache.type | This property represents the local cache type for L1 cache used in cascade cache. |
| 117 | skava.cache.localCache.config.cache_collection.cacheSize | This property represents the local cache entry size. |
| 118 | skava.cache.localCache.config.cache_collection.timeToLiveInSeconds | This property represents the local cache expiry time in seconds. |
| 119 | skava.cache.localCache.config.cache_collection.maxIdleInSeconds | This property represents the local cache maximum idle time in seconds. |
| 120 | skava.cache.localCache.config.cache_collection_attribute.cacheSize | This property represents the local cache entry size. |
| 121 | skava.cache.localCache.config.cache_collection_attribute.timeToLiveInSeconds | This property represents the local cache expiry time in seconds. |
| 122 | skava.cache.localCache.config.cache_collection_attribute.maxIdleInSeconds | This property represents the local cache maximum idle time in seconds. |
| 123 | skava.cache.redis.cluster.maxRedirects | This property represents the maximum number of redirects to follow when executing commands across the cluster.. |
| 124 | skava.cache.redis.cluster.nodes | This property represents the comma-separated list of 'host:port' pairs to bootstrap from. This represents an 'initial' list of cluster nodes and is required to have at least one entry. |
| 125 | skava.cache.redis.sentinel.master | This property represents the name of the Redis server. |
| 126 | skava.cache.redis.sentinel.nodes | This property represents the comma-separated list of 'host:port' pairs. |
| 127 | skava.cache.redis.ssl | This property represents the enable/disable of Redis server ssl. |
| 128 | skava.cache.redis.url | This property represents the Redis server url. |
| 129 | skava.cache.redis.clusterEnabled | This property represents the toggle cluster for Redis server. |
| 130 | skava.cache.redis.maxTimeTolive | This property holds the maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. |
| 131 | skava.cache.redis.client | This property represents the type of client for redis connection. |
| 132 | skava.cache.maxCacheSize | This property holds the cache size in bytes. If the value is greater than 0, then the cache is restricted based on the value. Otherwise, no limitation for cache. |
| 133 | ZK_REDIS_SSL_ENABLED | This property enables or disables the Redis server SSL. The default value is FALSE. |
| 134 | skava.app.enabled | This property enables the app. The default value is TRUE. |
| 135 | skava.app.appClassName | This property holds the app component class name (GCP/Azure). The default value is com.skava.core.app.gcp.GCPAppComponent. |
| 136 | skava.app.host | This property holds the service endpoint URL of the App Marketplace service. The default value is ##ZK_SERVICE_END_POINT##. |
| 137 | skava.app.apiKey | This property holds the API key which is sent to the App for authentication. The default value is ##ZK_APP_API_KEY##. |
| 138 | ZK_REDIS_TIMEOUT | This property holds connection timeout value of Redis in milliseconds. The default value is 10000. |
| 139 | ZK_REDIS_USERNAME | This property holds the login username of the Redis server. The default value is empty. |
| 140 | ZK_PROTOCOLS | This property enables macro support for the TLS protocol version. |
| 141 | ZK_REDIS_PASSWORD | This property holds the Redis password. |
| 142 | skava.cache.redis.username | This property indicates the login username of the Redis server. |
| 143 | disableSpringBatchInAdmin | This property is used to enable or disable Spring Batch in the admin console. |
| 144 | endpoints.loggers.enabled | This property is used to enable or disable the logger. |
| 145 | web.exposure.include | This property is used to expose the management endpoints. |
| 146 | server.max-http-header-size | To increase http header size we have externalize this property. |
| 147 | skava.event.rabbitmq.amqpEnabled | This property is used to enable AMQP (Advanced Message Queuing Protocol). When the value is
|
Revision History
2024-08-05 | SD – Updated ZK properties.
2024-07-12 | SD – Updated ZK properties.
2024-06-19 | SD – Updated ZK properties for release 8.18.0 to 8.16.0.
2024-05-10 | SD – Updated Zookeeper properties for 8.17.1 release.
2023-10-22 | JP – Updated content for 8.15.4 release.
2022-04-10 | JP – Fixed link and http issues.
2021-12-27 | AN – Updated content for 8.11 release.
2020-12-10 | HM – Updated missing ZK properties.
2020-03-09 | AN – Updated content for April 2020 release.
2020-01-14 | AN – Updated content for February 2020 release.
2019-07-09 | AM – Updated ZK properties for July 2019 release.
2019-05-20 | JP – Uploaded to a new table tool.
2019-04-17 | AN – Content updated for the April 2019 release.
2019-01-23 | PLK – Content uploaded.