Lightstreamer Helm Chart Specification

This Helm chart provides a structured and efficient way to deploy and manage Lightstreamer Broker on Kubernetes.

By leveraging Helm's templating capabilities, this chart simplifies the configuration and deployment process, ensuring that Lightstreamer Broker can be easily integrated into your Kubernetes environment.

This page documents the configuration settings and default values for the chart.

For installation instructions, custom configuration, and deployment guidance, see the deployment documentation.

Homepage: https://github.com/Lightstreamer/helm-charts

Source Code

https://github.com/Lightstreamer/helm-charts/tree/main/charts/lightstreamer

Settings

This chart offers extensive configuration options organized into logical sections for easy reference and management. Each setting is documented with its description, default value, and configuration examples where applicable.

To improve readability and navigation, the configuration documentation has been divided into the following sections, each focusing on a specific aspect of the Lightstreamer deployment:

Common
License
Servers
Keystores
Logging
Management
Global Socket
Security
Push Session
Mpn
Web Server
Cluster
Load
Adapters
Connectors

Common settings

commonLabels

Common labels to apply to all resources

Type: object

Default: {}

fullnameOverride

Replace the chart's default resource naming convention

Type: string

Default: ""

image

Lightstreamer Docker Image settings

Type: object

Default:

{"pullPolicy":"IfNotPresent","repository":"lightstreamer","tag":"latest"}

image.repository

Remote registry from which to pull the Lightstreamer Docker image

Type: string

Default: "lightstreamer"

image.tag

The tag of the image to pull

Type: string

Default: .Chart.appVersion

nameOverride

Override the default name of the chart

Type: string

Default: ""

License settings

license

Mandatory. Configure the edition, the optional features, and the type of license that should be used to run the Lightstreamer Broker.

Type: object

Default:

{"edition":"ENTERPRISE","enableAutomaticUpdateCheck":true,"enabledCommunityEditionClientApi":"javascript_client","enterprise":{"contractId":"DEMO","enableAutomaticAuditLogUpload":true,"filePathSecretRef":{"key":null,"name":null},"licenseType":"DEMO","licenseValidation":"ONLINE","onlinePasswordSecretRef":{"key":null,"name":null},"optionalFeatures":{"enableRestrictedFeaturesSet":false,"features":{"enableAndroidClient":false,"enableBandwidthControl":false,"enableBlackBerryClient":false,"enableDotNETStandardClient":false,"enableFlashClient":false,"enableFlexClient":false,"enableGenericClient":false,"enableIOSClient":false,"enableJavaMEClient":false,"enableJavaSEClient":false,"enableJavascriptClient":false,"enableJmx":false,"enableMacOSClient":false,"enableMpn":true,"enableNodeJsClient":false,"enablePythonClient":false,"enableSilverlightClient":false,"enableTlsSsl":false,"enableTvOSClient":false,"enableVisionOSClient":false,"enableWatchOSClient":false,"maxDownstreamRate":"1"}}},"proxy":{"enableProxyAutodiscovery":false,"httpProxies":[{"credentialsSecretRef":null,"host":null,"port":null,"scheme":null}],"networkInterface":null,"pacFiles":{"filePaths":[],"fileUrls":[]},"socksProxies":[{"credentialsSecretRef":null,"host":null,"port":null,"version":null}]}}

license.edition

Mandatory. Lightstreamer edition to use. To know full details, open the Welcome Page or the Monitoring Dashboard (Edition tab) of your running the Lightstreamer Broker. Possible values: COMMUNITY, ENTERPRISE.

Type: string

Default: "ENTERPRISE"

license.enableAutomaticUpdateCheck

Optional. Periodically check whether any Lightstreamer Broker update is available. In such case, a notification is written to the log file. If set to true, perform automatic update check. The following host name must be reachable on port 443: https://service.lightstreamer.com/. If set to false, do not perform an automatic update check.

Type: bool

Default: true

license.enabledCommunityEditionClientApi

Mandatory if edition is set to COMMUNITY. The Client API to use with your Lightstreamer free license. Possible values: javascript_client (for web browser clients), nodejs_client (for Node.js clients), android_client (for Android clients), ios_client (for iOS clients), flex_client (for Flex and AIR clients), silverlight_client (for Silverlight clients), javase_client (for Java SE clients), python_client (for Python clients), dotnet_standard_client (for .NET Standard clients), macos_client (for macOS clients), tvos_client (for tvOS clients), watchos_client (for watchOS clients), visionos_client (for visionOS clients), blackberry_client (for BlackBerry clients), javame_client (for Java ME clients), flash_client (for Flash clients), generic_client (for custom clients based on the Lightstreamer protocol).

Type: string

Default: "javascript_client"

license.enterprise

Mandatory if edition is set to ENTERPRISE. Configure the ENTERPRISE edition.

Type: object

Default:

{"contractId":"DEMO","enableAutomaticAuditLogUpload":true,"filePathSecretRef":{"key":null,"name":null},"licenseType":"DEMO","licenseValidation":"ONLINE","onlinePasswordSecretRef":{"key":null,"name":null},"optionalFeatures":{"enableRestrictedFeaturesSet":false,"features":{"enableAndroidClient":false,"enableBandwidthControl":false,"enableBlackBerryClient":false,"enableDotNETStandardClient":false,"enableFlashClient":false,"enableFlexClient":false,"enableGenericClient":false,"enableIOSClient":false,"enableJavaMEClient":false,"enableJavaSEClient":false,"enableJavascriptClient":false,"enableJmx":false,"enableMacOSClient":false,"enableMpn":true,"enableNodeJsClient":false,"enablePythonClient":false,"enableSilverlightClient":false,"enableTlsSsl":false,"enableTvOSClient":false,"enableVisionOSClient":false,"enableWatchOSClient":false,"maxDownstreamRate":"1"}}}

license.enterprise.optionalFeatures

Optional. Configure the optional features.

Type: object

Default:

{"enableRestrictedFeaturesSet":false,"features":{"enableAndroidClient":false,"enableBandwidthControl":false,"enableBlackBerryClient":false,"enableDotNETStandardClient":false,"enableFlashClient":false,"enableFlexClient":false,"enableGenericClient":false,"enableIOSClient":false,"enableJavaMEClient":false,"enableJavaSEClient":false,"enableJavascriptClient":false,"enableJmx":false,"enableMacOSClient":false,"enableMpn":true,"enableNodeJsClient":false,"enablePythonClient":false,"enableSilverlightClient":false,"enableTlsSsl":false,"enableTvOSClient":false,"enableVisionOSClient":false,"enableWatchOSClient":false,"maxDownstreamRate":"1"}}

license.enterprise.optionalFeatures.enableRestrictedFeaturesSet

Optional. Restrict the feature set with respect to the license in use. If set to true, use the feature set detailed in features. If a required feature is not allowed by the license in use, the server will not start. If set to false, use the feature set specified by the license in use.

Type: bool

Default: false

license.enterprise.optionalFeatures.features

Mandatory if enableRestrictedFeaturesSet is set to true. Set of features to enable for the ENTERPRISE edition The DEMO, EVALUATION, and STARTUP license types by default allow all the optional features. For the other license types, the allowed optional features are determined by the specific license in use. You cannot turn on features that are not allowed by the license in use (the server would not start in such case). But you can turn off any feature that is allowed by the license in use. To know more, open the Welcome Page or the Monitoring Dashboard (Edition tab) of the running Lightstreamer Server.

Type: object

Default:

{"enableAndroidClient":false,"enableBandwidthControl":false,"enableBlackBerryClient":false,"enableDotNETStandardClient":false,"enableFlashClient":false,"enableFlexClient":false,"enableGenericClient":false,"enableIOSClient":false,"enableJavaMEClient":false,"enableJavaSEClient":false,"enableJavascriptClient":false,"enableJmx":false,"enableMacOSClient":false,"enableMpn":true,"enableNodeJsClient":false,"enablePythonClient":false,"enableSilverlightClient":false,"enableTlsSsl":false,"enableTvOSClient":false,"enableVisionOSClient":false,"enableWatchOSClient":false,"maxDownstreamRate":"1"}

license.proxy

Optional. Configure a proxy server for outbound Internet access, if necessary. Internet access is needed, depending on the above configuration, to reach the Online License Manager, to upload audit logs, and to check for software updates. The hostnames below must be reachable from the proxy on port 443: - https://clm1.lightstreamer.com/ (depending on the configuration) - https://clm2.lightstreamer.com/ (depending on the configuration) - https://service.lightstreamer.com/ (regardless of the configuration) Several methods are available for the proxy configuration, including PAC files, autodiscovery, and direct HTTP and SOCKS setup.

Type: object

Default:

{"enableProxyAutodiscovery":false,"httpProxies":[{"credentialsSecretRef":null,"host":null,"port":null,"scheme":null}],"networkInterface":null,"pacFiles":{"filePaths":[],"fileUrls":[]},"socksProxies":[{"credentialsSecretRef":null,"host":null,"port":null,"version":null}]}

Default:

{"defaultServer":{"backlog":null,"clientIdentification":{"enableForwardsLogging":false,"enablePrivate":true,"enableProxyProtocol":false,"proxyProtocolTimeoutMillis":1000,"skipLocalForwards":0},"enableHttps":false,"enabled":true,"listeningInterface":null,"name":"Lightstreamer HTTP Server","port":8080,"portType":"GENERAL_PURPOSE","responseHttpHeaders":{"add":[{"name":"X-Accel-Buffering","value":"no"}],"echo":[]},"sslConfig":{"allowCipherSuites":[],"allowProtocols":[],"enableClientAuth":false,"enableClientHintsForTlsSessionResumption":false,"enableMandatoryClientAuth":false,"enableStatelessTlsSessionResumption":null,"enableTlsRenegotiation":true,"enforceServerCipherSuitePreference":{"enabled":true,"order":"JVM"},"keystoreRef":"myServerKeystore","removeCipherSuites":[],"removeProtocols":[],"tlsProvider":null,"tlsSessionCacheSize":null,"tlsSessionTimeoutSeconds":null,"truststoreRef":null}}}

servers.defaultServer

The default HTTP server socket configuration.

Type: object

Default:

{"backlog":null,"clientIdentification":{"enableForwardsLogging":false,"enablePrivate":true,"enableProxyProtocol":false,"proxyProtocolTimeoutMillis":1000,"skipLocalForwards":0},"enableHttps":false,"enabled":true,"listeningInterface":null,"name":"Lightstreamer HTTP Server","port":8080,"portType":"GENERAL_PURPOSE","responseHttpHeaders":{"add":[{"name":"X-Accel-Buffering","value":"no"}],"echo":[]},"sslConfig":{"allowCipherSuites":[],"allowProtocols":[],"enableClientAuth":false,"enableClientHintsForTlsSessionResumption":false,"enableMandatoryClientAuth":false,"enableStatelessTlsSessionResumption":null,"enableTlsRenegotiation":true,"enforceServerCipherSuitePreference":{"enabled":true,"order":"JVM"},"keystoreRef":"myServerKeystore","removeCipherSuites":[],"removeProtocols":[],"tlsProvider":null,"tlsSessionCacheSize":null,"tlsSessionTimeoutSeconds":null,"truststoreRef":null}}

servers.defaultServer.backlog

Optional. Size of the system buffer for incoming TCP connections Overrides the default system setting.

Type: int

Default: the system setting

servers.defaultServer.clientIdentification

Optional. Settings that allow for better recognition of the remote address of the connected clients. This can be done in two ways: - By taking advantage of the X-Forwarded-For HTTP header, that intermediate HTTP proxies and level-7 Load Balancers usually set to supply connection routing information in an incremental way (this is done through the skipLocalForwards setting). - By receiving the routed address directly from a TCP reverse proxy or level-4 Load Balancer through the Proxy Protocol, when the proxy is configured to do so (this is done through the enableProxyProtocol setting). The two techniques can also coexist, but, in that case, the address through the proxy protocol would always be considered as the real client address and all addresses in the chain specified in X-Forwarded-For would be considered as written by client-side proxies. The address determined in this way will be used in all cases in which the client address is reported or checked. For logging purposes, the connection endpoint will still be written, but the real remote address, if available and different, will be added. The detected address may also be sent to the clients, depending on the Client SDK in use.

Type: object

Default:

{"enableForwardsLogging":false,"enablePrivate":true,"enableProxyProtocol":false,"proxyProtocolTimeoutMillis":1000,"skipLocalForwards":0}

{"add":[{"name":"X-Accel-Buffering","value":"no"}],"echo":[]}

servers.defaultServer.responseHttpHeaders.add

Optional. Requests to add to the HTTP response header a line with the specified name (mandatory) and value (optional). The suggested setting for X-Accel-Buffering may help to enable streaming support when proxies of several types are involved.

Type: list

Default: [{"name":"X-Accel-Buffering","value":"no"}]

servers.defaultServer.responseHttpHeaders.echo

Optional. Requests to look for any header lines for the specified field name on the HTTP request header and to copy them to the HTTP response header.

Type: list

Default: []

servers.defaultServer.sslConfig

Mandatory if enableHttps is true. TLS/SSL settings for this socket configuration.

Type: object

Default:

{"allowCipherSuites":[],"allowProtocols":[],"enableClientAuth":false,"enableClientHintsForTlsSessionResumption":false,"enableMandatoryClientAuth":false,"enableStatelessTlsSessionResumption":null,"enableTlsRenegotiation":true,"enforceServerCipherSuitePreference":{"enabled":true,"order":"JVM"},"keystoreRef":"myServerKeystore","removeCipherSuites":[],"removeProtocols":[],"tlsProvider":null,"tlsSessionCacheSize":null,"tlsSessionTimeoutSeconds":null,"truststoreRef":null}

servers.defaultServer.sslConfig.allowCipherSuites

Optional, but forbidden if removeCipherSuites is used. Specifies all the cipher suites allowed for the TLS/SSL interaction, provided that they are included, with the specified name, in the set of "supported" cipher suites of the underlying Security Provider. The default set of the "supported" cipher suites is logged at startup by the logging.loggers.lightstreamerLogger.subLoggers.io.ssl logger at DEBUG level. If not used, the removeCipherSuites setting is considered; hence, if removeCipherSuites is also not used, all cipher suites enabled by the Security Provider will be available. The order in which the cipher suites are specified can be enforced as the server-side preference order (see enforceServerCipherSuitePreference).

Type: list

Default: []

servers.defaultServer.sslConfig.allowProtocols

Optional, but forbidden if removeProtocols is used. Specifies one or more protocols allowed for the TLS/SSL interaction, among the ones supported by the underlying Security Provider. For Oracle JVMs, the available names are the "SSLContext Algorithms" listed here: https://docs.oracle.com/en/java/javase/17/docs/specs/security/standard-names.html#sslcontext-algorithms If not specified, the removeProtocols setting is considered; hence, if removeProtocols is also not used, all protocols enabled by the Security Provider will be available.

Type: list

Default: []

servers.defaultServer.sslConfig.enableClientAuth

Optional. If enabled, the client must provide the Metadata Adapter with the "principal" included in the client TLS/SSL certificate, when available. If set to true, upon each client connection, the availability of a client TLS/SSL certificate is checked. If available, the included identification data will be supplied upon calls to notifyUser. If set to false, no certificate information is supplied to notifyUser and no check is done on the client certificate. Note that a check on the client certificate can also be requested through enableMandatoryClientAuth.

Type: bool

Default: false

servers.defaultServer.sslConfig.enableClientHintsForTlsSessionResumption

Optional. If set to true, tries to improve the TLS session resumption feature by providing the underlying Security Provider with information on the client IPs and ports. This makes sense only if client IPs can be determined (see servers.{}.clientIdentification).

Type: bool

Default: false

servers.defaultServer.sslConfig.enableMandatoryClientAuth

Optional. Request to only allow clients provided with a valid TLS/SSL certificate. If set to true, upon each client connection, a valid TLS/SSL certificate is requested to the client in order to accept the connection. If set to false, no check is done on the client certificate. Note that a certificate can also be requested to the client as a consequence of enableClientAuth.

Type: bool

Default: false

servers.defaultServer.sslConfig.enableStatelessTlsSessionResumption

Optional. Instructs the underlying Security Provider on whether to use stateless (when true) or stateful (when false) session resumption on this port, if supported (possibly depending on the protocol version in use). Note that stateful resumption implies the management of a TLS session cache, whereas stateless resumption is slightly more demanding in terms of CPU and bandwidth. Note, however, that this setting is currently supported only if the Conscrypt Security Provider is used. For instance, with the default SunJSSE Security Provider, the use of stateful or stateless resumption can only be configured at global JVM level, through the jdk.tls.server.enableSessionTicketExtension JVM property. If not specified, the type of resumption will be decided by the underlying Security Provider, based on its own configuration.

Type: string

Default: nil

servers.defaultServer.sslConfig.enableTlsRenegotiation

Optional. If set to false, causes any client-initiated TLS renegotiation request to be refused by closing the connection. This policy may be evaluated in a trade-off between encryption strength and performance risks. Note that, with the default SunJSSE Security Provider, a better way to achieve the same at a global JVM level is by setting the dedicated jdk.tls.rejectClientInitiatedRenegotiation JVM property to true.

Type: bool

Default: true

servers.defaultServer.sslConfig.enforceServerCipherSuitePreference

Optional. Determines which side should express the preference when multiple cipher suites are in common between server and client. Note, however, that the underlying Security Provider may ignore this setting. This is the case, for instance, of the Conscrypt provider.

Type: object

Default: {"enabled":true,"order":"JVM"}

servers.defaultServer.sslConfig.enforceServerCipherSuitePreference.enabled

Optional. If set to true, the Server will choose the cipher suite based on its preference order, specified through order. If set to false, the Server will get a cipher suite based on the preference order specified by the client. For instance, the client might privilege faster, but weaker, suites.

Type: bool

Default: true

servers.defaultServer.sslConfig.enforceServerCipherSuitePreference.order

Optional. Preference order for choosing the cipher suite. If set to JVM, ordering is delegated to the underlying Security Provider, which, usually, prioritizes the strongest suites. If set to config (which is allowed only if allowCipherSuites is used), the order in which the allowCipherSuites elements are specified determines the preference order.

Type: string

Default: "JVM"

servers.defaultServer.sslConfig.keystoreRef

Mandatory. The reference to a keystore configuration (defined in keystores). The access to the included certificates is subject to the following constraints: - Only the first certificated found in the keystore ca be sent to the client. - The password for the keystore and the password of the included certificate should be the same. - The support of keystore contents may depend on the Security Provider in use; for instance, keystores with dual RSA/ECC certificates are not fully supported by the Conscrypt provider. See the keystores.myServerKeystore settings for general details on keystore configuration.

Type: string

Default: "myServerKeystore"

servers.defaultServer.sslConfig.removeCipherSuites

Optional, but forbidden if allowCipherSuites is used. Pattern to be matched against the names of the enabled cipher suites in order to remove the matching ones from the enabled cipher suites set. Any pattern in java.util.regex.Pattern format can be specified. This allows for customization of the choice of the cipher suites to be used for incoming https connections (note that restricting the set of available cipher suites may cause some client requests to be rejected). When this setting is used, the server-side preference order of the cipher suites is determined by the underlying Security Provider. Note that the selection is operated on the default set of the cipher suites "enabled" by the Security Provider, not on the wider set of the "supported" cipher suites. The default set of the "enabled" cipher suites is logged at startup by the logging.loggers.lightstreamerLogger.subLoggers.io.ssl logger at DEBUG level.

Type: list

Default: []

servers.defaultServer.sslConfig.removeProtocols

Optional, but forbidden if allowProtocols is used. Pattern to be matched against the names of the enabled TLS/SSL protocols in order to remove the matching ones from the enabled protocols set. Any pattern in java.util.regex.Pattern format can be specified. This allows for customization of the choice of the TLS/SSL protocols to be used for an incoming https connection (note that reducing the set of available protocols may cause some client requests to be refused). Note that the selection is operated on the default set of the protocols "enabled" by the Security Provider, not on the wider set of the "supported" protocols. The default set of the "enabled" protocols is logged at startup by the logging.loggers.lightstreamerLogger.subLoggers.io.ssl logger at DEBUG level.

Type: list

Default: []

servers.defaultServer.sslConfig.tlsProvider

Optional. If defined, overrides the default JVM's Security Provider configured in the java.security file of the JDK installation. This allows the use of different Security Providers dedicated to single listening ports. When configuring a Security Provider, the related libraries should be added to the Server classpath. This is not needed for the Conscrypt provider, which is already available in the Server distribution (but note that the library includes native code that only targets the main platforms).

Type: string

Default: the default JVM's Security Provider

servers.defaultServer.sslConfig.tlsSessionCacheSize

Optional. Size of the cache used by the TLS implementation to handle TLS session resumptions when stateful resumption is configured (see enableStatelessTlsSessionResumption). A value of 0 means no size limit. Note, however, that the underlying Security Provider may ignore this setting (possibly depending on the protocol version in use). If not specified, the cache size is decided by the underlying Security Provider. For the default SunJSSE, it is 20480 TLS sessions, unless configured through the javax.net.ssl.sessionCacheSize JVM property. If not specified, decided by the underlying Security Provider's configuration.

Type: int

Default: nil

servers.defaultServer.sslConfig.tlsSessionTimeoutSeconds

Optional. Maximum time in which a TLS session is kept available to the client for resumption. This holds for both stateless and stateful TLS resumption (see enableStatelessTlsSessionResumption). In the latter case, the session also has to be kept in a cache. A value of 0 means no time limit. Note, however, that the underlying Security Provider may ignore this setting (possibly depending on the protocol version in use). If not specified, the maximum time is decided by the underlying Security Provider. For the default SunJSSE, it is 86400 seconds, unless configured through the jdk.tls.server.sessionTicketTimeout JVM property.

Type: int

Default: nil

servers.defaultServer.sslConfig.truststoreRef

Mandatory if at least one of enableClientAuth and enableMandatoryClientAuth is set to true. The reference to a keystore to be used by the HTTPS service to accept client certificates. It can be used to supply client certificates that should be accepted, in addition to those with a valid certificate chain, for instance while testing with self-signed certificates. See keystoreRef and keystores.myServerKeystore for further details about keystore configuration. Note that the further constraints reported there with regard to accessing the certificates in a JKS keystore don't hold in this case, where the latter is used as a truststore. Moreover, the handling of keystore replacement doesn't apply here.

Type: string

Default: nil

Keystores settings

keystores

Map of Keystores definition. Every entry in the map defines a specific keystore configuration, which can then be referenced through the whole configuration.

Type: object

Default:

{"myServerKeystore":{"keyPasswordSecretRef":null,"keystoreFileSecretRef":{"key":"myserver.keystore","name":"myserver-keystore-secret"},"keystorePasswordSecretRef":{"key":"myserver-keystore.keypass","name":"myserver-keystore-keypass-secret"},"type":"JKS"}}

keystores.myServerKeystore

Example of Keystore definition used by HTTPS server socket configurations and other settings that require a keystore. The default values used here reference the JKS keystore file myserver.keystore, which is provided out of the box (and stored in the myserver-keystore-secret secret, along with the password stored in the myserver-keystore-keypass-secret secret), and obviously contains an invalid certificate. In order to use it for your experiments, remember to add a security exception to your browser. This example can be used as a template to define your own keystore configurations.

Type: object

Default:

{"keyPasswordSecretRef":null,"keystoreFileSecretRef":{"key":"myserver.keystore","name":"myserver-keystore-secret"},"keystorePasswordSecretRef":{"key":"myserver-keystore.keypass","name":"myserver-keystore-keypass-secret"},"type":"JKS"}

keystores.myServerKeystore.keyPasswordSecretRef

Optional. Secret name and key where the password of the private key in the keystore is stored.

Type: string

Default: nil

keystores.myServerKeystore.keystoreFileSecretRef

Mandatory if type is set to JKS or PKCS12. Secret name and key where the keystore file is stored.

Type: object

Default:

{"key":"myserver.keystore","name":"myserver-keystore-secret"}

keystores.myServerKeystore.keystorePasswordSecretRef

Mandatory if type is set to JKS or PKCS12. Secret name and key where keystore password is stored.

Type: object

Default:

{"key":"myserver-keystore.keypass","name":"myserver-keystore-keypass-secret"}

keystores.myServerKeystore.type

Optional. The keystore type. The currently supported types are: - JKS, which is the Sun/Oracle's custom keystore type, whose support is made available by every Java installation. - PKCS12, which is supported by all recent Java installations. - PKCS11, which as a bridge to an external PKCS11 implementation; this is an experimental extension; contact Lightstreamer Support for details.

Type: string

Default: "JKS"

Logging settings

logging

Mandatory. Logging configuration for the Lightstreamer Broker.

Type: object

Default:

{"appenders":{"console":{"pattern":"%d{\"yyyy-MM-dd HH:mm:ss,SSS\"}|%-5.5(%p%marker)|%m%n","type":"Console"},"dailyRolling":{"fileName":"lightstreamer.log","fileNamePattern":"lightstreamer-%d{yyyy-MM-dd}.log","pattern":"%d{\"dd-MMM-yy HH:mm:ss,SSS\"}|%-5.5(%p%marker)|%-19.19c{19}|%-27.27t|%m%n","type":"DailyRollingFile","volumeRef":null}},"extraLoggers":null,"loggers":{"com.github.markusbernhardt.proxy":{"appenders":["console"],"level":"WARN"},"com.google":{"appenders":["console"],"level":"ERROR"},"com.sun.jmx.remote":{"appenders":["console"],"level":"ERROR"},"com.turo":{"appenders":["console"],"level":"ERROR"},"com.zaxxer.hikari":{"appenders":["console"],"level":"INFO"},"common.jmx.velocity":{"appenders":["console"],"level":"ERROR"},"io.grpc":{"appenders":["console"],"level":"WARN"},"io.netty":{"appenders":["console"],"level":"ERROR"},"io.opencensus":{"appenders":["console"],"level":"WARN"},"java.sql":{"appenders":["console"],"level":"WARN"},"javax.management.mbeanserver":{"appenders":["console"],"level":"ERROR"},"javax.management.remote":{"appenders":["console"],"level":"ERROR"},"javax.net.ssl":{"appenders":["console"],"level":"OFF"},"lightstreamerHealthCheck":{"appenders":["console"],"level":"INFO"},"lightstreamerLogger":{"appenders":["console"],"level":"INFO","subLoggers":{"connections":"WARN","connections.WS":"WARN","connections.http":"ERROR","connections.proxy":"INFO","connections.ssl":"WARN","external":"INFO","init":"INFO","io":"WARN","io.ssl":"WARN","kernel":"INFO","license":"INFO","monitoring":"INFO","mpn":"INFO","mpn.apple":"WARN","mpn.database":"WARN","mpn.database.transactions":"WARN","mpn.google":"WARN","mpn.lifecycle":"INFO","mpn.operations":"INFO","mpn.pump":"WARN","mpn.requests":"WARN","mpn.status_adapters":"WARN","preprocessor":"INFO","pump":"INFO","pump.messages":"INFO","push":"INFO","requests":"INFO","requests.messages":"INFO","requests.polling":"WARN","scheduler":"INFO","subscriptions":"INFO","subscriptions.upd":"INFO","webServer":"WARN","webServer.appleWebService":"WARN","webServer.jmxTree":"WARN","webclient":"DEBUG"}},"lightstreamerMonitorTAB":{"appenders":["console"],"level":"ERROR"},"lightstreamerMonitorText":{"appenders":["console"],"level":"INFO"},"lightstreamerProxyAdapters":{"appenders":["console"],"level":"INFO"},"org.apache.http":{"appenders":["console"],"level":"ERROR"},"org.codehaus.janino":{"appenders":["console"],"level":"WARN"},"org.conscrypt":{"appenders":["console"],"level":"ERROR"},"org.hibernate":{"appenders":["console"],"level":"WARN"},"org.jboss.logging":{"appenders":["console"],"level":"WARN"},"org.jminix":{"appenders":["console"],"level":"ERROR"},"org.restlet":{"appenders":["console"],"level":"ERROR"}}}

logging.appenders

Optional. Map of appenders configuration. Every entry in the map defines a specific appender configuration. Every logger must refer to one or more appenders defined here.

Type: object

Default:

{"console":{"pattern":"%d{\"yyyy-MM-dd HH:mm:ss,SSS\"}|%-5.5(%p%marker)|%m%n","type":"Console"},"dailyRolling":{"fileName":"lightstreamer.log","fileNamePattern":"lightstreamer-%d{yyyy-MM-dd}.log","pattern":"%d{\"dd-MMM-yy HH:mm:ss,SSS\"}|%-5.5(%p%marker)|%-19.19c{19}|%-27.27t|%m%n","type":"DailyRollingFile","volumeRef":null}}

logging.appenders.console

The console appender configuration.

Type: object

Default:

{"pattern":"%d{\"yyyy-MM-dd HH:mm:ss,SSS\"}|%-5.5(%p%marker)|%m%n","type":"Console"}

logging.appenders.dailyRolling

An appender configuration. You can use this configuration as a template to define your own appender configurations. In particular, dailyRolling defines a daily rolling file appender.

Type: object

Default:

{"fileName":"lightstreamer.log","fileNamePattern":"lightstreamer-%d{yyyy-MM-dd}.log","pattern":"%d{\"dd-MMM-yy HH:mm:ss,SSS\"}|%-5.5(%p%marker)|%-19.19c{19}|%-27.27t|%m%n","type":"DailyRollingFile","volumeRef":null}

logging.loggers

Optional. Loggers configuration.

Type: object

Default:

{"com.github.markusbernhardt.proxy":{"appenders":["console"],"level":"WARN"},"com.google":{"appenders":["console"],"level":"ERROR"},"com.sun.jmx.remote":{"appenders":["console"],"level":"ERROR"},"com.turo":{"appenders":["console"],"level":"ERROR"},"com.zaxxer.hikari":{"appenders":["console"],"level":"INFO"},"common.jmx.velocity":{"appenders":["console"],"level":"ERROR"},"io.grpc":{"appenders":["console"],"level":"WARN"},"io.netty":{"appenders":["console"],"level":"ERROR"},"io.opencensus":{"appenders":["console"],"level":"WARN"},"java.sql":{"appenders":["console"],"level":"WARN"},"javax.management.mbeanserver":{"appenders":["console"],"level":"ERROR"},"javax.management.remote":{"appenders":["console"],"level":"ERROR"},"javax.net.ssl":{"appenders":["console"],"level":"OFF"},"lightstreamerHealthCheck":{"appenders":["console"],"level":"INFO"},"lightstreamerLogger":{"appenders":["console"],"level":"INFO","subLoggers":{"connections":"WARN","connections.WS":"WARN","connections.http":"ERROR","connections.proxy":"INFO","connections.ssl":"WARN","external":"INFO","init":"INFO","io":"WARN","io.ssl":"WARN","kernel":"INFO","license":"INFO","monitoring":"INFO","mpn":"INFO","mpn.apple":"WARN","mpn.database":"WARN","mpn.database.transactions":"WARN","mpn.google":"WARN","mpn.lifecycle":"INFO","mpn.operations":"INFO","mpn.pump":"WARN","mpn.requests":"WARN","mpn.status_adapters":"WARN","preprocessor":"INFO","pump":"INFO","pump.messages":"INFO","push":"INFO","requests":"INFO","requests.messages":"INFO","requests.polling":"WARN","scheduler":"INFO","subscriptions":"INFO","subscriptions.upd":"INFO","webServer":"WARN","webServer.appleWebService":"WARN","webServer.jmxTree":"WARN","webclient":"DEBUG"}},"lightstreamerMonitorTAB":{"appenders":["console"],"level":"ERROR"},"lightstreamerMonitorText":{"appenders":["console"],"level":"INFO"},"lightstreamerProxyAdapters":{"appenders":["console"],"level":"INFO"},"org.apache.http":{"appenders":["console"],"level":"ERROR"},"org.codehaus.janino":{"appenders":["console"],"level":"WARN"},"org.conscrypt":{"appenders":["console"],"level":"ERROR"},"org.hibernate":{"appenders":["console"],"level":"WARN"},"org.jboss.logging":{"appenders":["console"],"level":"WARN"},"org.jminix":{"appenders":["console"],"level":"ERROR"},"org.restlet":{"appenders":["console"],"level":"ERROR"}}

logging.loggers.lightstreamerHealthCheck

Management settings

management

Mandatory. Logging and management configuration.

Type: object

Default:

{"asyncProcessingThresholdMillis":60000,"collectorMillis":2000,"dashboard":{"availableOnServers":[{"enableJmxTreeVisibility":true,"serverRef":"defaultServer"}],"credentials":[{"enableJmxTreeVisibility":true,"secretRef":"dashboard-user-secret"}],"enableAvailabilityOnAllServers":true,"enableHostnameLookup":false,"enableJmxTree":true,"enablePublicAccess":true,"enabled":true,"urlPath":"/dashboard"},"enablePasswordVisibilityOnRequestLog":false,"enableStoppingServiceCheck":false,"healthCheck":{"availableOnServers":[],"enableAvailabilityOnAllServers":false,"enabled":true},"jmx":{"enableLongListProperties":true,"jmxmpConnector":{"enabled":false,"port":null},"rmiConnector":{"credentialsSecrets":[],"dataPort":{"enableSsl":null,"value":null},"enablePortTest":true,"enablePublicAccess":false,"enabled":true,"hostname":null,"listeningInterface":null,"port":{"enableSsl":false,"value":8888},"sslConfig":{"allowCipherSuites":[],"allowProtocols":[],"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":[],"removeProtocols":[]},"testTimeoutMillis":5000},"sessionMbeanAvailability":"inactive"},"maxTaskWaitMillis":10000,"noLoggingIpAddresses":[],"unexpectedWaitThresholdMillis":0}

management.asyncProcessingThresholdMillis

Optional. Threshold time for long asynchronous processing alerts. Data and Metadata Adapter calls, even when performed through asynchronous invocations (where available), should still take a reasonable time to complete. This is especially important if limits to the number of concurrent tasks are set; moreover, tasks forgotten for any reason and never completed may cause a memory leak. Hence, the longest current execution time is periodically sampled by the Server Monitor on each pool and, whenever it exceeds this threshold on a pool, a warning is logged. Note that warning messages can be issued repeatedly. A 0 value disables the check.

Type: int

Default: 60000

management.collectorMillis

Mandatory. Sampling time for internal load statistics (Server Monitor). These statistics are available through the JMX interface; some of these statistics are logged by the Internal Monitor log or can be subscribed to through the internal Monitoring Adapter Set. Full JMX features is an optional feature, available depending on Edition and License Type.

Type: int

Default: 2000

management.dashboard

Mandatory. Configuration of the Monitoring Dashboard. The Monitoring Dashboard is a webapp whose pages are embedded in the Lightstreamer Broker and supplied by the internal web server. The main page has several tabs, which provide basic monitoring statistics in graphical form; the last one shows the newly introduced JMX Tree, which enables JMX data viewing and management from the browser. The Dashboard leans on an internal Adapter Set, named "MONITOR". The following settings configure access restrictions to Monitoring Dashboard pages. IMPORTANT. The Monitoring Dashboard enables data viewing and management, including shutting down the Server from a remote browser. We recommend configuring the credentials and restricting the Monitoring Monitoring Dashboard access to HTTPS server sockets through the settings below. Further restrictions can be applied to the JMX Tree only. See PRODUCTION_SECURITY_NOTES.TXT for a full check-list. Note that basic monitoring statistics are also available to any Lightstreamer application; in fact, an instance of a special internal monitoring Data Adapter can be embedded in any custom Adapter Set, by specifying "MONITOR" in place of the Data Adapter class name. For a listing of the supplied items, see the General Concepts document. The dashboard.enableHostnameLookup setting below also affects the monitoring Data Adapter. On the other hand, access restrictions to a monitoring Data Adapter instance embedded in a custom Adapter Set is only managed by the custom Metadata Adapter included.

Type: object

Default:

{"availableOnServers":[{"enableJmxTreeVisibility":true,"serverRef":"defaultServer"}],"credentials":[{"enableJmxTreeVisibility":true,"secretRef":"dashboard-user-secret"}],"enableAvailabilityOnAllServers":true,"enableHostnameLookup":false,"enableJmxTree":true,"enablePublicAccess":true,"enabled":true,"urlPath":"/dashboard"}

management.dashboard.availableOnServers

Optional, but ineffective if enableAvailabilityOnAllServers is set to true. List of server socket configurations (defined in servers.{}) for which requests to the Monitoring Dashboard will be allowed.

Type: list

Default:

[{"enableJmxTreeVisibility":true,"serverRef":"defaultServer"}]

management.dashboard.availableOnServers[0].enableJmxTreeVisibility

Optional, but effective only if dashboard.enableJmxTree is set to true. Allows for restriction of the access to the JMX Tree on a TCP port basis.

Type: bool

Default: true

management.dashboard.availableOnServers[0].serverRef

Mandatory. The reference to the allowed server socket configuration.

Type: string

Default: "defaultServer"

management.dashboard.credentials

Optional, but ineffective if enablePublicAccess is set to true. Credentials of users authorized to access the Monitoring Dashboard. If enablePublicAccess is set to false, at least one set of credentials should be supplied in order to allow access through the connector.

Type: list

Default:

[{"enableJmxTreeVisibility":true,"secretRef":"dashboard-user-secret"}]

management.healthCheck

Mandatory. Configuration of the /lightstreamer/healthcheck request url, which allows a load balancer to test for Server responsiveness to external requests. The Server should always respond to the request with the OK\r\n content string (unless overridden through e JMX interface). The Server may log further information to the dedicated lightstreamerHealthCheck logger. Support for clustering is an optional feature, available depending on Edition and License Type.

Type: object

Default:

{"availableOnServers":[],"enableAvailabilityOnAllServers":false,"enabled":true}

management.healthCheck.availableOnServers

Optional, but ineffective if enableAvailabilityOnAllServers is set to false. List of server socket configurations (defined in servers.{}) for which health check requests can be issued.

Type: list

Default: []

management.healthCheck.enableAvailabilityOnAllServers

Optional. Enables the health check url on all server sockets. If set to true, the health check request can be issued through all the defined server sockets. If set to false, the health check request can be issued only through the server sockets specified in the availableOnServers setting, if any.

Type: bool

Default: false

management.healthCheck.enabled

Optional. Enables the health check url.

Type: bool

Default: true

management.jmx

Mandatory. JMX preferences and external access configuration. Full JMX features is an optional feature, available depending on Edition and License Type; if not available, only the Server shutdown operation via JMX is allowed. To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default, available at /dashboard).

Type: object

Default:

{"enableLongListProperties":true,"jmxmpConnector":{"enabled":false,"port":null},"rmiConnector":{"credentialsSecrets":[],"dataPort":{"enableSsl":null,"value":null},"enablePortTest":true,"enablePublicAccess":false,"enabled":true,"hostname":null,"listeningInterface":null,"port":{"enableSsl":false,"value":8888},"sslConfig":{"allowCipherSuites":[],"allowProtocols":[],"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":[],"removeProtocols":[]},"testTimeoutMillis":5000},"sessionMbeanAvailability":"inactive"}

management.jmx.enableLongListProperties

Optional. Enables all properties provided by the various MBeans. This flag could potentially cause MBeans to return extremely long lists. In fact, various JMX agents extract the property values from the MBeans altogether; but extremely long values may clutter the agent and prevent also the acquisition of other properties. This issue may also affect the JMX Tree. For all these properties, corresponding operations are also provided. If set to true, all list properties are enabled; in some cases, their value may be an extremely long list; consider, for instance, CurrentSessionList in the ResourceMBean. If set to false, properties that can, potentially, return extremely long lists won't yield the correct value, but just a reminder text; for instance, this applies to CurrentSessionList in the ResourceMBean.

Type: bool

Default: true

management.jmx.jmxmpConnector

Optional. JMXMP connector configuration. The connector is supported by the Server only if Sun/Oracle's JMXMP implementation library is added to the Server classpath; see README.TXT in the JMX SDK for details. The remote server will be accessible through the url: service:jmx:jmxmp://<host>:<jmxmpConnector.port>.

Type: object

Default: {"enabled":false,"port":null}

management.jmx.jmxmpConnector.enabled

Optional. Enables Sun/Oracle's JMXMP connector.

Type: bool

Default: false

management.jmx.jmxmpConnector.port

Mandatory if enabled is set to true. TCP port on which Sun/Oracle's JMXMP connector will be listening. This is the port that has to be specified in the client access url.

Type: int

Default: nil

management.jmx.rmiConnector

Mandatory. Enables the standard RMI Connector, which is used by the provided "stop" script to stop the Server. The remote MBean server will be accessible through this url: service:jmx:rmi:///jndi/rmi://<host>:<port>/lsjmx. If full JMX features is not available, only the Server MBean is supplied and only the Server shutdown operation is available. The JVM platform MBean server is also exposed and it is accessible through the url: service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi. Note that the configuration of the connector applies to both cases; hence, access to the JVM platform MBean server from this connector is not configured through the com.sun.management.jmxremote JVM properties. Also note that TLS/SSL is an optional feature, available depending on Edition and License Type. To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default, available at /dashboard).

Type: object

Default:

{"credentialsSecrets":[],"dataPort":{"enableSsl":null,"value":null},"enablePortTest":true,"enablePublicAccess":false,"enabled":true,"hostname":null,"listeningInterface":null,"port":{"enableSsl":false,"value":8888},"sslConfig":{"allowCipherSuites":[],"allowProtocols":[],"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":[],"removeProtocols":[]},"testTimeoutMillis":5000}

management.jmx.rmiConnector.sslConfig

Mandatory if rmiConnector.enableSsl or rmiConnector.dataPort.enableSsl is set to true. TLS/SSL settings for the RMI Connector.

Type: object

Default:

{"allowCipherSuites":[],"allowProtocols":[],"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":[],"removeProtocols":[]}

Default:

{"handshakeTimeoutMillis":4000,"readTimeoutMillis":20000,"requestLimit":50000,"webSocket":{"maxClosingWaitMillis":null,"maxOutboundFrameSize":16384,"maxPongDelayMillis":0},"writeTimeoutMillis":120000}

globalSocket.handshakeTimeoutMillis

Optional. Longest inactivity time accepted while waiting for a slow operation during a TLS/SSL handshake. This involves both reads, writes, and encryption tasks managed by the TLS-SSL HANDSHAKE or TLS-SSL AUTHENTICATION internal pools. If this value is exceeded, the socket is closed. The time actually considered may be approximated and may be a few seconds higher, for internal performance reasons. A 0 value suppresses the check.

Type: int

Default: 4000

globalSocket.readTimeoutMillis

Mandatory. Longest inactivity time accepted while waiting for a slow request to be received. If this value is exceeded, the socket is closed. Reusable HTTP connections are also closed if they are not reused for longer than this time. The time actually considered may be approximated and may be a few seconds higher, for internal performance reasons. A 0 value suppresses the check.

Type: int

Default: 20000

globalSocket.requestLimit

Optional. Maximum length in bytes accepted for a request. For an HTTP GET request, the limit applies to the whole request, including the headers. For an HTTP POST request, the limit applies to the header part and the body part separately. For a request over a WebSocket, the limit applies to the request message payload. If not specified, the check is suppressed.

Type: int

Default: 50000

globalSocket.webSocket

Mandatory. WebSocket support configuration.

Type: object

Default:

{"maxClosingWaitMillis":null,"maxOutboundFrameSize":16384,"maxPongDelayMillis":0}

globalSocket.webSocket.maxClosingWaitMillis

Optional. Maximum time the Server is allowed to wait for the client "close" frame, in case the Server is sending its own close" frame first, in order to try to close the connection in a clean way. If not specified, no timeout is set and the global globalSocket.readTimeoutMillis value applies.

Type: int

Default: nil

globalSocket.webSocket.maxOutboundFrameSize

Optional. Maximum payload size allowed for an outbound frame. When larger updates have to be sent, the related WebSocket messages will be split into multiple frames. The Server may enforce a lower limit for this setting.

Type: int

Default: 16384

globalSocket.webSocket.maxPongDelayMillis

Optional. Maximum time the Server is allowed to wait before answering to a client "ping" request. In case a client sends very frequent "ping" requests, only the "pong" associated with the most recent request received is sent, while the previous requests will be ignored. Note that the above is possible also when 0 is specified.

Type: int

Default: 0

globalSocket.writeTimeoutMillis

Optional. Longest operation time accepted while writing data on a socket. If this value is exceeded, the socket is closed. Note that this may also affect very slow clients. The time actually considered may be approximated and may be a few seconds higher, for internal performance reasons. If not specified or 0, the check is suppressed.

Type: int

Default: 120000

Security settings

security

Mandatory. Security configuration.

Type: object

Default:

{"allowedDomains":[],"crossDomainPolicy":{"acceptCredentials":true,"acceptExtraHeaders":"","allowAccessFrom":{"fromEveryWhere":{"host":"*","port":"*","scheme":"*"}},"enabled":true,"optionsMaxAgeSeconds":3600},"enableCookiesForwarding":false,"enableProtectedJs":false,"serverIdentificationPolicy":"FULL"}

security.allowedDomains

Optional. List of Origin domains or subdomains to be allowed by the browsers to access data on HTML pages supplied by this Server. This was one of the ways used by the Web (Unified API) Client SDK earlier than 8.0.0 to request streaming data; see the Client Guide for these Web (Unified API) Client SDK versions for details on which use cases involve accessing data through HTML pages. In this kind of requests, the requesting page should be allowed by the browser to access data contained in the Server-originated page only if both pages declare a common subdomain. So, the page should declare a subdomain as its document.domain property and will ask the Server to declare the same subdomain on the response page. In that case, the Server will be allowed to set the requested subdomain as the document.domain property of the data page only if configured here, otherwise the whole request will be refused. On the other hand, if no setting is provided, then this check is disabled. Note that, in any case, the consistency of the declared subdomain with the url used to request the data page must be ensured by the browser. If the requesting page doesn't specify any subdomain for the response, the request will always be allowed; in this case, a same-domain access to the Server data page will be performed by the browser.

Type: list

Default: []

security.crossDomainPolicy

Optional. Configuration of the origins to be allowed by the browsers to consume responses to requests sent to this Server through cross-origin XHR or through WebSockets; in fact, when a requesting page asks for streaming data in this way, the browser should specify the page origin through the Origin HTTP header, to give the Server a chance to accept or refuse the request. This is the most common way streaming data is requested by the Web (Unified API) Client Library. You can see the Client Guide for the Web (Unified API) Client SDK earlier than 8.0.0 for details on all the possible use cases. If a request origin is not matched against any of the configured rules, a Websocket initiation request will be refused, whereas a HTTP request will not be denied (i.e.: a 200 OK will be returned) but the response body will be left empty, in accordance with the CORS specifications. If no origin is specified by the user-agent, the request will always be accepted. Note that sending the Origin header is a client-side duty. In fact, most modern browsers, upon a request for a cross-origin XHR or WebSocket by a page, will send the Origin header, while older browsers will directly fail to send the request. Non-browser clients usually don't have to perform origin checks; so they don't send the Origin header and thus their requests are always authorized.

Type: object

Default:

{"acceptCredentials":true,"acceptExtraHeaders":"","allowAccessFrom":{"fromEveryWhere":{"host":"*","port":"*","scheme":"*"}},"enabled":true,"optionsMaxAgeSeconds":3600}

security.crossDomainPolicy.acceptCredentials

Optional. Specify if the server should authorize the client to send its credentials on a CORS request. This setting does not impact the user/password sent over the Lightstreamer protocol, but, if set to false, might prevent, or force a fallback connection, on clients sending CORS requests carrying cookies, http-basic-authentication or client-side certificates.

Type: bool

Default: true

security.crossDomainPolicy.acceptExtraHeaders

Optional. In case the client wishes to send custom headers to the server, it requires approval from the server itself. This setting permits to specify a comma separated list of extra headers to be allowed in the client requests. Note that a space is expected after each comma (e.g.: acceptExtraHeaders: "custom-header1, custom-header2").

Type: string

Default: ""

security.crossDomainPolicy.allowAccessFrom

Optional. Map of Origins allowed to consume responses to cross-origin requests. Every entry in the map is a rule against which the Origin header will be checked.

Type: object

Default:

{"fromEveryWhere":{"host":"*","port":"*","scheme":"*"}}

Push Session settings

pushSession

Mandatory. Push session configuration.

Type: object

Default:

{"compressionThreshold":1024,"contentLength":{"default":4000000,"specialCases":null},"defaultDiffOrders":[],"defaultKeepaliveMillis":{"randomize":false,"value":5000},"enableDeltaDelivery":true,"enableEnrichedContentType":true,"jsonPatchMinLength":null,"maxBufferSize":1000,"maxDelayMillis":30,"maxIdleMillis":{"randomize":false,"value":30000},"maxKeepaliveMillis":30000,"maxPollingMillis":15000,"maxRecoveryLength":null,"maxRecoveryPollLength":-1,"maxStreamingMillis":null,"minInterPollMillis":null,"minKeepaliveMillis":1000,"missingMessageTimeoutMillis":30000,"preserveUnfilteredCommandOrdering":null,"reusePumpBuffers":"AUTO","sendbuf":null,"serviceUrlPrefixes":null,"sessionRecoveryMillis":13000,"sessionTimeoutMillis":10000,"subscriptionTimeoutMillis":5000,"useCompression":"AUTO"}

Mpn settings

mpn

Optional. Mobile Push Notification (MPN) module configuration. This module is able to receive updates from an item subscription on behalf of a user, and forward them to a mobile push notification service, such as Apple's APNs or Google's FCM. If not defined, the MPN module will not start in any case, and all requests related to mobile push notifications will be rejected. Mobile Push Notification support is an optional feature, available depending on Edition and License Type. To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default, available at /dashboard).

Type: object

Default:

{"activationOnStartUp":{"enabled":true,"maxDelayMillis":-1},"appleNotifierConfig":{"apps":{"myApp":{"enabled":false,"id":null,"keystoreRef":null,"pushPackageFileRef":null,"serviceLevel":"test","triggerExpressions":[]}},"connectionTimeoutMillis":30000,"keystores":{"myAppKeystore":{"keystoreFileSecretRef":null,"keystorePasswordSecretRef":null}},"maxConcurrentConnections":1,"minSendDelayMillis":null},"appleWebServicePath":null,"collectorPeriodMinutes":null,"deviceHandlerPool":{"maxFree":0,"maxSize":100},"deviceInactivityTimeoutMinutes":null,"enableModuleRecovery":null,"enabled":false,"executorPool":{"maxFree":0,"maxSize":10},"googleNotifierConfig":{"apps":{"myApp":{"enabled":false,"packageName":null,"serviceJsonFileRef":null,"serviceLevel":"test","triggerExpressions":[]}},"messagingPoolSize":null,"minSendDelayMillis":null},"hibernateConfig":{"connection":{"credentialsSecretRef":"hsql-factory-secret","dialect":"org.hibernate.dialect.HSQLDialect","jdbcDriverClass":"org.hsqldb.jdbcDriver","jdbcUrl":"jdbc:hsqldb:hsql://localhost:9001"},"optionalConfiguration":{"cache.provider_class":"org.hibernate.cache.internal.NoCacheProvider","current_session_context_class":"thread","hbm2ddl.auto":"update","hikari.connectionTimeout":"5000","show_sql":"false"}},"internalDataAdapter":null,"moduleCheckPeriodMillis":null,"moduleTimeoutMillis":null,"mpnPumpPoolSize":null,"mpnTimerPoolSize":null,"notifierPoolSize":null,"reactionOnDatabaseFailure":"continue_operation","requestTimeoutMillis":null}

mpn.activationOnStartUp

Optional. Enables the startup of the module upon Server startup. If module startup is prevented, or not yet completed, or completed unsuccessfully, the module is inactive. This means that no subscription processing is performed and any client MPN requests are refused.

Type: object

Default: {"enabled":true,"maxDelayMillis":-1}

mpn.activationOnStartUp.enabled

Optional. If set to true, a module startup will be initiated immediately at Server startup through the mechanism set by maxDelay. If set to false, the Server will start with an inactive module. Note: the initialization of a new module (as well as the deactivation of the current module), can be requested at any time through the JMX interface (full JMX features is an optional feature, available depending on Edition and License Type).

Type: bool

Default: true

mpn.activationOnStartUp.maxDelayMillis

Optional, but effective only if mpn.enableActivationOnStartUp is set to true. If not specified, or set to -1, the Server startup will be blocked until module startup completion; if the module startup fails, the Server startup will fail in turn. Otherwise, the Server startup will be blocked only up to the specified delay. If the delay expires, the Server may start with the module in a temporarily inactive state; moreover, if the module startup eventually fails, the Server will keep running with an inactive module.

Type: int

Default: -1

mpn.appleNotifierConfig

Optional. Apple platforms notifier configuration.

Type: object

Default:

{"apps":{"myApp":{"enabled":false,"id":null,"keystoreRef":null,"pushPackageFileRef":null,"serviceLevel":"test","triggerExpressions":[]}},"connectionTimeoutMillis":30000,"keystores":{"myAppKeystore":{"keystoreFileSecretRef":null,"keystorePasswordSecretRef":null}},"maxConcurrentConnections":1,"minSendDelayMillis":null}

mpn.appleNotifierConfig.apps

Optional. Map of apps that should receive mobile push notifications. Each entry in the map is an application configuration.

Type: object

Default:

{"myApp":{"enabled":false,"id":null,"keystoreRef":null,"pushPackageFileRef":null,"serviceLevel":"test","triggerExpressions":[]}}

mpn.appleNotifierConfig.apps.myApp

An application configuration.

Type: object

Default:

{"enabled":false,"id":null,"keystoreRef":null,"pushPackageFileRef":null,"serviceLevel":"test","triggerExpressions":[]}

{"myAppKeystore":{"keystoreFileSecretRef":null,"keystorePasswordSecretRef":null}}

mpn.appleNotifierConfig.keystores.myAppKeystore

Keystore configuration for the app.

Type: object

Default:

{"keystoreFileSecretRef":null,"keystorePasswordSecretRef":null}

mpn.googleNotifierConfig

Optional. Google platforms notifier configuration.

Type: object

Default:

{"apps":{"myApp":{"enabled":false,"packageName":null,"serviceJsonFileRef":null,"serviceLevel":"test","triggerExpressions":[]}},"messagingPoolSize":null,"minSendDelayMillis":null}

mpn.googleNotifierConfig.apps

Optional. Map of apps that should receive mobile push notifications. Each entry in the map is an application configuration.

Type: object

Default:

{"myApp":{"enabled":false,"packageName":null,"serviceJsonFileRef":null,"serviceLevel":"test","triggerExpressions":[]}}

mpn.googleNotifierConfig.apps.myApp

An application configuration.

Type: object

Default:

{"enabled":false,"packageName":null,"serviceJsonFileRef":null,"serviceLevel":"test","triggerExpressions":[]}

mpn.googleNotifierConfig.apps.myApp.enabled

Optional. Enables the application configuration.

Type: bool

Default: false

mpn.googleNotifierConfig.apps.myApp.packageName

Mandatory if enabled is set to true. The package name of the app.

Type: string

Default: nil

mpn.googleNotifierConfig.apps.myApp.serviceJsonFileRef

Mandatory if serviceLevel is set to dry_run or production. The configmap name and the key where the JSON descriptor for the service account credentials of this project on Firebase console is stored. See the General Concepts document for more information on how to obtain this file.

Type: string

Default: nil

mpn.googleNotifierConfig.apps.myApp.serviceLevel

Mandatory if enabled is set to true. Specifies the intended service level for the current app, must be one of: test, dry_run,production. If set to test, notification will be logged only and no connection will be established with Google's servers. The corresponding logger is logging.loggers.lightstreamerLogger.subLoggers.mpn.google, notifications are logged at INFO level (see logging.loggers.lightstreamerLogger.subLoggers.mpn.google). If set to dry_run or production, notifications will be sent to Google's servers. If set to dry_run, notifications will be accepted by Google's servers but not delivered to the user's device.

Type: string

Default: "test"

mpn.googleNotifierConfig.apps.myApp.triggerExpressions

Optional. List of trigger expressions that will be accepted. Each each item is a Java-compatible regular expression (see java.util.regex.Pattern): triggers requested via client APIs will be compared with each regular expression, and accepted only if there is at least one match. Remember that the MPN Module supports, as trigger, any Java boolean expression, including use of JDK classes and methods, with the addition of field references syntax (see the iOS Client SDK for more information). Hence, this check is a safety measure required to avoid that clients can request triggers potentially dangerous for the Server, as each trigger may contain arbitrary Java code. If left empty or commented, no triggers will be accepted. Please note that using an "accept all" regular expression like .* is possible, but still leaves the Server exposed to the danger of maliciously crafted triggers. Anyway, the Metadata Adapter has a second chance to check for trigger allowance. The example shown below is for a typical notification on threshold, where a field is compared against a numeric constant. Note: submitted trigger expressions are compared with this list of regular expressions after their named-arguments have been converted to indexed-arguments. Always specify fields with the $[digits] format, not the ${name} format.

Type: list

Default: []

mpn.googleNotifierConfig.messagingPoolSize

Optional. Size of the notifier's MPN XXX MESSAGING internal thread pool, which is devoted to sending the notifications payload. Each app has a separate thread pool. On multiprocessor machines, allocating multiple threads for this task may be beneficial.

Type: int

Default: the number of available total cores, as detected by the JVM

mpn.googleNotifierConfig.minSendDelayMillis

Optional. Minimum delay between successive mobile push notifications for the same app/device pair. Each app/device pair is subject to constraints on the pace mobile push notifications may be sent to it. For this reason, a minimum delay is set and may be altered with this parameter. Lowering it too much, and subsequently sending notifications with a high frequency, may cause Google's Firebase Cloud Messaging service ("FCM") to close the connection and ban (temporarily or permanently) any successive notification. Mobile push notifications fired by a trigger are not subject to this limit and may be sent at higher pace.

Type: int

Default: 1000

mpn.hibernateConfig

Mandatory. Hibernate configuration. The MPN module uses an Hibernate-mapped database to make the list of devices and subscriptions persistent and let different module instances communicate.

Type: object

Default:

{"connection":{"credentialsSecretRef":"hsql-factory-secret","dialect":"org.hibernate.dialect.HSQLDialect","jdbcDriverClass":"org.hsqldb.jdbcDriver","jdbcUrl":"jdbc:hsqldb:hsql://localhost:9001"},"optionalConfiguration":{"cache.provider_class":"org.hibernate.cache.internal.NoCacheProvider","current_session_context_class":"thread","hbm2ddl.auto":"update","hikari.connectionTimeout":"5000","show_sql":"false"}}

mpn.hibernateConfig.connection

Mandatory. The Hibernate JDBC properties. The provided values are used to show an example of connections settings for HSQL (suitable for testing). The HSQL jar must be included in the lib/mp/hibernate folder of the Docker image.

Type: object

Default:

{"credentialsSecretRef":"hsql-factory-secret","dialect":"org.hibernate.dialect.HSQLDialect","jdbcDriverClass":"org.hsqldb.jdbcDriver","jdbcUrl":"jdbc:hsqldb:hsql://localhost:9001"}

mpn.hibernateConfig.connection.credentialsSecretRef

Mandatory. The name of the secret containing the credentials. The secret must contain the keys user and password. The hsql-hibernate-secret secret is provided out of the box and contains the default SA user with empty password.

Type: string

Default: "hsql-factory-secret"

mpn.hibernateConfig.connection.dialect

Optional. Full class name of the dialect to use.

Type: string

Default: "org.hibernate.dialect.HSQLDialect"

mpn.hibernateConfig.connection.jdbcDriverClass

Mandatory. JDBC driver class.

Type: string

Default: "org.hsqldb.jdbcDriver"

mpn.hibernateConfig.connection.jdbcUrl

Mandatory. JDBC URL.

Type: string

Default: "jdbc:hsqldb:hsql://localhost:9001"

mpn.hibernateConfig.optionalConfiguration

Optional. The Hibernate optional configuration properties. See https://docs.jboss.org/hibernate/orm/3.3/reference/en/html/session-configuration.html#configuration-optional.

Type: object

Default:

{"cache.provider_class":"org.hibernate.cache.internal.NoCacheProvider","current_session_context_class":"thread","hbm2ddl.auto":"update","hikari.connectionTimeout":"5000","show_sql":"false"}

Default:

{"compressionThreshold":null,"enableSilverlightAccessPolicy":null,"enabled":true,"errorPageRef":null,"mimeTypesConfig":null,"notFoundPage":null,"pagesDir":null,"persistencyMinutes":null,"silverlightAccessPolicyPath":null}

Default:

{"controlLinkAddress":null,"controlLinkMachineName":null,"maxSessionDurationMinutes":null}

cluster.controlLinkAddress

Optional. Host address to be used for control/poll/rebind connections. A numeric IP address can be specified as well. The use of non standard, unicode names may not be supported yet by some Client SDKs. This setting can be used in case a cluster of Server instances is in place, to ensure that all client requests pertaining to the same session are issued against the same Server instance. If the Load Balancer can ensure that all requests coming from the same client are always routed to the same Server instance, then this setting is not needed. See the Clustering.pdf document for more details. Note: When this setting is used, clients based on any Unified Client SDK that supports the optional setEarlyWSOpenEnabled method in the ConnectionOptions class should invoke this method with false, to improve startup performances. In case a request comes from a web client and cluster.controlLinkMachineName is also specified, the latter setting may be applied instead; see the comment for cluster.controlLinkMachineName for details. Support for clustering is an optional feature, available depending on Edition and License Type. When not available, this setting is ignored.

Type: string

Default: nil

cluster.controlLinkMachineName

Optional. Host name to be used, in addition to the domain name specified on the front-end pages, for control/poll/rebind connections coming from web clients. This only regards clients based on old versions of the Web (Unified API) Client SDK (earlier than 8.0.0). The use of non standard, unicode names may not be supported by old versions of the Web Client SDK. This setting will override the cluster.controlLinkAddress setting when the request comes from such Web Client SDKs and the access to Server data pages requires that the latter share a common subdomain with application pages. This was one of the ways used by these SDKs to request streaming data; see the Client Guide in the Web (Unified API) Client SDK for these versions for details on the cases in which this setting will be preferred; note that, in this regard, the behavior will be slightly different when the older HTML Client Library is in use, so as to ensure backward compatibility. This option is useful if the subdomain-name part of the hostname is subject to changes or if the same machine needs to be addressed through multiple subdomain names (e.g. for multihosting purpose). The configured name should contain all the portions of the address except for the subdomain name. For example, assuming the mycompany.com subdomain is declared in the front-end pages: - If the full address is push1.mycompany.com, the name should be push. - If the full address is push.int2.cnt3.mycompany.com, the name should be push.int2.cnt3. Refer to cluster.controlLinkAddress for other remarks. Support for clustering is an optional feature, available depending on Edition and License Type. When not available, this setting is ignored.

Type: string

Default: nil

cluster.maxSessionDurationMinutes

Optional. If set and positive, defines a maximum duration to be enforced on each session. If the limit expires, the session is closed and the client can only establish a new session. This is useful when a cluster of Server instances is in place, as it leaves the Load Balancer the opportunity to migrate the new session to a different instance. See the Clustering document for details on this mechanism and on how rebalancing can be pursued.

Type: int

Default: unlimited maximum session duration

Load settings

load

Optional. Load configuration.

Type: object

Default:

{"acceptPoolMaxQueue":null,"acceptPoolMaxSize":null,"eventsPoolSize":null,"forceEarlyConversions":null,"handshakePoolMaxQueue":null,"handshakePoolSize":null,"httpsAuthPoolMaxFree":null,"httpsAuthPoolMaxQueue":null,"httpsAuthPoolMaxSize":null,"maxCommonNioBufferAllocation":200000000,"maxCommonPumpBufferAllocation":200000000,"maxMpnDevices":null,"maxSessions":null,"prestartedMaxQueue":null,"pumpPoolMaxQueue":-1,"pumpPoolSize":null,"selectorMaxLoad":0,"selectorPoolSize":null,"serverPoolMaxFree":null,"serverPoolMaxQueue":100,"serverPoolMaxSize":1000,"snapshotPoolSize":null,"timerPoolSize":-1}

Default:

{"myAdapterSet":{"adapterSetPool":{"maxFree":null,"maxSize":null},"dataProviders":{"myDataProvider":{"enabled":null,"inProcessDataAdapter":{"adapterClass":null,"classloader":"common","configMapRef":null,"dataAdapterPool":{"maxFree":null,"maxSize":null},"initParams":null,"installDir":null},"name":null,"proxyDataAdapter":{"authentication":{"credentialsSecrets":null,"enabled":null},"connectionRecoveryTimeoutMillis":10000,"connectionRetryMillis":null,"dataAdapterPool":{"maxFree":null,"maxSize":null},"enableRobustAdapter":false,"eventsRecovery":"use_snapshot","firstConnectionTimeoutMillis":null,"interface":null,"keepaliveHintMillis":null,"keepaliveTimeoutMillis":null,"remoteAddressWhitelist":null,"remoteHost":null,"remoteParamsConfig":{"params":null,"prefix":null},"requestReplyPort":6661,"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableClientAuth":null,"enableHostnameVerification":null,"enabled":null,"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":null,"removeProtocols":null,"truststoreRef":null},"statusItem":null,"timeoutMillis":10000}}},"enableMetadataInitializedFirst":null,"enabled":false,"id":null,"metadataProvider":{"inProcessMetadataAdapter":{"adapterClass":null,"allowedUsers":null,"authenticationPool":{"maxFree":1,"maxPendingRequests":-1,"maxQueue":-1,"maxSize":1},"bufferSize":null,"classLoader":"common","configMapRef":null,"distinctSnapshotLength":null,"enableTableNotificationsSequentialization":null,"initParams":null,"installDir":null,"itemFamilies":{"itemFamily1":{"dataAdapter":null,"itemPattern":null,"modes":null}},"maxBandwidth":null,"maxFrequency":null,"messagesPool":{"maxFree":1,"maxPendingRequests":-1,"maxQueue":-1,"maxSize":1},"mpnPool":{"maxFree":null,"maxSize":null},"prefilterFrequency":null},"proxyMetadataAdapter":{"authentication":{"credentialsSecrets":[],"enabled":false},"authenticationPool":{"maxFree":1,"maxPendingRemoteRequests":-1,"maxQueue":-1,"maxSize":1},"closeNotificationsRecovery":"unneeded","connectionRecoveryTimeoutMillis":-1,"connectionRetryMillis":10000,"enableClearingOnNewRemote":null,"enableClearingOnSessionClose":null,"enableRobustAdapter":false,"enableTableNotificationsSequentialization":false,"firstConnectionTimeoutMillis":10000,"interface":null,"keepaliveHintMillis":null,"keepaliveTimeoutMillis":null,"messagesPool":{"maxFree":1,"maxPendingRemoteRequests":-1,"maxQueue":-1,"maxSize":1},"mpnPool":{"maxFree":null,"maxSize":null},"notifyUserDisconnectionCode":null,"notifyUserDisconnectionMsg":null,"notifyUserOnDisconnection":null,"remoteAddressWhitelist":null,"remoteHost":null,"remoteParamsConfig":{"params":null,"prefix":null},"requestReplyPort":6663,"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableHostnameVerification":null,"enableMandatoryClientAuth":null,"enabled":false,"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":null,"removeProtocols":null,"truststoreRef":null},"timeoutMillis":10000,"userDataTimeoutMillis":null}},"provisioning":{"fromPathInImage":null,"fromVolume":{"name":null,"path":null}}}}

adapters.myAdapterSet

Optional. An Adapter Set configuration.

Type: object

Default:

{"adapterSetPool":{"maxFree":null,"maxSize":null},"dataProviders":{"myDataProvider":{"enabled":null,"inProcessDataAdapter":{"adapterClass":null,"classloader":"common","configMapRef":null,"dataAdapterPool":{"maxFree":null,"maxSize":null},"initParams":null,"installDir":null},"name":null,"proxyDataAdapter":{"authentication":{"credentialsSecrets":null,"enabled":null},"connectionRecoveryTimeoutMillis":10000,"connectionRetryMillis":null,"dataAdapterPool":{"maxFree":null,"maxSize":null},"enableRobustAdapter":false,"eventsRecovery":"use_snapshot","firstConnectionTimeoutMillis":null,"interface":null,"keepaliveHintMillis":null,"keepaliveTimeoutMillis":null,"remoteAddressWhitelist":null,"remoteHost":null,"remoteParamsConfig":{"params":null,"prefix":null},"requestReplyPort":6661,"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableClientAuth":null,"enableHostnameVerification":null,"enabled":null,"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":null,"removeProtocols":null,"truststoreRef":null},"statusItem":null,"timeoutMillis":10000}}},"enableMetadataInitializedFirst":null,"enabled":false,"id":null,"metadataProvider":{"inProcessMetadataAdapter":{"adapterClass":null,"allowedUsers":null,"authenticationPool":{"maxFree":1,"maxPendingRequests":-1,"maxQueue":-1,"maxSize":1},"bufferSize":null,"classLoader":"common","configMapRef":null,"distinctSnapshotLength":null,"enableTableNotificationsSequentialization":null,"initParams":null,"installDir":null,"itemFamilies":{"itemFamily1":{"dataAdapter":null,"itemPattern":null,"modes":null}},"maxBandwidth":null,"maxFrequency":null,"messagesPool":{"maxFree":1,"maxPendingRequests":-1,"maxQueue":-1,"maxSize":1},"mpnPool":{"maxFree":null,"maxSize":null},"prefilterFrequency":null},"proxyMetadataAdapter":{"authentication":{"credentialsSecrets":[],"enabled":false},"authenticationPool":{"maxFree":1,"maxPendingRemoteRequests":-1,"maxQueue":-1,"maxSize":1},"closeNotificationsRecovery":"unneeded","connectionRecoveryTimeoutMillis":-1,"connectionRetryMillis":10000,"enableClearingOnNewRemote":null,"enableClearingOnSessionClose":null,"enableRobustAdapter":false,"enableTableNotificationsSequentialization":false,"firstConnectionTimeoutMillis":10000,"interface":null,"keepaliveHintMillis":null,"keepaliveTimeoutMillis":null,"messagesPool":{"maxFree":1,"maxPendingRemoteRequests":-1,"maxQueue":-1,"maxSize":1},"mpnPool":{"maxFree":null,"maxSize":null},"notifyUserDisconnectionCode":null,"notifyUserDisconnectionMsg":null,"notifyUserOnDisconnection":null,"remoteAddressWhitelist":null,"remoteHost":null,"remoteParamsConfig":{"params":null,"prefix":null},"requestReplyPort":6663,"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableHostnameVerification":null,"enableMandatoryClientAuth":null,"enabled":false,"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":null,"removeProtocols":null,"truststoreRef":null},"timeoutMillis":10000,"userDataTimeoutMillis":null}},"provisioning":{"fromPathInImage":null,"fromVolume":{"name":null,"path":null}}}

adapters.myAdapterSet.adapterSetPool

Optional. Requests the creation of a specific SET thread pool, devoted to the management of all the client requests pertaining to sessions based on this Adapter Set. Only requests related to the special Data Adapter used to supply the state of the MPN Module (if enabled) are not included and fall into the global SERVER pool. Note, however, that the AUTHENTICATION and MSG pools are always created, hence they don't contribute to this pool. If undefined, these requests are managed by the global SERVER thread pool. If defined, the maxSizeandmaxFreesettings are mandatory, with meaning similar to that of the globalload.serverPoolMaxSizeandload.serverPoolMaxFreesettings. Note thatmaxSizealso indicates the maximum number of pending requests to the Remote Adapters (seeXXXX`). Using a specific thread pool is advisable if the implementation of any of the Adapter methods introduces delays and more specific thread pools are not being used.

Type: object

Default: nil

adapters.myAdapterSet.adapterSetPool.maxFree

Mandatory. Maximum number of idle threads allowed for the SET thread pool.

Type: int

Default: nil

adapters.myAdapterSet.adapterSetPool.maxSize

Mandatory. Maximum number of threads allowed for the SET thread pool.

Type: int

Default: nil

adapters.myAdapterSet.dataProviders

Mandatory. List of data provider configurations.

Type: object

Default:

{"myDataProvider":{"enabled":null,"inProcessDataAdapter":{"adapterClass":null,"classloader":"common","configMapRef":null,"dataAdapterPool":{"maxFree":null,"maxSize":null},"initParams":null,"installDir":null},"name":null,"proxyDataAdapter":{"authentication":{"credentialsSecrets":null,"enabled":null},"connectionRecoveryTimeoutMillis":10000,"connectionRetryMillis":null,"dataAdapterPool":{"maxFree":null,"maxSize":null},"enableRobustAdapter":false,"eventsRecovery":"use_snapshot","firstConnectionTimeoutMillis":null,"interface":null,"keepaliveHintMillis":null,"keepaliveTimeoutMillis":null,"remoteAddressWhitelist":null,"remoteHost":null,"remoteParamsConfig":{"params":null,"prefix":null},"requestReplyPort":6661,"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableClientAuth":null,"enableHostnameVerification":null,"enabled":null,"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":null,"removeProtocols":null,"truststoreRef":null},"statusItem":null,"timeoutMillis":10000}}}

adapters.myAdapterSet.dataProviders.myDataProvider

At least one must be provided. Data Adapter configuration.

Type: object

Default:

{"enabled":null,"inProcessDataAdapter":{"adapterClass":null,"classloader":"common","configMapRef":null,"dataAdapterPool":{"maxFree":null,"maxSize":null},"initParams":null,"installDir":null},"name":null,"proxyDataAdapter":{"authentication":{"credentialsSecrets":null,"enabled":null},"connectionRecoveryTimeoutMillis":10000,"connectionRetryMillis":null,"dataAdapterPool":{"maxFree":null,"maxSize":null},"enableRobustAdapter":false,"eventsRecovery":"use_snapshot","firstConnectionTimeoutMillis":null,"interface":null,"keepaliveHintMillis":null,"keepaliveTimeoutMillis":null,"remoteAddressWhitelist":null,"remoteHost":null,"remoteParamsConfig":{"params":null,"prefix":null},"requestReplyPort":6661,"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableClientAuth":null,"enableHostnameVerification":null,"enabled":null,"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":null,"removeProtocols":null,"truststoreRef":null},"statusItem":null,"timeoutMillis":10000}}

adapters.myAdapterSet.dataProviders.myDataProvider.enabled

Optional. Enables the Data Provider configuration.

Type: string

Default: false

adapters.myAdapterSet.dataProviders.myDataProvider.inProcessDataAdapter

One of this or proxyDataAdapter must be provided. Configuration of an in-process Data Adapter. If both inProcessDataAdapter and proxyDataAdapter are provided, this setting takes precedence.

Type: object

Default:

{"adapterClass":null,"classloader":"common","configMapRef":null,"dataAdapterPool":{"maxFree":null,"maxSize":null},"initParams":null,"installDir":null}

{"authentication":{"credentialsSecrets":null,"enabled":null},"connectionRecoveryTimeoutMillis":10000,"connectionRetryMillis":null,"dataAdapterPool":{"maxFree":null,"maxSize":null},"enableRobustAdapter":false,"eventsRecovery":"use_snapshot","firstConnectionTimeoutMillis":null,"interface":null,"keepaliveHintMillis":null,"keepaliveTimeoutMillis":null,"remoteAddressWhitelist":null,"remoteHost":null,"remoteParamsConfig":{"params":null,"prefix":null},"requestReplyPort":6661,"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableClientAuth":null,"enableHostnameVerification":null,"enabled":null,"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":null,"removeProtocols":null,"truststoreRef":null},"statusItem":null,"timeoutMillis":10000}

{"allowCipherSuites":null,"allowProtocols":null,"enableClientAuth":null,"enableHostnameVerification":null,"enabled":null,"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":null,"removeProtocols":null,"truststoreRef":null}

{"inProcessMetadataAdapter":{"adapterClass":null,"allowedUsers":null,"authenticationPool":{"maxFree":1,"maxPendingRequests":-1,"maxQueue":-1,"maxSize":1},"bufferSize":null,"classLoader":"common","configMapRef":null,"distinctSnapshotLength":null,"enableTableNotificationsSequentialization":null,"initParams":null,"installDir":null,"itemFamilies":{"itemFamily1":{"dataAdapter":null,"itemPattern":null,"modes":null}},"maxBandwidth":null,"maxFrequency":null,"messagesPool":{"maxFree":1,"maxPendingRequests":-1,"maxQueue":-1,"maxSize":1},"mpnPool":{"maxFree":null,"maxSize":null},"prefilterFrequency":null},"proxyMetadataAdapter":{"authentication":{"credentialsSecrets":[],"enabled":false},"authenticationPool":{"maxFree":1,"maxPendingRemoteRequests":-1,"maxQueue":-1,"maxSize":1},"closeNotificationsRecovery":"unneeded","connectionRecoveryTimeoutMillis":-1,"connectionRetryMillis":10000,"enableClearingOnNewRemote":null,"enableClearingOnSessionClose":null,"enableRobustAdapter":false,"enableTableNotificationsSequentialization":false,"firstConnectionTimeoutMillis":10000,"interface":null,"keepaliveHintMillis":null,"keepaliveTimeoutMillis":null,"messagesPool":{"maxFree":1,"maxPendingRemoteRequests":-1,"maxQueue":-1,"maxSize":1},"mpnPool":{"maxFree":null,"maxSize":null},"notifyUserDisconnectionCode":null,"notifyUserDisconnectionMsg":null,"notifyUserOnDisconnection":null,"remoteAddressWhitelist":null,"remoteHost":null,"remoteParamsConfig":{"params":null,"prefix":null},"requestReplyPort":6663,"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableHostnameVerification":null,"enableMandatoryClientAuth":null,"enabled":false,"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":null,"removeProtocols":null,"truststoreRef":null},"timeoutMillis":10000,"userDataTimeoutMillis":null}}

adapters.myAdapterSet.metadataProvider.inProcessMetadataAdapter

One of this or proxyMetadataAdapter must be provided. Configuration of an in-process Metadata Adapter. If both inProcessMetadataAdapter and proxyMetadataAdapter are provided, this setting takes precedence.

Type: object

Default:

{"adapterClass":null,"allowedUsers":null,"authenticationPool":{"maxFree":1,"maxPendingRequests":-1,"maxQueue":-1,"maxSize":1},"bufferSize":null,"classLoader":"common","configMapRef":null,"distinctSnapshotLength":null,"enableTableNotificationsSequentialization":null,"initParams":null,"installDir":null,"itemFamilies":{"itemFamily1":{"dataAdapter":null,"itemPattern":null,"modes":null}},"maxBandwidth":null,"maxFrequency":null,"messagesPool":{"maxFree":1,"maxPendingRequests":-1,"maxQueue":-1,"maxSize":1},"mpnPool":{"maxFree":null,"maxSize":null},"prefilterFrequency":null}

adapters.myAdapterSet.metadataProvider.inProcessMetadataAdapter.adapterClass

Mandatory. Java class name of the Metadata Adapter.

Type: string

Default: nil

adapters.myAdapterSet.metadataProvider.inProcessMetadataAdapter.allowedUsers

Optional and specific for adapters that inherit from com.lightstreamer.adapters.metadata.LiteralBasedProvider. Comma-separated list of User names to be allowed by the notifyUser method. See LiteralBaseProvider javadoc javadoc

Type: string

Default: nil

adapters.myAdapterSet.metadataProvider.inProcessMetadataAdapter.authenticationPool

Optional. Configures the specific AUTHENTICATION thread pool, expressly devoted to the calls of notifyUser against this Metadata Adapter. This pool is always created and the notifyUser calls to the Metadata Adapters are performed asynchronously, hence they are not supposed to keep threads engaged. In order to keep track of the pending asynchronous requests, they are counted in the global statistics as part of the pool task queue (but not as contributing to the pool queue wait). By default, the pool has one fixed thread. If this setting is defined, its maxSize and maxFree values, with meaning similar to that of the global load.serverPoolMaxSize and load.serverPoolMaxFree, are optional, both with default 1. In fact, it is not expected that more than one thread will ever be needed, since the implementations of notifyUser are require to be fast and non-blocking and to perform any slow processing asynchronously. On the other hand, configuring the pool is recommended, to constrain the maximum number of pending requests to the Metadata Adapter through the optional maxPendingRequests setting (if set <= 0, it poses no limitation; this is also the default). The optional maxQueue setting is also available, with meaning similar to the global load.serverPoolMaxQueue. If defined, the length of the queue of this pool, instead of being added to the length checked by `load.serverPoolMaxQueue, will be checked against this limit, but with the same consequent backpressure actions.

Type: object

Default:

{"maxFree":1,"maxPendingRequests":-1,"maxQueue":-1,"maxSize":1}

{"itemFamily1":{"dataAdapter":null,"itemPattern":null,"modes":null}}

adapters.myAdapterSet.metadataProvider.inProcessMetadataAdapter.itemFamilies.itemFamily1

Optional. Defines a family of items.

Type: object

Default:

{"dataAdapter":null,"itemPattern":null,"modes":null}

{"maxFree":1,"maxPendingRequests":-1,"maxQueue":-1,"maxSize":1}

adapters.myAdapterSet.metadataProvider.proxyMetadataAdapter

One of this or inProcessMetadataAdapter must be provided. Configuration of the Proxy Metadata Adapter, which is embedded in the Lightstreamer Broker and available out of the box. The Proxy Metadata Adapter communicates with its remote counterpart through standard TCP sockets. It listens on a configurable port (see requestReplyPort setting) and waits its counterpart to connect. inProcessMetadataAdapter takes precedence over this setting if both are provided.

Type: object

Default:

{"authentication":{"credentialsSecrets":[],"enabled":false},"authenticationPool":{"maxFree":1,"maxPendingRemoteRequests":-1,"maxQueue":-1,"maxSize":1},"closeNotificationsRecovery":"unneeded","connectionRecoveryTimeoutMillis":-1,"connectionRetryMillis":10000,"enableClearingOnNewRemote":null,"enableClearingOnSessionClose":null,"enableRobustAdapter":false,"enableTableNotificationsSequentialization":false,"firstConnectionTimeoutMillis":10000,"interface":null,"keepaliveHintMillis":null,"keepaliveTimeoutMillis":null,"messagesPool":{"maxFree":1,"maxPendingRemoteRequests":-1,"maxQueue":-1,"maxSize":1},"mpnPool":{"maxFree":null,"maxSize":null},"notifyUserDisconnectionCode":null,"notifyUserDisconnectionMsg":null,"notifyUserOnDisconnection":null,"remoteAddressWhitelist":null,"remoteHost":null,"remoteParamsConfig":{"params":null,"prefix":null},"requestReplyPort":6663,"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableHostnameVerification":null,"enableMandatoryClientAuth":null,"enabled":false,"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":null,"removeProtocols":null,"truststoreRef":null},"timeoutMillis":10000,"userDataTimeoutMillis":null}

adapters.myAdapterSet.metadataProvider.proxyMetadataAdapter.authentication

Optional. Authentication settings for the connection.

Type: object

Default: {"credentialsSecrets":[],"enabled":false}

adapters.myAdapterSet.metadataProvider.proxyMetadataAdapter.authentication.credentialsSecrets

Optional, but ineffective if enabled is set to false. The reference to the secrets containing the credentials of the users allowed to connect. Every secret must contains the keys user and password.

Type: list

Default: []

adapters.myAdapterSet.metadataProvider.proxyMetadataAdapter.authentication.enabled

Optional. If set to true, enforces Remote Adapter authentication on the connection based on a user/password credential check. Note that the user names will be used in log messages at INFO level or above, whereas the passwords won't.

Type: bool

Default: false

adapters.myAdapterSet.metadataProvider.proxyMetadataAdapter.authenticationPool

Optional. Configures the specific AUTHENTICATION thread pool, expressly devoted to the calls of Notify User against the Remote Metadata Adapter. This pool is always created and the Notify User calls to Proxy Adapters are performed asynchronously, hence they are not supposed to keep threads engaged. In order to keep track of the pending asynchronous requests, they are counted in the global statistics as part of the pool task queue (but not as contributing to the pool queue wait). By default, the pool has one fixed thread. If this setting is defined, its maxSize and maxFree values, with meaning similar to that of the global load.serverPoolMaxSize and load.serverPoolMaxFree, are optional, both with default 1. In fact, it is not expected that more than one thread will ever be needed, since the pool's only task is to forward the Notify User requests. On the other hand, configuring the pool is recommended, to constrain the maximum number of pending requests to the Remote Metadata Adapter through the optional maxPendingRemoteRequests settings (if set <= 0, it poses no limitation; this is also the default). The optional maxQueue setting is also available, with meaning similar to the global load.serverPoolMaxQueue. If defined, the length of the queue of this pool, instead of being added to the length checked by load.serverPoolMaxQueue, will be checked against this limit, but with the same consequent backpressure actions.

Type: object

Default:

{"maxFree":1,"maxPendingRemoteRequests":-1,"maxQueue":-1,"maxSize":1}

{"maxFree":1,"maxPendingRemoteRequests":-1,"maxQueue":-1,"maxSize":1}

adapters.myAdapterSet.metadataProvider.proxyMetadataAdapter.sslConfig

Optional. TLS/SSL settings for the connection to the remote Metadata Adapter.

Type: object

Default:

{"allowCipherSuites":null,"allowProtocols":null,"enableHostnameVerification":null,"enableMandatoryClientAuth":null,"enabled":false,"enforceServerCipherSuitePreference":null,"keystoreRef":null,"removeCipherSuites":null,"removeProtocols":null,"truststoreRef":null}

adapters.myAdapterSet.provisioning

Optional. Defines the provisioning method of the Adapter Set. Either specify one of fromPathInImage or fromVolume.

Type: object

Default:

{"fromPathInImage":null,"fromVolume":{"name":null,"path":null}}

adapters.myAdapterSet.provisioning.fromPathInImage

The path to the Adapter Set resources in the image, e.g.: /lightstreamer/adapters/my-adapter-set. At startup, the path will be me mounted at the designated Adapter Set folder under the /lightstreamer/deployed_adapters directory in the container.

Type: string

Default: nil

adapters.myAdapterSet.provisioning.fromVolume

The reference to a volume where the Adapter Set resources are stored. At startup, the resources will be copied to the designated Adapter Set folder under the /lightstreamer/deployed_adapters directory in the container.

Type: object

Default: {"name":null,"path":null}

adapters.myAdapterSet.provisioning.fromVolume.name

Mandatory. The name of the volume.

Type: string

Default: nil

adapters.myAdapterSet.provisioning.fromVolume.path

Optional. The path to the Adapter Set resources in the volume, e.g.: /adapters/my-adapter-set.

Type: string

Default: nil

Connectors settings

connectors

Optional. Connectors configuration.

Type: object

Default:

{"kafkaConnector":{"adapterClassName":"com.lightstreamer.kafka.adapters.pub.KafkaConnectorMetadataAdapter","adapterSetId":"KafkaConnector","connections":{"quickStart":{"authentication":{"credentialsSecretRef":null,"enabled":false,"gssapi":{"enableKeytab":false,"enableStoreKey":false,"enableTicketCache":false,"kerberosServiceName":null,"keytabFilePathRef":null,"principal":null},"mechanism":null},"bootstrapServers":"broker:9092","enabled":null,"fields":{"enableSkipFailedMapping":null,"mappings":{"ask":"#{VALUE.ask}","ask_quantity":"#{VALUE.ask_quantity}","bid":"#{VALUE.bid}","bid_quantity":"#{VALUE.bid_quantity}","item_status":"#{VALUE.item_status}","last_price":"#{VALUE.last_price}","max":"#{VALUE.max}","min":"#{VALUE.min}","offset":"#{OFFSET}","open_price":"#{VALUE.open_price}","partition":"#{PARTITION}","pct_change":"#{VALUE.pct_change}","ref_price":"#{VALUE.ref_price}","stock_name":"#{VALUE.name}","time":"#{VALUE.time}","timestamp":"#{VALUE.timestamp}","topic":"#{TOPIC}","ts":"#{TIMESTAMP}"}},"groupId":"quickstart","logger":{"appenders":["stdout"],"level":"INFO"},"name":"K8S-QuickStart","record":{"consumeFrom":"EARLIEST","consumeWithOrderStrategy":null,"consumeWithThreadNumber":null,"extractionErrorStrategy":null,"keyEvaluator":{"enableSchemaRegistry":null,"localSchemaFilePathRef":null,"type":"INTEGER"},"schemaRegistryRef":null,"valueEvaluator":{"enableSchemaRegistry":null,"localSchemaFilePathRef":null,"type":"JSON"}},"routing":{"enableTopicRegEx":null,"itemTemplates":{"stockTemplate":"stock-#{index=KEY}"},"topicMappings":{"stock":{"itemTemplateRefs":["stockTemplate"],"items":null,"topic":"stocks"}}},"sslConfig":{"allowedCipherSuites":null,"allowedProtocols":null,"enableHostnameVerification":false,"enabled":false,"keystoreRef":null,"protocol":null,"truststoreRef":null}}},"enabled":false,"localSchemaFiles":{"myKeySchema":null,"myValueSchema":null},"logging":{"appenders":{"stdout":{"pattern":"%d|%-10c{1}|%-5p|%m%n","type":"Console"}},"loggers":{"com.lightstreamer.kafka.adapters.pub.KafkaConnectorMetadataAdapter":{"appenders":["stdout"],"level":"INFO"},"org.apache.kafka":{"appenders":["stdout"],"level":"WARN"}}},"provisioning":{"fromGitHubRelease":null,"fromPathInImage":null,"fromUrl":null,"fromVolume":{"filePath":null,"name":null}},"schemaRegistry":{"mySchemaRegistry":{"basicAuthentication":{"credentialsSecretRef":null,"enabled":false},"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableHostnameVerification":null,"keystoreRef":null,"truststoreRef":null},"url":"https://schema-registry:8084"}}}}

connectors.kafkaConnector

Optional. Lightstreamer Kafka Connector configuration.

Type: object

Default:

{"adapterClassName":"com.lightstreamer.kafka.adapters.pub.KafkaConnectorMetadataAdapter","adapterSetId":"KafkaConnector","connections":{"quickStart":{"authentication":{"credentialsSecretRef":null,"enabled":false,"gssapi":{"enableKeytab":false,"enableStoreKey":false,"enableTicketCache":false,"kerberosServiceName":null,"keytabFilePathRef":null,"principal":null},"mechanism":null},"bootstrapServers":"broker:9092","enabled":null,"fields":{"enableSkipFailedMapping":null,"mappings":{"ask":"#{VALUE.ask}","ask_quantity":"#{VALUE.ask_quantity}","bid":"#{VALUE.bid}","bid_quantity":"#{VALUE.bid_quantity}","item_status":"#{VALUE.item_status}","last_price":"#{VALUE.last_price}","max":"#{VALUE.max}","min":"#{VALUE.min}","offset":"#{OFFSET}","open_price":"#{VALUE.open_price}","partition":"#{PARTITION}","pct_change":"#{VALUE.pct_change}","ref_price":"#{VALUE.ref_price}","stock_name":"#{VALUE.name}","time":"#{VALUE.time}","timestamp":"#{VALUE.timestamp}","topic":"#{TOPIC}","ts":"#{TIMESTAMP}"}},"groupId":"quickstart","logger":{"appenders":["stdout"],"level":"INFO"},"name":"K8S-QuickStart","record":{"consumeFrom":"EARLIEST","consumeWithOrderStrategy":null,"consumeWithThreadNumber":null,"extractionErrorStrategy":null,"keyEvaluator":{"enableSchemaRegistry":null,"localSchemaFilePathRef":null,"type":"INTEGER"},"schemaRegistryRef":null,"valueEvaluator":{"enableSchemaRegistry":null,"localSchemaFilePathRef":null,"type":"JSON"}},"routing":{"enableTopicRegEx":null,"itemTemplates":{"stockTemplate":"stock-#{index=KEY}"},"topicMappings":{"stock":{"itemTemplateRefs":["stockTemplate"],"items":null,"topic":"stocks"}}},"sslConfig":{"allowedCipherSuites":null,"allowedProtocols":null,"enableHostnameVerification":false,"enabled":false,"keystoreRef":null,"protocol":null,"truststoreRef":null}}},"enabled":false,"localSchemaFiles":{"myKeySchema":null,"myValueSchema":null},"logging":{"appenders":{"stdout":{"pattern":"%d|%-10c{1}|%-5p|%m%n","type":"Console"}},"loggers":{"com.lightstreamer.kafka.adapters.pub.KafkaConnectorMetadataAdapter":{"appenders":["stdout"],"level":"INFO"},"org.apache.kafka":{"appenders":["stdout"],"level":"WARN"}}},"provisioning":{"fromGitHubRelease":null,"fromPathInImage":null,"fromUrl":null,"fromVolume":{"filePath":null,"name":null}},"schemaRegistry":{"mySchemaRegistry":{"basicAuthentication":{"credentialsSecretRef":null,"enabled":false},"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableHostnameVerification":null,"keystoreRef":null,"truststoreRef":null},"url":"https://schema-registry:8084"}}}

connectors.kafkaConnector.adapterClassName

Mandatory. Java class name of the Kafka Connector Metadata Adapter. It is possible to provide a custom implementation by extending the factory class. See the dedicated section in the README.md file of the Lightstreamer Kafka Connector project on GitHub.

Type: string

Default: "com.lightstreamer.kafka.adapters.pub.KafkaConnectorMetadataAdapter"

connectors.kafkaConnector.adapterSetId

Mandatory. Defines the Kafka Connector Adapter Set and its unique ID.

Type: string

Default: "KafkaConnector"

connectors.kafkaConnector.connections

Mandatory. Connection configurations.

Type: object

Default:

{"quickStart":{"authentication":{"credentialsSecretRef":null,"enabled":false,"gssapi":{"enableKeytab":false,"enableStoreKey":false,"enableTicketCache":false,"kerberosServiceName":null,"keytabFilePathRef":null,"principal":null},"mechanism":null},"bootstrapServers":"broker:9092","enabled":null,"fields":{"enableSkipFailedMapping":null,"mappings":{"ask":"#{VALUE.ask}","ask_quantity":"#{VALUE.ask_quantity}","bid":"#{VALUE.bid}","bid_quantity":"#{VALUE.bid_quantity}","item_status":"#{VALUE.item_status}","last_price":"#{VALUE.last_price}","max":"#{VALUE.max}","min":"#{VALUE.min}","offset":"#{OFFSET}","open_price":"#{VALUE.open_price}","partition":"#{PARTITION}","pct_change":"#{VALUE.pct_change}","ref_price":"#{VALUE.ref_price}","stock_name":"#{VALUE.name}","time":"#{VALUE.time}","timestamp":"#{VALUE.timestamp}","topic":"#{TOPIC}","ts":"#{TIMESTAMP}"}},"groupId":"quickstart","logger":{"appenders":["stdout"],"level":"INFO"},"name":"K8S-QuickStart","record":{"consumeFrom":"EARLIEST","consumeWithOrderStrategy":null,"consumeWithThreadNumber":null,"extractionErrorStrategy":null,"keyEvaluator":{"enableSchemaRegistry":null,"localSchemaFilePathRef":null,"type":"INTEGER"},"schemaRegistryRef":null,"valueEvaluator":{"enableSchemaRegistry":null,"localSchemaFilePathRef":null,"type":"JSON"}},"routing":{"enableTopicRegEx":null,"itemTemplates":{"stockTemplate":"stock-#{index=KEY}"},"topicMappings":{"stock":{"itemTemplateRefs":["stockTemplate"],"items":null,"topic":"stocks"}}},"sslConfig":{"allowedCipherSuites":null,"allowedProtocols":null,"enableHostnameVerification":false,"enabled":false,"keystoreRef":null,"protocol":null,"truststoreRef":null}}}

connectors.kafkaConnector.connections.quickStart

At least one must be provided. Connection configuration. The Kafka Connector allows the configuration of different independent connections to different Kafka broker/clusters. Every entry in the map defines a connection configuration. Since the Kafka Connector manages the physical connection to Kafka by wrapping an internal Kafka Consumer, several configuration settings are identical to those required by the usual Kafka Consumer configuration.

Type: object

Default:

{"authentication":{"credentialsSecretRef":null,"enabled":false,"gssapi":{"enableKeytab":false,"enableStoreKey":false,"enableTicketCache":false,"kerberosServiceName":null,"keytabFilePathRef":null,"principal":null},"mechanism":null},"bootstrapServers":"broker:9092","enabled":null,"fields":{"enableSkipFailedMapping":null,"mappings":{"ask":"#{VALUE.ask}","ask_quantity":"#{VALUE.ask_quantity}","bid":"#{VALUE.bid}","bid_quantity":"#{VALUE.bid_quantity}","item_status":"#{VALUE.item_status}","last_price":"#{VALUE.last_price}","max":"#{VALUE.max}","min":"#{VALUE.min}","offset":"#{OFFSET}","open_price":"#{VALUE.open_price}","partition":"#{PARTITION}","pct_change":"#{VALUE.pct_change}","ref_price":"#{VALUE.ref_price}","stock_name":"#{VALUE.name}","time":"#{VALUE.time}","timestamp":"#{VALUE.timestamp}","topic":"#{TOPIC}","ts":"#{TIMESTAMP}"}},"groupId":"quickstart","logger":{"appenders":["stdout"],"level":"INFO"},"name":"K8S-QuickStart","record":{"consumeFrom":"EARLIEST","consumeWithOrderStrategy":null,"consumeWithThreadNumber":null,"extractionErrorStrategy":null,"keyEvaluator":{"enableSchemaRegistry":null,"localSchemaFilePathRef":null,"type":"INTEGER"},"schemaRegistryRef":null,"valueEvaluator":{"enableSchemaRegistry":null,"localSchemaFilePathRef":null,"type":"JSON"}},"routing":{"enableTopicRegEx":null,"itemTemplates":{"stockTemplate":"stock-#{index=KEY}"},"topicMappings":{"stock":{"itemTemplateRefs":["stockTemplate"],"items":null,"topic":"stocks"}}},"sslConfig":{"allowedCipherSuites":null,"allowedProtocols":null,"enableHostnameVerification":false,"enabled":false,"keystoreRef":null,"protocol":null,"truststoreRef":null}}

connectors.kafkaConnector.connections.quickStart.authentication

Optional. Authentication settings for the connection.

Type: object

Default:

{"credentialsSecretRef":null,"enabled":false,"gssapi":{"enableKeytab":false,"enableStoreKey":false,"enableTicketCache":false,"kerberosServiceName":null,"keytabFilePathRef":null,"principal":null},"mechanism":null}

connectors.kafkaConnector.connections.quickStart.authentication.credentialsSecretRef

Mandatory if mechanism is set to PLAIN, SCRAM-SHA-256, SCRAM-SHA-512. The name of the secret containing the credentials. The secret must contain the keys user and password.

Type: string

Default: nil

connectors.kafkaConnector.connections.quickStart.authentication.enabled

Optional. Enables the authentication of the connection against the Kafka Cluster.

Type: bool

Default: false

connectors.kafkaConnector.connections.quickStart.authentication.gssapi

Mandatory if mechanism is set to GSSAPI. The GSSAPI authentication settings.

Type: object

Default:

{"enableKeytab":false,"enableStoreKey":false,"enableTicketCache":false,"kerberosServiceName":null,"keytabFilePathRef":null,"principal":null}

{"enableSkipFailedMapping":null,"mappings":{"ask":"#{VALUE.ask}","ask_quantity":"#{VALUE.ask_quantity}","bid":"#{VALUE.bid}","bid_quantity":"#{VALUE.bid_quantity}","item_status":"#{VALUE.item_status}","last_price":"#{VALUE.last_price}","max":"#{VALUE.max}","min":"#{VALUE.min}","offset":"#{OFFSET}","open_price":"#{VALUE.open_price}","partition":"#{PARTITION}","pct_change":"#{VALUE.pct_change}","ref_price":"#{VALUE.ref_price}","stock_name":"#{VALUE.name}","time":"#{VALUE.time}","timestamp":"#{VALUE.timestamp}","topic":"#{TOPIC}","ts":"#{TIMESTAMP}"}}

connectors.kafkaConnector.connections.quickStart.fields.enableSkipFailedMapping

Optional. If set to true, if a field mapping fails, that specific field's value will simply be omitted from the update sent to the Lightstreamer clients, while other successfully mapped fields from the same record will still be delivered.

Type: string

Default: false

connectors.kafkaConnector.connections.quickStart.fields.mappings

Mandatory. Record data to Lightstreamer field mappings.

Type: object

Default:

{"ask":"#{VALUE.ask}","ask_quantity":"#{VALUE.ask_quantity}","bid":"#{VALUE.bid}","bid_quantity":"#{VALUE.bid_quantity}","item_status":"#{VALUE.item_status}","last_price":"#{VALUE.last_price}","max":"#{VALUE.max}","min":"#{VALUE.min}","offset":"#{OFFSET}","open_price":"#{VALUE.open_price}","partition":"#{PARTITION}","pct_change":"#{VALUE.pct_change}","ref_price":"#{VALUE.ref_price}","stock_name":"#{VALUE.name}","time":"#{VALUE.time}","timestamp":"#{VALUE.timestamp}","topic":"#{TOPIC}","ts":"#{TIMESTAMP}"}

connectors.kafkaConnector.connections.quickStart.record

Optional. Record evaluation settings. If not specified, all settings at their defaults will be used.

Type: object

Default:

{"consumeFrom":"EARLIEST","consumeWithOrderStrategy":null,"consumeWithThreadNumber":null,"extractionErrorStrategy":null,"keyEvaluator":{"enableSchemaRegistry":null,"localSchemaFilePathRef":null,"type":"INTEGER"},"schemaRegistryRef":null,"valueEvaluator":{"enableSchemaRegistry":null,"localSchemaFilePathRef":null,"type":"JSON"}}

connectors.kafkaConnector.connections.quickStart.record.consumeFrom

Optional. Specifies where to start consuming events from: - LATEST: start consuming events from the end of the topic partition. - EARLIEST: start consuming events from the beginning of the topic partition. Sets the value of the auto.offset.reset key to configure the internal Kafka Consumer. See https://kafka.apache.org/documentation/#consumerconfigs_auto.offset.reset

Type: string

Default: LATEST

connectors.kafkaConnector.connections.quickStart.record.consumeWithOrderStrategy

Optional, but effective only if consumeWithThreadNumber is set to a value greater than 1 (which includes the default value). The order strategy to be used for concurrent processing of the incoming deserialized records. If set to ORDER_BY_PARTITION, maintain the order of records within each partition. If set to ORDER_BY_KEY, maintain the order among the records sharing the same key. If set to UNORDERED, provide no ordering guarantees.

Type: string

Default: ORDER_BY_PARTITION

connectors.kafkaConnector.connections.quickStart.record.consumeWithThreadNumber

Optional. The number of threads to be used for parallel processing of the incoming deserialized records. If set to -1, the number of threads will be automatically determined based on the number of available CPU cores.

Type: int

Default: 1

connectors.kafkaConnector.connections.quickStart.record.extractionErrorStrategy

Optional. The error handling strategy to be used if an error occurs while extracting data from incoming deserialized records. If set to IGNORE_AND_CONTINUE, the error is ignored and the processing of the record continues. If set to FORCE_UNSUBSCRIPTION, the processing of the record is stopped and the unsubscription of the items requested by all the Lightstreamer clients subscribed to this connection is forced.

Type: string

Default: IGNORE_AND_CONTINUE

connectors.kafkaConnector.connections.quickStart.record.keyEvaluator

Optional. Key evaluator configuration. If not specified, all settings at their defaults will be used.

Type: object

Default:

{"enableSchemaRegistry":null,"localSchemaFilePathRef":null,"type":"INTEGER"}

connectors.kafkaConnector.connections.quickStart.record.keyEvaluator.enableSchemaRegistry

Optional. Enables the Confluent Schema Registry for validation of the key. Must be set to true when keyEvaluator.type is set to AVRO and no local schema are specified.

Type: string

Default: false

connectors.kafkaConnector.connections.quickStart.record.keyEvaluator.localSchemaFilePathRef

Mandatory if type is set to AVRO and enableSchemaRegistry is set to false. The reference to a local schema file (defined in connectors.kafkaConnectors.localSchemaFiles) for message validation of the key. The setting takes precedence over enableSchemaRegistry if the latter is set to true.

Type: string

Default: nil

connectors.kafkaConnector.connections.quickStart.record.keyEvaluator.type

Optional. The format to be used to deserialize the key of a Kafka record. Possible values: - AVRO - JSON - STRING - INTEGER - BOOLEAN - BYTE_ARRAY - BYTE_BUFFER - BYTES - DOUBLE - FLOAT - LONG - SHORT - UUID

Type: string

Default: STRING

connectors.kafkaConnector.connections.quickStart.record.schemaRegistryRef

Optional. The reference to a Schema Registry configuration defined in connectors.kafkaConnector.schemaRegistry.

Type: string

Default: nil

connectors.kafkaConnector.connections.quickStart.record.valueEvaluator

Optional. Value evaluator configuration. If not specified, all settings at their defaults will be used.

Type: object

Default:

{"enableSchemaRegistry":null,"localSchemaFilePathRef":null,"type":"JSON"}

connectors.kafkaConnector.connections.quickStart.record.valueEvaluator.enableSchemaRegistry

Optional. Enables the Confluent Schema Registry for validation of the value. Must be set to true when valueEvaluator.type is set to AVRO and no local schema are specified.

Type: string

Default: false

connectors.kafkaConnector.connections.quickStart.record.valueEvaluator.localSchemaFilePathRef

Mandatory if type is set to AVRO and enableSchemaRegistry is set to false. The reference to a local schema file (defined in connectors.kafkaConnectors.localSchemaFiles) for message validation of the value. The setting takes precedence over enableSchemaRegistry if the latter is set to true.

Type: string

Default: nil

connectors.kafkaConnector.connections.quickStart.record.valueEvaluator.type

Optional. The format to be used to deserialize the value of a Kafka record. See record.keyEvaluator.type for the list of supported formats.

Type: string

Default: STRING

connectors.kafkaConnector.connections.quickStart.routing

Mandatory. Record routings configuration.

Type: object

Default:

{"enableTopicRegEx":null,"itemTemplates":{"stockTemplate":"stock-#{index=KEY}"},"topicMappings":{"stock":{"itemTemplateRefs":["stockTemplate"],"items":null,"topic":"stocks"}}}

connectors.kafkaConnector.connections.quickStart.routing.enableTopicRegEx

Optional. Enables treating connectors.kafkaConnector.routing.topicMappings.{}.topic as a regular expression instead of a literal topic name.

Type: string

Default: false

connectors.kafkaConnector.connections.quickStart.routing.itemTemplates

Optional. Maps of item template expressions. An expression is made of: - ITEM_PREFIX: the prefix of the item name - BINDABLE_EXPRESSIONS: a sequence of bindable extraction expressions See https://lightstreamer.com/api/ls-kafka-connector/latest/ls-kafka-connector/record-extraction.html.

Type: object

Default: {}

connectors.kafkaConnector.connections.quickStart.routing.topicMappings

Mandatory. Kafka topic mappings.

Type: object

Default:

{"stock":{"itemTemplateRefs":["stockTemplate"],"items":null,"topic":"stocks"}}

connectors.kafkaConnector.connections.quickStart.routing.topicMappings.stock

At least one must be provided. A Kafka topic mapping. Map a Kafka topic to: - one or more simple items - one or more item templates - any combination of the above Examples: topicMappingSample1: topic: "aTopicName" items: - "item1" - "item2" - "itemN" topicMappingSample2: topic: "anotherTopicName" itemTemplateRefs: - "itemTemplate1" - "itemTemplate2" - "itemTemplateN" topicMappingSample3 topic: "yetAnotherTopicName" items: - "item1" - "item2" - "itemN" itemTemplateRefs: - "itemTemplate1" - "itemTemplate2" - "itemTemplateN"

Type: object

Default:

{"itemTemplateRefs":["stockTemplate"],"items":null,"topic":"stocks"}

connectors.kafkaConnector.connections.quickStart.routing.topicMappings.stock.itemTemplateRefs

Mandatory if items is empty. List of item templates to which the topic must be mapped.

Type: list

Default: []

connectors.kafkaConnector.connections.quickStart.routing.topicMappings.stock.items

Mandatory if itemTemplateRefs is empty. List of simple items to which the topic must be mapped.

Type: string

Default: []

connectors.kafkaConnector.connections.quickStart.routing.topicMappings.stock.topic

Mandatory and unique across all topic mappings. The Kafka topic name.

Type: string

Default: "stocks"

connectors.kafkaConnector.connections.quickStart.sslConfig

Optional. TLS/SSL settings for the connection.

Type: object

Default:

{"allowedCipherSuites":null,"allowedProtocols":null,"enableHostnameVerification":false,"enabled":false,"keystoreRef":null,"protocol":null,"truststoreRef":null}

connectors.kafkaConnector.logging

Mandatory. Global logging configuration for the Kafka Connector.

Type: object

Default:

{"appenders":{"stdout":{"pattern":"%d|%-10c{1}|%-5p|%m%n","type":"Console"}},"loggers":{"com.lightstreamer.kafka.adapters.pub.KafkaConnectorMetadataAdapter":{"appenders":["stdout"],"level":"INFO"},"org.apache.kafka":{"appenders":["stdout"],"level":"WARN"}}}

connectors.kafkaConnector.logging.appenders

Mandatory. Appenders configuration. Every logger must refer to one or more appenders defined here.

Type: object

Default:

{"stdout":{"pattern":"%d|%-10c{1}|%-5p|%m%n","type":"Console"}}

connectors.kafkaConnector.logging.appenders.stdout

At least one must be provided. An appender configuration.

Type: object

Default:

{"pattern":"%d|%-10c{1}|%-5p|%m%n","type":"Console"}

connectors.kafkaConnector.logging.appenders.stdout.pattern

Mandatory. The log message format pattern.

Type: string

Default: "%d|%-10c{1}|%-5p|%m%n"

connectors.kafkaConnector.logging.appenders.stdout.type

Mandatory. The appender type. Currently, only the Console type is supported.

Type: string

Default: "Console"

connectors.kafkaConnector.logging.loggers

Optional. Global loggers configuration.

Type: object

Default:

{"com.lightstreamer.kafka.adapters.pub.KafkaConnectorMetadataAdapter":{"appenders":["stdout"],"level":"INFO"},"org.apache.kafka":{"appenders":["stdout"],"level":"WARN"}}

connectors.kafkaConnector.logging.loggers."com.lightstreamer.kafka.adapters.pub.KafkaConnectorMetadataAdapter"

Logger for the Kafka Connector Metadata Adapter. Replace this key with the name of the custom Metadata Adapter class.

Type: object

Default: {"appenders":["stdout"],"level":"INFO"}

connectors.kafkaConnector.logging.loggers."org.apache.kafka"

Logger for the internal official Java client activities.

Type: object

Default: {"appenders":["stdout"],"level":"WARN"}

connectors.kafkaConnector.logging.loggers."org.apache.kafka".appenders

Mandatory. List of references to the appenders to be used by the logger.

Type: list

Default: ["stdout"]

connectors.kafkaConnector.logging.loggers."org.apache.kafka".level

Mandatory. The logger level.

Type: string

Default: "WARN"

connectors.kafkaConnector.provisioning

Mandatory. Defines the provisioning method of the Lightstreamer Kafka Connector. Either specify one of fromPathInImage, fromGitHubRelease, fromUrl, or fromVolume.

Type: object

Default:

{"fromGitHubRelease":null,"fromPathInImage":null,"fromUrl":null,"fromVolume":{"filePath":null,"name":null}}

connectors.kafkaConnector.schemaRegistry

Optional. Set of Schema Registry configurations.

Type: object

Default:

{"mySchemaRegistry":{"basicAuthentication":{"credentialsSecretRef":null,"enabled":false},"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableHostnameVerification":null,"keystoreRef":null,"truststoreRef":null},"url":"https://schema-registry:8084"}}

connectors.kafkaConnector.schemaRegistry.mySchemaRegistry

Mandatory if at least one of connections.{}.keyEvaluator.type or connections.{}.valueEvaluator.type is set to AVRO and no local schema paths are specified. Schema Registry configuration.

Type: object

Default:

{"basicAuthentication":{"credentialsSecretRef":null,"enabled":false},"sslConfig":{"allowCipherSuites":null,"allowProtocols":null,"enableHostnameVerification":null,"keystoreRef":null,"truststoreRef":null},"url":"https://schema-registry:8084"}

connectors.kafkaConnector.schemaRegistry.mySchemaRegistry.basicAuthentication

Optional. Basic HTTP authentication of a connection against the Schema Registry.

Type: object

Default: {"credentialsSecretRef":null,"enabled":false}

connectors.kafkaConnector.schemaRegistry.mySchemaRegistry.basicAuthentication.credentialsSecretRef

Mandatory if enabled is set to true. The name of the secret containing the credentials. The secret must contain the keys user and password.

Type: string

Default: nil

connectors.kafkaConnector.schemaRegistry.mySchemaRegistry.basicAuthentication.enabled

Optional. Enables Basic HTTP authentication.

Type: bool

Default: false

connectors.kafkaConnector.schemaRegistry.mySchemaRegistry.sslConfig

Mandatory if the https protocol is specified in url. TLS/SSL settings.

Type: object

Default:

{"allowCipherSuites":null,"allowProtocols":null,"enableHostnameVerification":null,"keystoreRef":null,"truststoreRef":null}

Autogenerated from chart metadata using helm-docs v1.14.2

License

Lightstreamer/helm-charts

About

Resources

License

Stars

Watchers

Forks

Releases 5

Packages 0

Languages

Packages