Connector Configuration

Providing Configuration

For information about about how the connector detects configuration properties, see Spring Boot: Externalized Configuration.

Converting Canonical Spring Property Names to Environment Variables

For information about converting the Spring property names to environment variables, see the Spring documentation.

Spring Profiles

If multiple configuration files exist within the same configuration directory for use in different environments (development, production, etc.), use Spring profiles.

Using Spring profiles allow you to define different application property files under the same directory using the application-{profile}.yml filename format.

For example:

application.yml: The properties in non-specific files that always apply. Its properties are overridden by the properties defined in profile-specific files.
application-dev.yml: Defines properties specific to the development environment.
application-prod.yml: Defines properties specific to the production environment.

Individual profiles can then be enabled by setting the spring.profiles.active property. See Spring Boot: Profile-Specific Files for more information and an example.

Configuring Locations to Find Spring Property Files

By default, the connector detects any Spring property files that are located in Spring Boot’s default locations.

If you want to configure additional locations, add --spring.config.additional-location=file:<custom-config-dir>.
If you want to exclusively use the locations that you’ve defined and ignore Spring Boot’s default locations, add --spring.config.location=optional:classpath:/,optional:classpath:/config/,file:<custom-config-dir>.

For example of the command to add additional locations, see Quick Start: Running the Connector Using the Command Line.

For more information about configuring locations to find Spring property files, see Spring Boot documentation.

If you want configuration files for multiple different connectors within the same config directory for use in different environments (such as, development, production, etc.), we recommend that you use Spring Boot Profiles instead of child directories.

For example, set up your configuration like this :

config/application-prod.yml
config/application-dev.yml

Do not set it up like this:

config/prod/application.yml
config/dev/application.yml

Child directories are intended to be used for merging configuration from multiple sources of configuration properties. For more information and an example showing when you might want to use multiple child directories to compose your application’s configuration, see the Spring Boot documentation.

Obtaining Build Information

Build information that includes the version, build date, time, and description is enabled by default using the Spring Boot Actuator Info Endpoint. By default, a connector only shares information related to its build.

The following example shows the structure of the output data:

{
"build": {
"version": "<connector version>",
"artifact": "<connector artifact>",
"name": "<connector name>",
"time": "<connector build time>",
"group": "<connector group>",
"description": "<connector description>",
"support": "<support information>"
}
}

If you want to exclude build data from the output of the info endpoint, set management.info.build.enabled to false.

Alternatively, if you want to disable the info endpoint entirely, you can remove info from the list of endpoints specified in management.endpoints.web.exposure.include.

Spring Configuration Options

This connector uses Spring configuration options to customize functionality that includes Spring Cloud Binder for Solace PubSub+ and other common Spring Boot libraries.

Using the Spring Cloud Binder for Solace PubSub+

An important piece for customizing the Spring configuration options for Self-Managed Connectors is the Spring Cloud Binder for Solace PubSub+. There are configuration options available that you may find useful to configure the connector such as:

endpointType, which is a consumer configuration option to configure the type of endpoint (queue or topic endpoint) that consumers read messages from
selector, which is a consumer configuration option to configure an endpoint's message selector
producer configuration options to publish messages within transacted sessions
authentication schemes to connect to a PubSub+ event broker, such as basic authentication (default) , client certificate, or OAuth 2.0

For more information about:

Other configuration options available for the Spring Cloud Binder for Solace PubSub+ and detailed information for the configuration options in the list above, see the Solace Binder Configuration Options.
The latest, supported features for the Spring Cloud Binder for Solace PubSub+, see the Spring Cloud Binder for Solace PubSub+ release notes.

Using Other Spring Boot Libraries

The following are other common references to Spring Boot libraries that you can use to configure your connector that you may find useful:

Snowflake Binder Configuration Options

The properties in the table that follows are complementary to the properties described in Configuring Connection Details.

These properties must be prefixed with snowflake.


Config Option	Type	Description
`url`	`string`	The Snowflake account URL in the format: `<locator>.<region>.snowflakecomputing.com:443` For instance, for the Snowflake account URL `https://nsb82454.us-east-1.snowflakecomputing.com/` the `url` property would be `nsb82454.us-east-1.snowflakecomputing.com:44`.
`username`	`string`	The user login name for the Snowflake account.
`role`	`string`	The role that the user should take while performing ingestion, for example: `ACCOUNTADMIN`, `SECURITYADMIN`, `USERADMIN`, `SYSADMIN`, `PUBLIC`. For more information, see: Create Role and Overview of Access Control in the Snowflake documentation.
`private-key-path`	`string`	The file protocol path to the private key to use to authenticate the user, for example, `'file:///C:/Users/admin/Documents/privateKeyPEM.p8'`. Supports both encrypted and unencrypted keys. For more information, see Key-pair authentication and key-pair rotation in the Snowflake documentation.
`private-key-password`	`string`	The password for the encrypted private key, if applicable.

Snowflake Producer Configuration Options

The following configuration options are available to Snowflake producers:

To apply a configuration option to all output bindings, prefix it with spring.cloud.stream.snowflake.default.producer.
To apply a configuration option to a specific binding, prefix it with spring.cloud.stream.snowflake.bindings.<bindingName>.producer.


Config Option	Type	Valid Values	Default Value	Description
`database`	`string`	`any`	`""`	The name of the database that contains the table to insert rows into. This name can also be specified in the binding `destination` binding when using a fully-qualified table name in the `<database>.<schema>.<table>` form.
`schema`	`string`	`any`	`""`	The name of the schema that contains the table to insert rows into. This name can also be specified in the `destination` binding when using a fully-qualified table name in the `<database>.<schema>.<table>` or `<schema>.<table>` form.
`table`	`string`	`any`	`""`	The name of the table to insert rows into. This name can also be specified in the `destination` binding when using a fully-qualified table name in the `<database>.<schema>.<table>`, `<schema>.<table>`, or `<table>` form. Specifying this name as a default binding setting allows multiple workflows to share the same target table without explicitly declaring the target table.
`acknowledgment-mode`	`string`	`(ON_COMMIT \| ON_INSERT)`	`ON_COMMIT`	This setting controls when the connector sends acknowledgments to the PubSub+ software event broker: If configured for `ON_COMMIT`, the connector waits until a row has been successfully committed to the target table before sending a message acknowledgment. If configured for `ON_INSERT`, the acknowledgment is sent as soon as the message has been written to the Snowflake channel or stage.
`provisioning-mode.tables`	`string`	`(NONE \| CREATE)`	`NONE`	This setting specifies whether and how the connector should provision the specified target table: If `NONE` is specified, the connector does not attempt to create the table. If `CREATE` is specified, the table is created if it does not exist.

Connector Configuration Options

The following table lists the configuration options. The following options in Config Option are prefixed with solace.connector.:

Config Option	Type	Valid Values	Default Value	Description
`management.leader- election.fail-over.max-attempts`	`int`	`> 0`	`3`	The maximum number of attempts to perform a fail-over.
`management.leader- election.fail-over.back-off-initial-interval`	`long`	`> 0`	`1000`	The initial interval (milliseconds) to back-off when retrying a fail-over.
`management.leader- election.fail-over.back-off-max-interval`	`long`	`> 0`	`10000`	The maximum interval (milliseconds) to back-off when retrying a fail-over.
`management.leader- election.fail-over.back-off-multiplier`	`double`	`>= 1.0`	`2.0`	The multiplier to apply to the back-off interval between each retry of a fail-over.
`management.leader-election.mode`	`enum`	`(standalone \| active_active \| active_standby)`	`standalone`	The connector’s leader election mode. standalone: A single instance of a connector without any leader election capabilities. active_active: A participant in a cluster of connector instances where all instances are active. active_standby: A participant in a cluster of connector instances where only one instance is active (i.e. the leader), and the others are standby.
`management.queue`	`string`	`any`	`null`	The management queue name.
`management.session.*`	See Spring Boot Auto-Configuration for the Solace Java API			Defines the management session. This has the same interface as that used by `solace.java.*`. See Spring Boot Auto-Configuration for the Solace Java API for more information.
`security.enabled`	`boolean`	`(true \| false)`	`true`	Indicates whether security is enabled on the endpoints for the connector. When `true`, security is enable, otherwise, anyone has access to the connector’s endpoints.
`security.users[<index>].name`	`string`	any	`null`	The name of the user.
`security.users[<index>].password`	`string`	any	`null`	The password for the user.
`security.users[<index>].roles`	`list<string>`	admin	empty list (i.e., read-only)	The list of roles that the specified user has. It has read-only access if no roles are returned.

Workflow Configuration Options

These configuration options are defined under the following prefixes:

solace.connector.workflows.<workflow-id>.: If the options support per-workflow configuration and the default prefixes.
solace.connector.default.workflow.: If the options support default workflow configuration.

Config Option	Applicable Scopes	Type	Valid Values	Default Value	Description
`enabled`	Per-Workflow	`boolean`	`(true \| false)`	`false`	If `true`, the workflow is enabled.
`transform-headers.expressions`	Per-Workflow Default	`Map<string, string>`	Key: A header name. Value: A SpEL string that accepts `headers` as parameters.	`empty map`	A mapping of header names to header value SpEL expressions. The SpEL context contains the headers parameter that can be used to read the input message’s headers.
`acknowledgment.publish-async`	Per-Workflow Default	`boolean`	`(true \| false)`	`false`	If `true`, publisher acknowledgment processing is done asynchronously. The workflow’s consumer and producer bindings must support this mode, otherwise the publisher acknowledgments are processed synchronously regardless of this setting.
`acknowledgment.back-pressure-threshold`	Per-Workflow Default	`int`	`>= 1`	`255`	The maximum number of outstanding messages with unresolved acknowledgments. Message consumption is paused when the threshold is reached to allow for producer acknowledgments to catch up.
`acknowledgment.publish-timeout`	Per-Workflow Default	`int`	`>= -1`	`600000`	The maximum amount of time (in milliseconds) to wait for asynchronous publisher acknowledgments before considering a message as failed. A value of `-1` means to wait indefinitely for publisher acknowledgments.

Provide feedback