The following table describes the ZooKeeper properties for the Loyalty 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 the amount of time, after tripping the circuit, to reject requests before allowing attempts again to determine if the circuit should again be closed. |
4 | server.servlet.contextPath | This property holds the Spring Boot application's context path. |
5 | server.ssl.enabled | This property controls the SSL configuration for the Spring Boot application. |
6 | server.ssl.enabled-protocols | This property controls the SSL configuration for the Spring Boot application. |
7 | server.ssl.key-alias | This property holds the keystore alias name configured during the import using keytool utility. |
8 | server.ssl.key-store | This property holds the keystore PrivateKeyEntry , which will be used as the SSL certificate for the microservice. |
9 | server.ssl.key-store-password | This property holds the keystore password for opening the keystore mentioned in the key-store property. |
10 | server.ssl.key-store-type | This property holds the key store type. |
11 | server.tomcat.accesslog.directory | This property holds the directory in which log files are created. It can be absolute or relative to the Tomcat base directory. |
12 | server.tomcat.accesslog.enabled | This property controls Tomcat logs for the Spring Boot application. |
13 | server.tomcat.accesslog.max-days | The property holds the maximum number of days the rotated access logs will be retained before it is deleted. The default value is 10 days. |
14 | server.tomcat.accesslog.pattern | This property sets the pattern for writing logs in Tomcat. |
15 | skava.auditlog.enabled | This property enables or disables the auditlog component. |
16 | skava.auditlog.file-location | This property sets the file location of the auditlog component. |
17 | skava.auditlog.layout-type | This property sets the layout type of the auditlog component. |
18 | skava.auditlog.mongodb.database | This property holds the Mongo database name for the audit log. |
19 | skava.auditlog.mongodb.enabled | This property enables or disables the store audit logs in the MongoDB. |
20 | skava.auditlog.mongodb.uri | This property connects to the Mongo server. |
21 | skava.auditlog.password | This property sets password of the MySQL DB for audit logs. |
22 | skava.authorization.authExpiryTimeMins | This property holds the expiry time of authorization token generated using the getTestToken API call. The value is mentioned in minutes. |
23 | 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 Skava Framework, this property's value identifies the correct header and the header value is considered for access/authorization checks. |
24 | 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 ). |
25 | skava.authorization.gettesttoken.enabled | 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 the test JWT tokens. |
26 | skava.authorization.superAdminRoleName | This property indicates the Super Admin role name for the corresponding microservice. |
27 | skava.authorization.tokenSecret | This 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. |
28 | skava.cache.cascadeCacheNames | This property enables the cascade cache by its name. |
29 | skava.cache.enableCascade | This property enables or disables the Cascade cache. |
30 | skava.cache.enabled | This property enables or disables the cache. |
31 | skava.cache.localCache.config.Loyalty_Attribute_Cache.cacheSize | This property sets the entry size of the local cache. |
32 | skava.cache.localCache.config.Loyalty_Attribute_Cache.maxIdleInSeconds | This property sets the maximum idle time of the local cache in milliseconds. |
33 | skava.cache.localCache.config.Loyalty_Attribute_Cache.timeToLiveInSeconds | This property sets the expiry time of the local cache in milliseconds. |
34 | skava.cache.localCache.config.Loyalty_Collection_Cache.cacheSize | This property sets the entry size of the local cache. |
35 | skava.cache.localCache.config.Loyalty_Collection_Cache.maxIdleInSeconds | This property sets the maximum idle time of the local cache in milliseconds. |
36 | skava.cache.localCache.config.Loyalty_Collection_Cache.timeToLiveInSeconds | This property sets the expiry time of the local cache in milliseconds. |
37 | skava.cache.localCache.type | This 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). |
38 | 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. |
39 | skava.cache.redis.cacheNames | This property holds the Redis cache names used by this application. |
40 | skava.cache.redis.clearCacheEventName | This property sets the event name for cache clear operation. |
41 | skava.cache.redis.client | This property contains the type of client for the Redis connection. |
42 | skava.cache.redis.cluster.maxRedirects | This property contains the maximum number of redirects to follow when executing commands across the clusters of the Redis server. |
43 | skava.cache.redis.cluster.nodes | This 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. |
44 | skava.cache.redis.clusterEnabled | This property enables or disables the cluster of the Redis server. |
45 | skava.cache.redis.database | This property holds the Redis database index used by the connection factory. |
46 | 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). |
47 | 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. 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. |
48 | skava.cache.redis.host | This property holds the Redis server's hostname/IP for caching objects. |
49 | skava.cache.redis.maxTimeTolive | This 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. |
50 | 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. |
51 | 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. |
52 | 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. |
53 | 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. |
54 | skava.cache.redis.port | This property holds the Redis server's port for the application to connect for both read and write cache operations. |
55 | skava.cache.redis.sentinel.master | This property contains the name of the Redis server. |
56 | skava.cache.redis.sentinel.nodes | This property contains a list of comma-separated 'host:port' pairs of the Redis server. |
57 | skava.cache.redis.ssl | This property enables or disables the SSL in the Redis server:
|
58 | skava.cache.redis.timeout | This property holds the connection timeout value of all Redis connections for both read and write operations. |
59 | skava.cache.redis.url | This property specifies the URL of the Redis server. |
60 | skava.cache.useOnlyL2Cache | This property enables or disables the L2 cache (that is, in-memory cache). |
61 | skava.cors.allowedHeaders | This property specifies the list of headers allowed during a CORS request. |
62 | skava.cors.allowedMethods | This 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. |
63 | skava.cors.allowedOrigins | This property specifies the list of allowed origins during a CORS request. For example, "http://domain1.com", or "*" for all origins. |
64 | skava.cors.enabled | This property enables or disables the CORS component. |
65 | skava.cors.exposedHeaders | This property sets exposedHeaders for a CORS request. |
66 | skava.cors.maxAge | This property configures the cache expiry time (in seconds) for the CORS pre-flight request . |
67 | skava.cors.pathPattern | This property enables the cross-origin request handling for the specified path pattern. |
68 | skava.event.className | This property sets the fully qualified name of the custom implementation class. |
69 | skava.event.enabled | This property enables or disables the event component. |
70 | skava.event.enableExternalEvent | This property enables or disables the external event component. |
71 | skava.event.enableFatEvent | This property enables or disables the fat event. |
72 | skava.event.eventbridge.eventBusName | This property sets the fully qualified name of the custom implementation class. |
73 | skava.event.eventbridge.region | This property sets the fully qualified name of the custom implementation class. |
74 | skava.event.externalClassName | This property sets the fully qualified name of the custom implementation class. |
75 | skava.event.externalFatEventClass | This property sets the fully qualified name of the custom implementation class. |
76 | skava.event.rabbitmq.addresses | This property sets the addresses for the RabbitMQ server cluster. |
77 | skava.event.rabbitmq.cluster-enabled | This property enables or disables the cluster for the RabbitMQ server. |
78 | skava.event.rabbitmq.concurrentConsumers | This property holds the value for maximum allowed concurrent consumers. |
79 | skava.event.rabbitmq.deadLetterExchange | This property sets the dead letter exchange for the RabbitMQ server. |
80 | skava.event.rabbitmq.defaultMaxRetryCount | This property sets the default maximum retrieval count for the RabbitMQ server. |
81 | skava.event.rabbitmq.enabled | This property enables or disables the RabbitMQ server for the event component. |
82 | skava.event.rabbitmq.host | This property holds the host name of the RabbitMQ server. |
83 | skava.event.rabbitmq.password | This property holds the password of the RabbitMQ server. |
84 | skava.event.rabbitmq.port | This property holds the port of the RabbitMQ server. |
85 | skava.event.rabbitmq.routingKey | This property is used to set the routing key for the RabbitMQ server. |
86 | skava.event.rabbitmq.ssl.algorithm | This property sets the SSL algorithm used for the RabbitMQ server. |
87 | skava.event.rabbitmq.ssl.enabled | This property enables or disables SSL in the RabbitMQ server for the event component. |
88 | skava.event.rabbitmq.topicExchange | This property sets the topic exchange for RabbitMQ server. |
89 | skava.event.rabbitmq.userName | This property holds the username of the RabbitMQ server. |
90 | skava.event.rabbitmq.virtualHost | This property sets the virtual host for the RabbitMQ server. |
91 | skava.hibernate.hikari.cache.prepStmts | This property sets whether the PreparedStatement is used or not. |
92 | skava.hibernate.hikari.prepStmtCachesize | This property sets the cache size of the PreparedStatement . |
93 | skava.hibernate.hikari.prepStmtCacheSqlLimit | This property sets the SQL limit of the PreparedStatement to be cached. |
94 | skava.hibernate.hikari.useServerPrepStmt | This property sets whether the server side PreparedStatement is used or not. |
95 | skava.localization.cookieEnabled | This property indicates whether the localization component cookie is enabled or not. The value:
|
96 | skava.localization.default-locale | This property sets the default locale. |
97 | skava.localization.enabled | This property indicates whether the localization component is enabled or not. The value:
|
98 | skava.localization.externalPath | This property holds the external path from where the localization messages are read. |
99 | skava.localization.param-name | This property sets the parameter name in which the localization component is used. |
100 | skava.localization.resourceBundleBaseName | This property holds the resource bundle using the specified base name. |
101 | skava.log.enabled | This property indicates whether the log component is enabled or not. The value:
|
102 | skava.log.fileAppenderEnabled | This 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 . |
103 | skava.log.fluentdAppenderEnabled | This property indicates whether the log file should be aggregated to Fluentd directly rather than to a file. |
104 | skava.log.fluentdHost | This property holds the host name for Fluentd server instance where the log will be aggregated. |
105 | skava.log.fluentdPattern | This property holds the pattern for writing logs into the Fluentd server. |
106 | skava.log.fluentdPort | This property holds the port of Fluentd server instance where the log will be aggregated. |
107 | skava.log.fluentdTagName | This property holds the tag name to be added in the logs. |
108 | skava.mongo.database | This property sets the database name for the MongoDB server. |
109 | skava.mongo.enabled | This property enables or disables the MongoDB component. |
110 | skava.mongo.uri | This property connects to the MongoDB server. |
111 | skava.querydsl.mongo.disableLiteralStringReplacement | This property disables literal pattern replacement in QueryDSL. |
112 | skava.ruleengine.enabled | This property enables or disables the rule engine component. |
113 | skava.ruleengine.poolClearTimeDelay | This property sets the time for creating a new session over the existing session. |
114 | skava.ruleengine.sessionPoolSize | This property sets the number of sessions pool for a collection. |
115 | skava.secretsmanager.className | This property specifies the name of the class used for the secret management. |
116 | skava.swaggerglobalparams.enabled | This property specifies whether the Swagger global parameters from the application.yml is referred and added in the Swagger UI or not. |
117 | spring.application.name | This property sets the application name of Spring Boot. |
118 | spring.autoconfigure.exclude | This property holds the classes that are to be excluded from the Spring's autoconfiguration. |
119 | spring.cloud.zookeeper.config.enabled | This property enables or disables the ZooKeeper. |
120 | spring.cloud.zookeeper.config.root | This property enables or disables the ZooKeeper's base path. |
121 | spring.cloud.zookeeper.config.watcher.enabled | This 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. |
122 | spring.cloud.zookeeper.connect-string | This property specifies the location of the ZooKeeper server. |
123 | spring.cloud.zookeeper.enabled | This property enables or disables the zookeeper server. |
124 | spring.sleuth.trace-id128 | This property enables or disables the Sleuth 128 bit Trace ID in the logs. |
125 | ZK_REDIS_SSL_ENABLED | This property enables or disables the Redis server SSL. The default value is FALSE . |
126 | skava.app.enabled | This property enables the app. The default value is TRUE . |
127 | skava.app.appClassName | This property holds the app component class name (GCP/Azure). The default value is com.skava.core.app.gcp.GCPAppComponent . |
128 | skava.app.host | This property holds the service endpoint URL of the App Marketplace service. The default value is ##ZK_SERVICE_END_POINT## . |
129 | 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## . |
130 | ZK_REDIS_TIMEOUT | This property holds connection timeout value of Redis in milliseconds. The default value is 10000. |
131 | ZK_REDIS_USERNAME | This property holds the login username of the Redis server. The default value is empty. |
132 | ZK_PROTOCOLS | This property enables macro support for the TLS protocol version. |
133 | ZK_REDIS_PASSWORD | This property holds the Redis password. |
134 | skava.cache.redis.username | This property indicates the login username of the Redis server. |
135 | endpoints.loggers.enabled | This property is used to enable or disable the logger. |
136 | web.exposure.include | This property is used to expose the management endpoints. |
137 | server.max-http-header-size | To increase http header size we have externalize this property. |
138 | externalEventConfig.fileHost | This property is used to set the hosting events on external website. |
139 | externalEventConfig.tempStoragePath | This property is used to set the file path for the external events. |
140 | skava.event.rabbitmq.amqpEnabled | This property is used to enable AMQP (Advanced Message Queuing Protocol). When the value is
|
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.