Target Agent Advanced Settings
This document provides detailed information about all advanced settings available for Gluesync target agents. These settings control write behavior, batch operations, performance tuning, connection parameters, and other agent-specific configurations for writing data to target systems.
Common Target Settings
These settings are available across most SQL-based target agents (PostgreSQL, MySQL, MariaDB, SQL Server, Oracle, DB2 LUW, Informix, YugabyteDB, etc.) and control fundamental write behavior. NoSQL and message-broker agents (Couchbase, Kafka, MongoDB, Redis, Cassandra, Snowflake) may not support all of these settings.
Disable truncate on target table before snapshot inserts
Description: When enabled, prevents the agent from truncating the target table before performing snapshot insert operations.
Explanation: By default, Gluesync truncates the target table before inserting snapshot data to ensure a clean initial load. This setting disables that behavior, which can be useful when you want to preserve existing data in the target table or when you’re doing incremental snapshot updates. However, be aware that disabling truncation may lead to duplicate data if the snapshot is re-run.
Default: false
Applies to: Target
Max Write Batch Size
Description: Controls the maximum number of rows written in a single batch during normal CDC operations.
Explanation: This setting determines how many rows are written to the target in a single batch during ongoing CDC operations. Larger batch sizes can improve throughput by reducing the number of round trips to the database, but may increase memory usage and transaction duration. The optimal value depends on your target database’s capabilities and network latency.
Default: Varies by agent (typically 500-1000)
Applies to: Target
Max Delete Batch Size
Description: Controls the maximum number of rows deleted in a single batch during CDC operations.
Explanation: This setting determines how many delete operations are performed in a single batch during CDC operations. Larger batch sizes can improve delete performance but may increase lock contention and transaction duration. This is particularly important for targets that handle deletes differently than inserts.
Default: Varies by agent (typically 1000)
Applies to: Target
Max Write Bulk Size
Description: Controls the maximum number of rows written in a single bulk load operation during snapshot or bulk CDC operations.
Explanation: This setting determines how many rows are written in a single bulk load operation, which is typically used during initial snapshots or when handling large volumes of changes. Bulk operations use different mechanisms than normal CDC writes (such as staging tables or bulk load utilities) and can handle much larger volumes. Setting this too high may cause memory issues or timeouts.
Default: 250000 (varies by agent)
Applies to: Target
SQL Pre-Snapshot start command
Description: SQL command to execute before starting snapshot operations on the target.
Explanation: This setting allows you to specify a custom SQL command that will be executed on the target database before the snapshot begins. This is useful for performing preparation work such as disabling constraints, creating temporary tables, or setting session parameters. The command is executed in the context of the target database connection.
Default: (empty)
Applies to: Target
SQL Post-Snapshot stop command
Description: SQL command to execute after completing snapshot operations on the target.
Explanation: This setting allows you to specify a custom SQL command that will be executed on the target database after the snapshot completes. This is useful for cleanup work such as re-enabling constraints, dropping temporary tables, or gathering statistics. The command is executed in the context of the target database connection.
Default: (empty)
Applies to: Target
SQL Pre-CDC start command
Description: SQL command to execute before starting CDC operations on the target.
Explanation: This setting allows you to specify a custom SQL command that will be executed on the target database before CDC operations begin. This is useful for preparation work such as creating CDC-specific objects or setting session parameters for ongoing replication.
Default: (empty)
Applies to: Target
SQL Post-CDC stop command
Description: SQL command to execute after stopping CDC operations on the target.
Explanation: This setting allows you to specify a custom SQL command that will be executed on the target database when CDC operations stop. This is useful for cleanup work such as dropping CDC-specific objects or performing final consistency checks.
Default: (empty)
Applies to: Target
PostgreSQL Target Advanced Settings
State Preservation Table Name Prefix
Description: Specifies a prefix for state preservation table names used by the agent.
Explanation: This setting allows you to specify a custom prefix for state preservation tables that the agent creates for tracking CDC state and metadata. Using a custom prefix can help avoid naming conflicts in databases with many tables or align with your organization’s naming conventions.
Default: (empty)
Applies to: Target
MySQL Target Advanced Settings
Allow public key retrieval
Description: When enabled, allows the MySQL driver to retrieve the public key from the server for RSA key pair-based password exchange.
Explanation: This setting controls whether the MySQL JDBC driver can retrieve the server’s public key for RSA key pair-based password exchange. This is required for certain authentication methods like sha256_password or caching_sha2_password when the public key is not available locally.
Default: false
Applies to: Target
Zero date time behavior
Description: Controls how the MySQL driver handles zero date/time values.
Explanation: This setting determines how the MySQL JDBC driver handles date/time values that are "zero" (0000-00-00 or 0000-00-00 00:00:00). The default behavior is to convert these to NULL, but you can configure other behaviors such as raising an exception or rounding to the nearest valid date.
Default: CONVERT_TO_NULL
Applies to: Target
SQL Server Target Advanced Settings
Set fire triggers on bulk copy
Description: When enabled, fires triggers during bulk copy operations.
Explanation: This setting controls whether triggers are fired when the agent performs bulk copy operations. By default, triggers are fired during bulk operations to maintain data integrity and business logic. Disabling this can improve bulk load performance but may result in inconsistent data if triggers are needed for maintaining referential integrity or implementing business rules.
Default: true
Applies to: Target
Transaction isolation level
Description: Controls the transaction isolation level used for write operations.
Explanation: This setting determines the transaction isolation level used by the agent when writing to SQL Server. Different isolation levels provide different trade-offs between consistency and performance. Options include READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, and SERIALIZABLE.
Default: TRANSACTION_READ_COMMITTED
Applies to: Target
Options: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
MariaDB Target Advanced Settings
Allow public key retrieval
Description: When enabled, allows the MariaDB driver to retrieve the public key from the server for RSA key pair-based password exchange.
Explanation: This setting controls whether the MariaDB JDBC driver can retrieve the server’s public key for RSA key pair-based password exchange. This is required for certain authentication methods when the public key is not available locally.
Default: false
Applies to: Target
Zero date time behavior
Description: Controls how the MariaDB driver handles zero date/time values.
Explanation: This setting determines how the MariaDB JDBC driver handles date/time values that are "zero" (0000-00-00 or 0000-00-00 00:00:00). The default behavior is to convert these to NULL, but you can configure other behaviors such as raising an exception or rounding to the nearest valid date.
Default: CONVERT_TO_NULL
Applies to: Target
IBM i (AS400) Target Advanced Settings
The IBM i (AS400) target agent uses the Common Target Settings and Connection Settings (SQL-based Agents) described later in this document. There are no AS400-specific target advanced settings beyond those common ones.
IBM i (AS400) Connection Settings
These settings control IBM i-specific connection behavior and are available in addition to the common connection settings.
Date Format
Description: Specifies the date format used for IBM i connections.
Explanation: This setting controls how date values are interpreted when communicating with the IBM i system. The default iso format is recommended for most deployments. Other supported values include julian, mdy, dmy, ymd, usa, eur, and jis.
Default: iso
Applies to: Target
Time Format
Description: Specifies the time format used for IBM i connections.
Explanation: This setting controls how time values are interpreted when communicating with the IBM i system. The default iso format is recommended for most deployments. Other supported values include hms, usa, iso, eur, and jis.
Default: iso
Applies to: Target
Block Size (kilobytes)
Description: Controls the communication block size in kilobytes for IBM i connections.
Explanation: This setting determines the size of data blocks used for communication with the IBM i system. Larger block sizes can improve throughput for large data transfers but may increase memory usage. Allowed values are 0, 8, 16, 32, 64, 128, 256, and 512.
Default: 512
Applies to: Target
Lob Threshold
Description: Controls the threshold for LOB data handling in IBM i connections.
Explanation: This setting determines the threshold above which LOB data is handled with special processing. A value of 0 uses the system default behavior.
Default: 0
Applies to: Target
Gluesync library
Description: Specifies the IBM i library name where Gluesync stores its metadata objects.
Explanation: This setting defines the library (schema) on the IBM i system where Gluesync creates its journal checkpoint table and other metadata objects. The library must exist and the agent user must have appropriate permissions.
Default: GLUESYNC
Applies to: Source
Gluesync journal check point
Description: Specifies the name of the journal checkpoint table used by Gluesync on the IBM i system.
Explanation: This setting defines the name of the checkpoint table that Gluesync uses to track its position in the journal. This table is created in the Gluesync library.
Default: JOURNALSCP
Applies to: Source
Enable DDS keys discovery
Description: When enabled, discovers DDS-defined keys for physical files on the IBM i system.
Explanation: This setting controls whether the agent discovers keys defined via DDS (Data Description Specifications) for physical files. This is useful for older IBM i systems that use DDS-defined files rather than SQL tables.
Default: false
Applies to: Target
Use database timezone
Description: When enabled, uses the database server’s timezone for timestamp values.
Explanation: This setting controls whether timestamp values are interpreted using the IBM i system’s timezone rather than the agent’s local timezone. This can be important for ensuring consistent timestamp handling across different timezones.
Default: false
Applies to: Target
Enable full errors on JDBC connection
Description: When enabled, returns full error details from the JDBC driver.
Explanation: This setting controls whether the IBM i JDBC driver returns verbose error information. Enabling this can help with troubleshooting but may expose internal details in logs.
Default: false
Applies to: Target
Enable data truncation warnings
Description: When enabled, emits warnings when data is truncated during JDBC operations.
Explanation: This setting controls whether the JDBC driver generates warnings when data is truncated to fit column sizes. This can help identify data loss issues during replication.
Default: false
Applies to: Target
Enable data prefetch
Description: When enabled, prefetches data from the IBM i system to improve read performance.
Explanation: This setting controls whether the JDBC driver prefetches data rows. Prefetching can significantly improve read performance by reducing the number of round trips to the IBM i system.
Default: true
Applies to: Target
Translate binary
Description: When enabled, translates binary data to text during JDBC operations.
Explanation: This setting controls whether binary columns are translated to text. This may be needed for compatibility with certain applications but can alter binary data.
Default: false
Applies to: Target
Socket timeout (in seconds)
Description: Controls the socket timeout for IBM i connections in seconds.
Explanation: This setting determines how long the agent waits for socket operations to complete before timing out. A value of 0 means no timeout (wait indefinitely).
Default: 0 (no timeout)
Applies to: Target
Pool connection maximum inactivity (in minutes)
Description: Controls the maximum inactivity period for pooled connections in minutes.
Explanation: This setting determines how long a pooled connection can remain idle before being closed. This helps reclaim resources from unused connections.
Default: 30 minutes
Applies to: Target
Pool connection maximum lifetime (in minutes)
Description: Controls the maximum lifetime for pooled connections in minutes.
Explanation: This setting determines the maximum time a pooled connection can exist before being closed and replaced. This helps prevent issues with long-lived connections in environments with network infrastructure that drops idle connections.
Default: 60 minutes
Applies to: Target
Informix Target Advanced Settings
Staging table statistics mode
Description: Controls the statistics collection mode for staging tables used in bulk operations.
Explanation: This setting determines how statistics are collected on staging tables used during bulk load operations. Statistics collection affects query optimization for subsequent operations. Options include OFF (no statistics), LOW (basic statistics), and MEDIUM (more detailed statistics). Higher levels provide better optimization but increase the time required for bulk operations.
Default: LOW
Applies to: Target
Options: OFF, LOW, MEDIUM
Cassandra Target Advanced Settings
Max batch size in kb
Description: Controls the maximum batch size in kilobytes for Cassandra write operations.
Explanation: This setting determines the maximum size of batches sent to Cassandra in kilobytes. Cassandra has limits on batch sizes, and this setting helps ensure batches stay within acceptable limits. Larger batches can improve throughput but may hit Cassandra’s size limits or cause timeouts.
Default: 5 KB
Applies to: Target
Snowflake Target Advanced Settings
Strong consistency
Description: When enabled, ensures strong consistency for read operations during data replication.
Explanation: This setting controls whether the agent uses strong consistency when reading from Snowflake during replication operations. Strong consistency ensures that reads always see the latest committed data, but may have performance implications compared to eventual consistency modes.
Default: true
Applies to: Target
Warehouse
Description: Specifies the Snowflake warehouse to use for data operations.
Explanation: This setting allows you to specify which Snowflake warehouse should be used for data operations. Different warehouses provide different compute resources and cost characteristics. This can be used to separate workloads or optimize for specific performance requirements.
Default: COMPUTE_WH
Applies to: Target
Couchbase Target Advanced Settings
TTL (In seconds. Defaults to 0s, meaning no TTL)
Description: Sets the Time-To-Live (TTL) for documents written to Couchbase, in seconds.
Explanation: This setting controls how long documents written by the agent will persist in Couchbase before being automatically expired. A value of 0 means documents will not expire automatically. TTL can be useful for managing storage usage or implementing data retention policies.
Default: 0 (no expiration)
Applies to: Target
Write page size
Description: Controls the page size for write operations to Couchbase.
Explanation: This setting determines the page size used for write operations, affecting how many documents are included in each write operation. Larger page sizes can improve throughput but may increase memory usage and latency for individual operations.
Default: 250
Applies to: Target
Write page multiplier (multiplier / message kb)
Description: Multiplier for calculating the optimal write page size based on message size.
Explanation: This setting acts as a multiplier for calculating the optimal write page size based on the average message size in kilobytes. The formula is typically page_size * (message_size_kb * multiplier). This allows dynamic adjustment of page sizes based on the actual data being written.
Default: 0
Applies to: Target
Kafka Target Advanced Settings
Write page size
Description: Controls the page size for write operations to Kafka.
Explanation: This setting determines the page size used for write operations, affecting how many messages are included in each write operation. Larger page sizes can improve throughput but may increase memory usage and latency for individual operations.
Default: 250
Applies to: Target
Write page multiplier (multiplier / message kb)
Description: Multiplier for calculating the optimal write page size based on message size.
Explanation: This setting acts as a multiplier for calculating the optimal write page size based on the average message size in kilobytes. The formula is typically page_size * (message_size_kb * multiplier). This allows dynamic adjustment of page sizes based on the actual data being written.
Default: 0
Applies to: Target
YugabyteDB Target Advanced Settings
Load balance
Description: When enabled, enables load balancing for database connections.
Explanation: This setting controls whether the agent uses load balancing when connecting to YugabyteDB nodes in a cluster. Load balancing can distribute read operations across multiple nodes, improving performance and resource utilization.
Default: false
Applies to: Target
Enable Recursion Protection
Description: When enabled, prevents the agent from processing changes that were made by its own connection username to avoid infinite loops in bi-directional sync arrangements.
Explanation: In bi-directional synchronization scenarios, changes made by the agent itself could be captured and sent back to the source, creating infinite loops. When enabled, this setting instructs Gluesync to filter out operations executed by the agent’s own connection username.
Default: false
Applies to: Target
Connection Settings (SQL-based Agents)
These settings control connection behavior and are available across most SQL-based target agents. NoSQL and message-broker agents (Couchbase, Kafka, MongoDB, Redis, Cassandra) have their own agent-specific connection settings documented in their respective sections below.
Use connection pool
Description: When enabled, uses connection pooling for database connections.
Explanation: This setting controls whether the agent uses connection pooling for database connections. Connection pooling can significantly improve performance by reusing existing connections instead of creating new ones for each operation. This is particularly beneficial for high-throughput scenarios.
Default: true
Applies to: Target
Gluesync schema name (necessary for bulk operations)
Description: Specifies the schema name used by Gluesync for metadata and bulk operations.
Explanation: This setting defines the schema name where Gluesync creates its metadata tables and performs bulk operations. This schema is used for storing state information, staging tables for bulk loads, and other agent-specific objects. The schema must exist and the agent user must have appropriate permissions.
Default: gluesync (varies by agent)
Applies to: Target
Disable automatic schema creation
Description: When enabled, prevents the agent from automatically creating schemas and database objects.
Explanation: By default, the agent automatically creates necessary schemas and database objects for its operation. This setting disables automatic creation, requiring all necessary schemas and objects to be manually created and configured. This is useful for environments with strict change management processes.
Default: false
Applies to: Target
Oracle Target Settings
Connection type
Description: Specifies the Oracle connection type (SERVICE_NAME or SID).
Explanation: This setting determines how the agent connects to Oracle - using either service names or SIDs. Service names are the modern recommended approach and support features like RAC, while SIDs are the older method. The choice depends on your Oracle database configuration.
Default: SERVICE_NAME (SID for the Oracle XStream agent)
Applies to: Target
Options: SERVICE_NAME, SID
Use wallet
Description: When enabled, uses Oracle wallet for authentication.
Explanation: This setting controls whether the agent uses Oracle wallet for authentication instead of username/password. Wallet authentication provides enhanced security and is often required in enterprise environments with strict security policies.
Default: false
Applies to: Target
Instance name
Description: Specifies the Oracle instance name for connection.
Explanation: This setting allows you to specify the Oracle instance name when connecting to the database. This is typically used in RAC environments or when multiple instances are available.
Default: (empty)
Applies to: Target
Wallet path
Description: Specifies the file system path to the Oracle wallet.
Explanation: This setting specifies the file system path to the Oracle wallet directory when wallet authentication is enabled. The wallet must be accessible from the machine running the Gluesync agent.
Default: (empty)
Applies to: Target
DB2 LUW Target Settings
Login Timeout (seconds)
Description: Controls the timeout for login operations in seconds.
Explanation: This setting determines how long the agent waits for login operations to complete before timing out. A higher value provides more time for authentication in slow networks but may delay error detection.
Default: 30 seconds
Applies to: Target
Connection Timeout (seconds)
Description: Controls the timeout for establishing database connections in seconds.
Explanation: This setting determines how long the agent waits for database connection establishment before timing out. A value of 0 means no timeout (wait indefinitely). This is separate from the login timeout and applies to the connection establishment phase.
Default: 0 (no timeout)
Applies to: Target
Socket Timeout (seconds)
Description: Controls the socket timeout for database operations in seconds.
Explanation: This setting determines how long the agent waits for socket operations to complete before timing out. A value of 0 means no timeout. This affects read operations on established connections.
Default: 0 (no timeout)
Applies to: Target
Enable Keep-Alive
Description: When enabled, enables TCP keep-alive for database connections.
Explanation: This setting controls whether TCP keep-alive is enabled for database connections. Keep-alive can help detect dead connections and improve reliability in long-running connections, but may increase network traffic.
Default: true
Applies to: Target
Enable Auto Reconnect
Description: When enabled, automatically reconnects to the database when connections are lost.
Explanation: This setting controls whether the agent automatically attempts to reconnect to the database when connections are lost. When enabled, the agent will try to re-establish connections using the configured retry logic.
Default: false
Applies to: Target
Max Reconnects
Description: Controls the maximum number of reconnection attempts.
Explanation: This setting determines how many times the agent will attempt to reconnect to the database before giving up. This works in conjunction with the auto-reconnect setting.
Default: 3
Applies to: Target
Initial Reconnect Delay (ms)
Description: Controls the initial delay before the first reconnection attempt in milliseconds.
Explanation: This setting determines how long the agent waits before attempting the first reconnection after a connection loss. Subsequent attempts may use exponential backoff depending on the driver implementation.
Default: 1000 ms (1 second)
Applies to: Target
Driver Type
Description: Specifies the JDBC driver type to use for DB2 connections.
Explanation: This setting controls which JDBC driver type is used for connecting to DB2. Type 4 is the modern pure Java driver that uses TCP/IP and is the recommended default. Other types may be available for specific legacy requirements.
Default: 4
Applies to: Target
Security Mechanism
Description: Specifies the security mechanism for DB2 authentication.
Explanation: This setting determines which security mechanism is used for DB2 authentication. Different mechanisms provide different levels of security and compatibility. The default (3) corresponds to CLEAR_TEXT_PASSWORD_SECURITY, which is commonly used.
Default: 3
Applies to: Target
Retrieve Messages on Get
Description: When enabled, retrieves messages from the server on get operations.
Explanation: This setting controls whether the agent retrieves informational messages from the DB2 server during operations. These messages can provide additional context but may increase overhead.
Default: true
Applies to: Target
Current Schema
Description: Specifies the default schema to use for database operations.
Explanation: This setting allows you to specify the default schema that will be used for database operations when no schema is explicitly specified. This can simplify configuration by providing a default context.
Default: (null)
Applies to: Target
Client Program Name
Description: Specifies the program name to identify the client in DB2 monitoring tools.
Explanation: This setting allows you to specify a custom program name that will appear in DB2 monitoring and logging tools, making it easier to identify connections from this agent.
Default: (null)
Applies to: Target
Client Workstation
Description: Specifies the workstation name to identify the client in DB2 monitoring tools.
Explanation: This setting allows you to specify a custom workstation name that will appear in DB2 monitoring and logging tools, making it easier to identify the source of connections.
Default: (null)
Applies to: Target
Client User
Description: Specifies the user name to identify the client in DB2 monitoring tools.
Explanation: This setting allows you to specify a custom user name that will appear in DB2 monitoring and logging tools, making it easier to identify connections from this agent.
Default: (null)
Applies to: Target
|
The following additional connection settings are available only in the DB2 LUW Triggers agent variant (not the CDC variant): |
Character Encoding
Description: Specifies the character encoding used for DB2 connections.
Explanation: This setting controls the character encoding used when reading and writing data to DB2. The default UTF-8 is suitable for most modern deployments, but you may need to change it for databases using legacy encodings.
Default: UTF-8
Applies to: Target
Auto Commit
Description: Controls whether connections are in auto-commit mode.
Explanation: When enabled, each SQL statement is executed and committed individually. When disabled, statements are grouped into transactions that must be explicitly committed. The default follows the JDBC standard of auto-commit enabled.
Default: true
Applies to: Target
Query Timeout (seconds)
Description: Controls the timeout for individual query execution in seconds.
Explanation: This setting determines how long a single query is allowed to run before being aborted. A value of 0 means no timeout (queries may run indefinitely). This is separate from the connection and socket timeouts.
Default: 0 (no timeout)
Applies to: Target
Enable LOB Support
Description: When enabled, enables Large Object (LOB) support for DB2 connections.
Explanation: This setting controls whether LOB data types (BLOB, CLOB, etc.) are handled with special LOB-aware processing. Disabling this may improve performance for workloads that do not involve LOB data.
Default: true
Applies to: Target
Enable Query Result Caching
Description: When enabled, caches query results for DB2 operations.
Explanation: This setting controls whether query results are cached locally. Caching can improve performance for repeated queries but may increase memory usage.
Default: false
Applies to: Target
Enable Query Result Streaming
Description: When enabled, streams query results instead of loading them entirely into memory.
Explanation: This setting controls whether large result sets are streamed from the database rather than being loaded into memory all at once. Streaming reduces memory usage for large queries but may slightly increase latency.
Default: true
Applies to: Target
Enable Query Timeout
Description: When enabled, activates the query timeout setting for DB2 operations.
Explanation: This setting controls whether the Query Timeout (seconds) setting is actively enforced. When disabled, queries run without a timeout regardless of the configured value.
Default: true
Applies to: Target
Enable Batch Processing
Description: When enabled, uses batch processing for DB2 write operations.
Explanation: This setting controls whether write operations are grouped into batches for more efficient execution. Batch processing can significantly improve throughput for high-volume write workloads.
Default: true
Applies to: Target
Max Reconnect Delay (ms)
Description: Controls the maximum delay between reconnection attempts in milliseconds.
Explanation: When the agent is reconnecting to DB2, it uses an exponential backoff strategy. This setting caps the maximum delay between retry attempts. The default of 30000 ms (30 seconds) prevents overly long waits while still allowing time for the database to recover.
Default: 30000 ms (30 seconds)
Applies to: Target
MongoDB Target Settings
Connection Timeout Seconds
Description: Controls the timeout for establishing MongoDB connections in seconds.
Explanation: This setting determines how long the agent waits for MongoDB connection establishment before timing out. A higher value provides more time for connection in slow networks but may delay error detection.
Default: 30 seconds
Applies to: Target
Read Timeout Seconds
Description: Controls the timeout for read operations from MongoDB in seconds.
Explanation: This setting determines how long the agent waits for read operations to complete before timing out. A higher value provides more time for complex queries but may delay error detection.
Default: 30 seconds
Applies to: Target
Auth Database
Description: Specifies the authentication database for MongoDB connections.
Explanation: This setting specifies which database to use for MongoDB authentication. In MongoDB, user credentials are stored in a specific database (typically admin), and this setting tells the agent where to authenticate.
Default: (empty)
Applies to: Target
Use Dns Seed List
Description: When enabled, uses DNS seed list for MongoDB connection discovery.
Explanation: This setting controls whether the agent uses DNS seed list discovery for finding MongoDB servers in a replica set or sharded cluster. DNS seed lists provide a flexible way to configure server discovery.
Default: false
Applies to: Target
Replica Set
Description: Specifies the replica set name for MongoDB connections.
Explanation: This setting specifies the name of the MongoDB replica set when connecting to a replica set deployment. This is required for proper replica set discovery and connection behavior.
Default: (empty)
Applies to: Target
Direct connection
Description: When enabled, establishes a direct connection to a single MongoDB server.
Explanation: This setting controls whether the agent connects directly to a single MongoDB server instead of discovering and connecting to all servers in a replica set. This is typically used for single-server deployments or specific connection scenarios.
Default: false
Applies to: Target
Cassandra Target Settings
Connection Timeout
Description: Controls the timeout for establishing Cassandra connections in seconds.
Explanation: This setting determines how long the agent waits for Cassandra connection establishment before timing out. A higher value provides more time for connection in slow networks but may delay error detection.
Default: 30 seconds
Applies to: Target
Datacenter
Description: Specifies the datacenter for Cassandra connections in a multi-datacenter deployment.
Explanation: This setting specifies which datacenter the agent should connect to in a multi-datacenter Cassandra deployment. This is important for controlling data locality and latency in distributed environments.
Default: (empty)
Applies to: Target
Redis Target Settings
SASL Mechanism
Description: Specifies the SASL mechanism for Redis authentication.
Explanation: This setting determines which SASL (Simple Authentication and Security Layer) mechanism is used for Redis authentication. Different mechanisms provide different security levels and compatibility. The default is SCRAM-SHA-256, which provides good security.
Default: SCRAM-SHA-256
Applies to: Target
Options: GSSAPI, OAUTHBEARER, PLAIN, SCRAM-SHA-256, SCRAM-SHA-512
Security Protocol
Description: Specifies the security protocol for Redis connections.
Explanation: This setting determines which security protocol is used for Redis connections. Different protocols provide different levels of encryption and authentication. SASL_SSL is the default and provides both authentication and encryption.
Default: SASL_SSL
Applies to: Target
Options: PLAINTEXT, SASL_PLAINTEXT, SASL_SSL, SSL
Certificate Type
Description: Specifies the certificate type for SSL/TLS connections.
Explanation: This setting determines the certificate format used for SSL/TLS connections. PEM is the most common format and is the default, while JKS is Java-specific and may be required in certain environments.
Default: PEM
Applies to: Target
Options: PEM, JKS
Couchbase Target Settings
Connection Timeout
Description: Controls the timeout for establishing Couchbase connections in seconds.
Explanation: This setting determines how long the agent waits for Couchbase connection establishment before timing out. A higher value provides more time for connection in slow networks but may delay error detection.
Default: 30 seconds
Applies to: Target
Transaction Timeout
Description: Controls the timeout for Couchbase transaction operations in seconds.
Explanation: This setting determines how long the agent waits for Couchbase transaction operations to complete before timing out. Transactions that exceed this timeout will be rolled back.
Default: 60 seconds
Applies to: Target
Key-Value Timeout
Description: Controls the timeout for Couchbase key-value operations in seconds.
Explanation: This setting determines how long the agent waits for key-value operations (get, set, delete) to complete before timing out.
Default: 30 seconds
Applies to: Target
Key-Value Durable Timeout
Description: Controls the timeout for durable key-value operations in seconds.
Explanation: This setting determines how long the agent waits for durable key-value operations (those that require disk persistence) to complete before timing out.
Default: 30 seconds
Applies to: Target
Query Timeout
Description: Controls the timeout for Couchbase query operations in seconds.
Explanation: This setting determines how long the agent waits for N1QL query operations to complete before timing out.
Default: 75 seconds
Applies to: Target
Management Timeout
Description: Controls the timeout for Couchbase management operations in seconds.
Explanation: This setting determines how long the agent waits for management API operations (bucket management, cluster management) to complete before timing out.
Default: 75 seconds
Applies to: Target
Analytics Timeout
Description: Controls the timeout for Couchbase analytics operations in seconds.
Explanation: This setting determines how long the agent waits for Couchbase analytics service operations to complete before timing out.
Default: 75 seconds
Applies to: Target
Search Timeout
Description: Controls the timeout for Couchbase search operations in seconds.
Explanation: This setting determines how long the agent waits for full-text search operations to complete before timing out.
Default: 75 seconds
Applies to: Target
View Timeout
Description: Controls the timeout for Couchbase view operations in seconds.
Explanation: This setting determines how long the agent waits for Couchbase view operations (legacy map-reduce views) to complete before timing out.
Default: 75 seconds
Applies to: Target
Key-Value Connections Number
Description: Controls the number of key-value connections to maintain in the connection pool.
Explanation: This setting determines how many key-value connections are maintained in the connection pool for Couchbase operations. More connections can improve throughput but consume more resources.
Default: 2
Applies to: Target
Enable Dns Srv
Description: When enabled, uses DNS SRV records for Couchbase cluster discovery.
Explanation: This setting controls whether the agent uses DNS SRV records to discover Couchbase cluster nodes. DNS SRV provides automatic cluster discovery and can simplify configuration in dynamic environments.
Default: true
Applies to: Target
Enable Client-Side Compression
Description: When enabled, enables client-side compression for data transfer.
Explanation: This setting controls whether the agent compresses data before sending it to Couchbase. Compression can reduce network bandwidth usage but may increase CPU usage on both client and server.
Default: false
Applies to: Target
Kafka Target Settings
SASL Mechanism
Description: Specifies the SASL mechanism for Kafka authentication.
Explanation: This setting determines which SASL (Simple Authentication and Security Layer) mechanism is used for Kafka authentication. Different mechanisms provide different security levels and compatibility. The default is SCRAM-SHA-256, which provides good security.
Default: SCRAM-SHA-256
Applies to: Target
Options: GSSAPI, OAUTHBEARER, PLAIN, SCRAM-SHA-256, SCRAM-SHA-512
Security Protocol
Description: Specifies the security protocol for Kafka connections.
Explanation: This setting determines which security protocol is used for Kafka connections. Different protocols provide different levels of encryption and authentication. SASL_SSL is the default and provides both authentication and encryption.
Default: SASL_SSL
Applies to: Target
Options: PLAINTEXT, SASL_PLAINTEXT, SASL_SSL, SSL
Certificate Type
Description: Specifies the certificate type for SSL/TLS connections.
Explanation: This setting determines the certificate format used for SSL/TLS connections. PEM is the most common format and is the default, while JKS is Java-specific and may be required in certain environments.
Default: PEM
Applies to: Target
Options: PEM, JKS
SQL Server Target Connection Settings
Send Time As Datetime
Description: When enabled, sends time values as datetime parameters to SQL Server.
Explanation: This setting controls how time values are sent to SQL Server. When enabled, time values are sent as datetime parameters; when disabled, they are sent as time parameters. This can affect how SQL Server interprets and processes time values.
Default: false
Applies to: Target
Disable DB compression
Description: When enabled, disables database compression for SQL Server connections.
Explanation: This setting controls whether database compression is used for SQL Server connections. Compression can reduce network bandwidth usage but may increase CPU usage. Disabling it may be necessary for compatibility with certain SQL Server configurations or for performance tuning.
Default: false
Applies to: Target
Informix Target Connection Settings
CDC Database Name
Description: Specifies the database name for CDC operations in Informix.
Explanation: This setting specifies which database contains the CDC infrastructure and configuration for Informix. The CDC database typically contains the CDC capture tables and configuration metadata.
Default: syscdcv1
Applies to: Target
Informix Server Name
Description: Specifies the Informix server name for connections.
Explanation: This setting allows you to specify the Informix server name when connecting to the database. This is typically used in environments with multiple Informix server instances.
Default: (empty)
Applies to: Target
Database locale
Description: Specifies the database locale for Informix connections.
Explanation: This setting controls the locale used for database operations, affecting how character data, dates, and other locale-sensitive data are processed and displayed.
Default: (empty)
Applies to: Target
Transaction isolation level
Description: Controls the transaction isolation level used for write operations.
Explanation: This setting determines the transaction isolation level used by the agent when writing to Informix. Different isolation levels provide different trade-offs between consistency and performance.
Default: TRANSACTION_READ_COMMITTED
Applies to: Target
Options: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
Allow new lines
Description: When enabled, allows new lines in character data.
Explanation: This setting controls whether the agent allows new line characters in character data when writing to Informix. Some Informix configurations may not handle new lines properly in certain data types.
Default: false
Applies to: Target
Lock mode wait timeout in seconds (-1 for infinite wait, 0 for no wait)
Description: Controls the timeout for lock mode wait operations in seconds.
Explanation: This setting determines how long the agent waits for locks to be released before timing out. A value of -1 means wait indefinitely, 0 means don’t wait (fail immediately), and positive values specify the wait time in seconds.
Default: 15 seconds
Applies to: Target
Use last committed isolation
Description: When enabled, uses last committed isolation for read operations.
Explanation: This setting controls whether the agent uses last committed isolation for read operations. Last committed isolation can provide better concurrency by reading the last committed version of rows rather than waiting for locks to be released.
Default: true
Applies to: Target