The following table describes the ZooKeeper properties for the Loyalty microservice:
S.NoPropertyDescription
1hystrix.command.user-key.circuitBreaker.requestVolumeThresholdThis property sets the minimum number of requests in a rolling window that will trip the circuit.
2hystrix.command.user-key.circuitBreaker.sleepWindowInMillisecondsThis 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.
3hystrix.command.user-key.execution.isolation.thread.timeoutInMillisecondsThis 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.
4server.servlet.contextPathThis property holds the Spring Boot application's context path.
5server.ssl.enabledThis property controls the SSL configuration for the Spring Boot application.
6server.ssl.enabled-protocolsThis property controls the SSL configuration for the Spring Boot application.
7server.ssl.key-aliasThis property holds the keystore alias name configured during the import using keytool utility.
8server.ssl.key-storeThis property holds the keystore PrivateKeyEntry, which will be used as the SSL certificate for the microservice.
9server.ssl.key-store-passwordThis property holds the keystore password for opening the keystore mentioned in the key-store property.
10server.ssl.key-store-typeThis property holds the key store type.
11server.tomcat.accesslog.directoryThis property holds the directory in which log files are created. It can be absolute or relative to the Tomcat base directory.
12server.tomcat.accesslog.enabledThis property controls Tomcat logs for the Spring Boot application.
13server.tomcat.accesslog.max-daysThe property holds the maximum number of days the rotated access logs will be retained before it is deleted. The default value is 10 days.
14server.tomcat.accesslog.patternThis property sets the pattern for writing logs in Tomcat.
15skava.auditlog.enabledThis property enables or disables the auditlog component.
16skava.auditlog.file-locationThis property sets the file location of the auditlog component.
17skava.auditlog.layout-typeThis property sets the layout type of the auditlog component.
18skava.auditlog.mongodb.databaseThis property holds the Mongo database name for the audit log.
19skava.auditlog.mongodb.enabledThis property enables or disables the store audit logs in the MongoDB.
20skava.auditlog.mongodb.uriThis property connects to the Mongo server.
21skava.auditlog.passwordThis property sets password of the MySQL DB for audit logs.
22skava.authorization.authExpiryTimeMinsThis property holds the expiry time of authorization token generated using the getTestToken API call. The value is mentioned in minutes.
23skava.authorization.authHeaderThis 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 Skava Framework, this property's value identifies the correct header and the header value is considered for access/authorization checks.
24skava.authorization.enabledThis 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).
25skava.authorization.gettesttoken.enabledThis 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 the test JWT tokens.
26skava.authorization.superAdminRoleNameThis property indicates the Super Admin role name for the corresponding microservice.
27skava.authorization.tokenSecretThis property holds the secret key, which will be used to verify the signature of the JWT passed by the caller. The request will be processed further only if the JWT passed by the caller is valid with respect to the signature, token's expiration, and privileges to perform the operations.
Note: This is applicable when the secret manager is NOT enabled for the Loyalty service.
28skava.cache.cascadeCacheNamesThis property enables the cascade cache by its name.
29skava.cache.enableCascadeThis property enables or disables the Cascade cache.
30skava.cache.enabledThis property enables or disables the cache.
31skava.cache.localCache.config.Loyalty_Attribute_Cache.cacheSizeThis property sets the entry size of the local cache.
32skava.cache.localCache.config.Loyalty_Attribute_Cache.maxIdleInSecondsThis property sets the maximum idle time of the local cache in milliseconds.
33skava.cache.localCache.config.Loyalty_Attribute_Cache.timeToLiveInSecondsThis property sets the expiry time of the local cache in milliseconds.
34skava.cache.localCache.config.Loyalty_Collection_Cache.cacheSizeThis property sets the entry size of the local cache.
35skava.cache.localCache.config.Loyalty_Collection_Cache.maxIdleInSecondsThis property sets the maximum idle time of the local cache in milliseconds.
36skava.cache.localCache.config.Loyalty_Collection_Cache.timeToLiveInSecondsThis property sets the expiry time of the local cache in milliseconds.
37skava.cache.localCache.typeThis property sets the local cache type for L1 cache used in the cascade cache (uses both in-memory cache and server-side cache using Redis).
38skava.cache.maxCacheSizeThis 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.
39skava.cache.redis.cacheNamesThis property holds the Redis cache names used by this application.
40skava.cache.redis.clearCacheEventNameThis property sets the event name for cache clear operation.
41skava.cache.redis.clientThis property contains the type of client for the Redis connection.
42skava.cache.redis.cluster.maxRedirectsThis property contains the maximum number of redirects to follow when executing commands across the clusters of the Redis server.
43skava.cache.redis.cluster.nodesThis property contains a list of comma-separated host:port pairs to bootstrap from. This represents an 'initial' list of cluster nodes. It is required to have at least one entry.
44skava.cache.redis.clusterEnabledThis property enables or disables the cluster of the Redis server.
45skava.cache.redis.databaseThis property holds the Redis database index used by the connection factory.
46skava.cache.redis.enabledThis 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).
47skava.cache.redis.expTimeToliveThis property holds the expiration time of Redis entries, that is, the maximum time the objects are requested to be held in the Redis server. With this property, you can request Redis to hold the objects for the specified time, but it is the LRU/LCU which determines how long an entry survives in the cache.
48skava.cache.redis.hostThis property holds the Redis server's hostname/IP for caching objects.
49skava.cache.redis.maxTimeToliveThis property holds the expiration time of Redis entries. That is, the maximum time the objects are requested to be held in Redis server. Using this property, you are requesting Redis server 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.
50skava.cache.redis.passwordThis 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.
51skava.cache.redis.pool.maxActiveThis 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.
52skava.cache.redis.pool.maxIdleThis property holds the maximum number of idle connections in the pool. Use a negative value to indicate an unlimited number of idle connections.
53skava.cache.redis.pool.minIdleThis property holds the minimum number of idle connections to maintain in the pool. This setting only has an effect if it is positive.
54skava.cache.redis.portThis property holds the Redis server's port for the application to connect for both read and write cache operations.
55skava.cache.redis.sentinel.masterThis property contains the name of the Redis server.
56skava.cache.redis.sentinel.nodesThis property contains a list of comma-separated 'host:port' pairs of the Redis server.
57skava.cache.redis.sslThis property enables or disables the SSL in the Redis server:
  • true - If the SSL is enabled in the Redis server
  • false - If the SSL is not enabled in the Redis server
58skava.cache.redis.timeoutThis property holds the connection timeout value of all Redis connections for both read and write operations.
59skava.cache.redis.urlThis property specifies the URL of the Redis server.
60skava.cache.useOnlyL2CacheThis property enables or disables the L2 cache (that is, in-memory cache).
61skava.cors.allowedHeadersThis property specifies the list of headers allowed during a CORS request.
62skava.cors.allowedMethodsThis property specifies the list of HTTP methods allowed during a CORS request.
For example,
"GET","POST"
"POST"
"PUT", etc.
You need to capture the above examples in a list.
63skava.cors.allowedOriginsThis property specifies the list of allowed origins during a CORS request.
For example,
"http://domain1.com", or "*" for all origins.
64skava.cors.enabledThis property enables or disables the CORS component.
65skava.cors.exposedHeadersThis property sets exposedHeaders for a CORS request.
66skava.cors.maxAgeThis property configures the cache expiry time (in seconds) for the CORS pre-flight request .
67skava.cors.pathPatternThis property enables the cross-origin request handling for the specified path pattern.
68skava.event.classNameThis property sets the fully qualified name of the custom implementation class.
69skava.event.enabledThis property enables or disables the event component.
70skava.event.enableExternalEventThis property enables or disables the external event component.
71skava.event.enableFatEventThis property enables or disables the fat event.
72skava.event.eventbridge.eventBusNameThis property sets the fully qualified name of the custom implementation class.
73skava.event.eventbridge.regionThis property sets the fully qualified name of the custom implementation class.
74skava.event.externalClassNameThis property sets the fully qualified name of the custom implementation class.
75skava.event.externalFatEventClassThis property sets the fully qualified name of the custom implementation class.
76skava.event.rabbitmq.addressesThis property sets the addresses for the RabbitMQ server cluster.
77skava.event.rabbitmq.cluster-enabledThis property enables or disables the cluster for the RabbitMQ server.
78skava.event.rabbitmq.concurrentConsumersThis property holds the value for maximum allowed concurrent consumers.
79skava.event.rabbitmq.deadLetterExchangeThis property sets the dead letter exchange for the RabbitMQ server.
80skava.event.rabbitmq.defaultMaxRetryCountThis property sets the default maximum retrieval count for the RabbitMQ server.
81skava.event.rabbitmq.enabledThis property enables or disables the RabbitMQ server for the event component.
82skava.event.rabbitmq.hostThis property holds the host name of the RabbitMQ server.
83skava.event.rabbitmq.passwordThis property holds the password of the RabbitMQ server.
84skava.event.rabbitmq.portThis property holds the port of the RabbitMQ server.
85skava.event.rabbitmq.routingKeyThis property is used to set the routing key for the RabbitMQ server.
86skava.event.rabbitmq.ssl.algorithmThis property sets the SSL algorithm used for the RabbitMQ server.
87skava.event.rabbitmq.ssl.enabledThis property enables or disables SSL in the RabbitMQ server for the event component.
88skava.event.rabbitmq.topicExchangeThis property sets the topic exchange for RabbitMQ server.
89skava.event.rabbitmq.userNameThis property holds the username of the RabbitMQ server.
90skava.event.rabbitmq.virtualHostThis property sets the virtual host for the RabbitMQ server.
91skava.hibernate.hikari.cache.prepStmtsThis property sets whether the PreparedStatement is used or not.
92skava.hibernate.hikari.prepStmtCachesizeThis property sets the cache size of the PreparedStatement.
93skava.hibernate.hikari.prepStmtCacheSqlLimitThis property sets the SQL limit of the PreparedStatement to be cached.
94skava.hibernate.hikari.useServerPrepStmtThis property sets whether the server side PreparedStatement is used or not.
95skava.localization.cookieEnabledThis property indicates whether the localization component cookie is enabled or not. The value:
  • true indicates that the localization component cookie has been enabled
  • false indicates that the localization component cookie has been disabled
96skava.localization.default-localeThis property sets the default locale.
97skava.localization.enabledThis property indicates whether the localization component is enabled or not. The value:
  • true indicates that the localization component has been enabled
  • false indicates that the localization component has been disabled
98skava.localization.externalPathThis property holds the external path from where the localization messages are read.
99skava.localization.param-nameThis property sets the parameter name in which the localization component is used.
100skava.localization.resourceBundleBaseNameThis property holds the resource bundle using the specified base name.
101skava.log.enabledThis property indicates whether the log component is enabled or not. The value:
  • true indicates that the log component has been enabled
  • false indicates that the log component has been disabled
102skava.log.fileAppenderEnabledThis property indicates whether the log needs to be appended to a log file or not. If set to true the log is written to the log file as specified in log4j2.yml.
103skava.log.fluentdAppenderEnabledThis property indicates whether the log file should be aggregated to Fluentd directly rather than to a file.
104skava.log.fluentdHostThis property holds the host name for Fluentd server instance where the log will be aggregated.
105skava.log.fluentdPatternThis property holds the pattern for writing logs into the Fluentd server.
106skava.log.fluentdPortThis property holds the port of Fluentd server instance where the log will be aggregated.
107skava.log.fluentdTagNameThis property holds the tag name to be added in the logs.
108skava.mongo.databaseThis property sets the database name for the MongoDB server.
109skava.mongo.enabledThis property enables or disables the MongoDB component.
110skava.mongo.uriThis property connects to the MongoDB server.
111skava.querydsl.mongo.disableLiteralStringReplacementThis property disables literal pattern replacement in QueryDSL.
112skava.ruleengine.enabledThis property enables or disables the rule engine component.
113skava.ruleengine.poolClearTimeDelayThis property sets the time for creating a new session over the existing session.
114skava.ruleengine.sessionPoolSizeThis property sets the number of sessions pool for a collection.
115skava.secretsmanager.classNameThis property specifies the name of the class used for the secret management.
116skava.swaggerglobalparams.enabledThis property specifies whether the Swagger global parameters from the application.yml is referred and added in the Swagger UI or not.
117spring.application.nameThis property sets the application name of Spring Boot.
118spring.autoconfigure.excludeThis property holds the classes that are to be excluded from the Spring's autoconfiguration.
119spring.cloud.zookeeper.config.enabledThis property enables or disables the ZooKeeper.
120spring.cloud.zookeeper.config.rootThis property enables or disables the ZooKeeper's base path.
121spring.cloud.zookeeper.config.watcher.enabledThis property indicates whether the ZooKeeper watcher is enabled or not. If the watcher is enabled, the ZooKeeper configuration changes are communicated to the server and the updated properties are loaded automatically in ther server.
122spring.cloud.zookeeper.connect-stringThis property specifies the location of the ZooKeeper server.
123spring.cloud.zookeeper.enabledThis property enables or disables the zookeeper server.
124spring.sleuth.trace-id128This property enables or disables the Sleuth 128 bit Trace ID in the logs.
125ZK_REDIS_SSL_ENABLEDThis property enables or disables the Redis server SSL. The default value is FALSE.
126skava.app.enabledThis property enables the app. The default value is TRUE.
127skava.app.appClassNameThis property holds the app component class name (GCP/Azure).
The default value is com.skava.core.app.gcp.GCPAppComponent.
128skava.app.hostThis property holds the service endpoint URL of the App Marketplace service.
The default value is ##ZK_SERVICE_END_POINT##.
129skava.app.apiKeyThis property holds the API key which is sent to the App for authentication.
The default value is ##ZK_APP_API_KEY##.
130ZK_REDIS_TIMEOUTThis property holds connection timeout value of Redis in milliseconds.
The default value is 10000.
131ZK_REDIS_USERNAMEThis property holds the login username of the Redis server.
The default value is empty.
132ZK_PROTOCOLSThis property enables macro support for the TLS protocol version.
133ZK_REDIS_PASSWORDThis property holds the Redis password.
134skava.cache.redis.usernameThis property indicates the login username of the Redis server.
135endpoints.loggers.enabledThis property is used to enable or disable the logger.
136web.exposure.includeThis property is used to expose the management endpoints.
137server.max-http-header-sizeTo increase http header size we have externalize this property.
138externalEventConfig.fileHostThis property is used to set the hosting events on external website.
139externalEventConfig.tempStoragePathThis property is used to set the file path for the external events.
140skava.event.rabbitmq.amqpEnabledThis property is used to enable AMQP (Advanced Message Queuing Protocol). When the value is
  • true: The RabbitMQ is enabled.
  • false: The AMQP is enabled.
Note: To enable AMQP, contact the Infra team.


Revision History
2024-07-12 | SD – Updated ZK properties.
2024-06-19 | SD – Updated ZK properties for release 8.17.0 to 8.16.0.
2023-10-22 | JP – Updated content for 8.15.4 release.
2023-01-06 | AN – Updated content for 8.13 release.
2022-04-10 | JP – Fixed link and http issues.
2021-12-27 | AN – Updated content for 8.11 release.
2020-03-09 | AN – Updated content for April 2020 release.
2020-01-14 | AN – Updated content for February 2020 release.
2019-10-31 | AN – Page created and the contents uploaded.