Class ClientConfig

Configuration common to all clients

Inheritance
System.Object
Config
ClientConfig
AdminClientConfig
ConsumerConfig
ProducerConfig
Implements
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.String>>
System.Collections.IEnumerable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Confluent.Kafka
Assembly: cs.temp.dll.dll
Syntax
public class ClientConfig : Config, IEnumerable<KeyValuePair<string, string>>, IEnumerable

Constructors

ClientConfig()

Initialize a new empty ClientConfig instance.

Declaration
public ClientConfig()

ClientConfig(ClientConfig)

Initialize a new ClientConfig instance wrapping an existing ClientConfig instance. This will change the values "in-place" i.e. operations on this class WILL modify the provided collection

Declaration
public ClientConfig(ClientConfig config)
Parameters
Type Name Description
ClientConfig config

ClientConfig(IDictionary<String, String>)

Initialize a new ClientConfig instance wrapping an existing key/value pair collection. This will change the values "in-place" i.e. operations on this class WILL modify the provided collection

Declaration
public ClientConfig(IDictionary<string, string> config)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.String> config

Properties

Acks

This field indicates the number of acknowledgements the leader broker must receive from ISR brokers before responding to the request: Zero=Broker does not send any response/ack to client, One=The leader will write the record to its local log but will respond without awaiting full acknowledgement from all followers. All=Broker will block until message is committed by all in sync replicas (ISRs). If there are less than min.insync.replicas (broker configuration) in the ISR set the produce request will fail.

Declaration
public Acks? Acks { get; set; }
Property Value
Type Description
System.Nullable<Acks>

ApiVersionFallbackMs

Dictates how long the broker.version.fallback fallback is used in the case the ApiVersionRequest fails. NOTE: The ApiVersionRequest is only issued when a new connection to the broker is made (such as after an upgrade).

default: 0 importance: medium

Declaration
public int? ApiVersionFallbackMs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ApiVersionRequest

Request broker's supported API versions to adjust functionality to available protocol features. If set to false, or the ApiVersionRequest fails, the fallback version broker.version.fallback will be used. NOTE: Depends on broker version >=0.10.0. If the request is not supported by (an older) broker the broker.version.fallback fallback is used.

default: true importance: high

Declaration
public bool? ApiVersionRequest { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

ApiVersionRequestTimeoutMs

Timeout for broker API version requests.

default: 10000 importance: low

Declaration
public int? ApiVersionRequestTimeoutMs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

BootstrapServers

Initial list of brokers as a CSV list of broker host or host:port. The application may also use rd_kafka_brokers_add() to add brokers during runtime.

default: '' importance: high

Declaration
public string BootstrapServers { get; set; }
Property Value
Type Description
System.String

BrokerAddressFamily

Allowed broker IP address families: any, v4, v6

default: any importance: low

Declaration
public BrokerAddressFamily? BrokerAddressFamily { get; set; }
Property Value
Type Description
System.Nullable<BrokerAddressFamily>

BrokerAddressTtl

How long to cache the broker address resolving results (milliseconds).

default: 1000 importance: low

Declaration
public int? BrokerAddressTtl { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

BrokerVersionFallback

Older broker versions (before 0.10.0) provide no way for a client to query for supported protocol features (ApiVersionRequest, see api.version.request) making it impossible for the client to know what features it may use. As a workaround a user may set this property to the expected broker version and the client will automatically adjust its feature set accordingly if the ApiVersionRequest fails (or is disabled). The fallback broker version will be used for api.version.fallback.ms. Valid values are: 0.9.0, 0.8.2, 0.8.1, 0.8.0. Any other value >= 0.10, such as 0.10.2.1, enables ApiVersionRequests.

default: 0.10.0 importance: medium

Declaration
public string BrokerVersionFallback { get; set; }
Property Value
Type Description
System.String

ClientId

Client identifier.

default: rdkafka importance: low

Declaration
public string ClientId { get; set; }
Property Value
Type Description
System.String

ClientRack

A rack identifier for this client. This can be any string value which indicates where this client is physically located. It corresponds with the broker config broker.rack.

default: '' importance: low

Declaration
public string ClientRack { get; set; }
Property Value
Type Description
System.String

Debug

A comma-separated list of debug contexts to enable. Detailed Producer debugging: broker,topic,msg. Consumer: consumer,cgrp,topic,fetch

default: '' importance: medium

Declaration
public string Debug { get; set; }
Property Value
Type Description
System.String

EnableRandomSeed

If enabled librdkafka will initialize the POSIX PRNG with srand(current_time.milliseconds) on the first invocation of rd_kafka_new(). If disabled the application must call srand() prior to calling rd_kafka_new().

default: true importance: low

Declaration
public bool? EnableRandomSeed { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

EnableSaslOauthbearerUnsecureJwt

Enable the builtin unsecure JWT OAUTHBEARER token handler if no oauthbearer_refresh_cb has been set. This builtin handler should only be used for development or testing, and not in production.

default: false importance: low

Declaration
public bool? EnableSaslOauthbearerUnsecureJwt { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

EnableSslCertificateVerification

Enable OpenSSL's builtin broker (server) certificate verification. This verification can be extended by the application by implementing a certificate_verify_cb.

default: true importance: low

Declaration
public bool? EnableSslCertificateVerification { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

InternalTerminationSignal

Signal that librdkafka will use to quickly terminate on rd_kafka_destroy(). If this signal is not set then there will be a delay before rd_kafka_wait_destroyed() returns true as internal threads are timing out their system calls. If this signal is set however the delay will be minimal. The application should mask this signal as an internal signal handler is installed.

default: 0 importance: low

Declaration
public int? InternalTerminationSignal { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

LogConnectionClose

Log broker disconnects. It might be useful to turn this off when interacting with 0.9 brokers with an aggressive connection.max.idle.ms value.

default: true importance: low

Declaration
public bool? LogConnectionClose { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

LogQueue

Disable spontaneous log_cb from internal librdkafka threads, instead enqueue log messages on queue set with rd_kafka_set_log_queue() and serve log callbacks or events through the standard poll APIs. NOTE: Log messages will linger in a temporary queue until the log queue has been set.

default: false importance: low

Declaration
public bool? LogQueue { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

LogThreadName

Print internal thread name in log messages (useful for debugging librdkafka internals)

default: true importance: low

Declaration
public bool? LogThreadName { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

MaxInFlight

Maximum number of in-flight requests per broker connection. This is a generic property applied to all broker communication, however it is primarily relevant to produce requests. In particular, note that other mechanisms limit the number of outstanding consumer fetch request per broker to one.

default: 1000000 importance: low

Declaration
public int? MaxInFlight { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MessageCopyMaxBytes

Maximum size for message to be copied to buffer. Messages larger than this will be passed by reference (zero-copy) at the expense of larger iovecs.

default: 65535 importance: low

Declaration
public int? MessageCopyMaxBytes { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MessageMaxBytes

Maximum Kafka protocol request message size. Due to differing framing overhead between protocol versions the producer is unable to reliably enforce a strict max message limit at produce time and may exceed the maximum size by one message in protocol ProduceRequests, the broker will enforce the the topic's max.message.bytes limit (see Apache Kafka documentation).

default: 1000000 importance: medium

Declaration
public int? MessageMaxBytes { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MetadataMaxAgeMs

Metadata cache max age. Defaults to topic.metadata.refresh.interval.ms * 3

default: 900000 importance: low

Declaration
public int? MetadataMaxAgeMs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MetadataRequestTimeoutMs

Non-topic request timeout in milliseconds. This is for metadata requests, etc.

default: 60000 importance: low

Declaration
public int? MetadataRequestTimeoutMs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PluginLibraryPaths

List of plugin libraries to load (; separated). The library search path is platform dependent (see dlopen(3) for Unix and LoadLibrary() for Windows). If no filename extension is specified the platform-specific extension (such as .dll or .so) will be appended automatically.

default: '' importance: low

Declaration
public string PluginLibraryPaths { get; set; }
Property Value
Type Description
System.String

ReceiveMessageMaxBytes

Maximum Kafka protocol response message size. This serves as a safety precaution to avoid memory exhaustion in case of protocol hickups. This value must be at least fetch.max.bytes + 512 to allow for protocol overhead; the value is adjusted automatically unless the configuration property is explicitly set.

default: 100000000 importance: medium

Declaration
public int? ReceiveMessageMaxBytes { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ReconnectBackoffMaxMs

The maximum time to wait before reconnecting to a broker after the connection has been closed.

default: 10000 importance: medium

Declaration
public int? ReconnectBackoffMaxMs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

ReconnectBackoffMs

The initial time to wait before reconnecting to a broker after the connection has been closed. The time is increased exponentially until reconnect.backoff.max.ms is reached. -25% to +50% jitter is applied to each reconnect backoff. A value of 0 disables the backoff and reconnects immediately.

default: 100 importance: medium

Declaration
public int? ReconnectBackoffMs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SaslKerberosKeytab

Path to Kerberos keytab file. This configuration property is only used as a variable in sasl.kerberos.kinit.cmd as ... -t &quot;%{sasl.kerberos.keytab}&quot;.

default: '' importance: low

Declaration
public string SaslKerberosKeytab { get; set; }
Property Value
Type Description
System.String

SaslKerberosKinitCmd

Shell command to refresh or acquire the client's Kerberos ticket. This command is executed on client creation and every sasl.kerberos.min.time.before.relogin (0=disable). %{config.prop.name} is replaced by corresponding config object value.

default: kinit -R -t "%{sasl.kerberos.keytab}" -k %{sasl.kerberos.principal} || kinit -t "%{sasl.kerberos.keytab}" -k %{sasl.kerberos.principal} importance: low

Declaration
public string SaslKerberosKinitCmd { get; set; }
Property Value
Type Description
System.String

SaslKerberosMinTimeBeforeRelogin

Minimum time in milliseconds between key refresh attempts. Disable automatic key refresh by setting this property to 0.

default: 60000 importance: low

Declaration
public int? SaslKerberosMinTimeBeforeRelogin { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SaslKerberosPrincipal

This client's Kerberos principal name. (Not supported on Windows, will use the logon user's principal).

default: kafkaclient importance: low

Declaration
public string SaslKerberosPrincipal { get; set; }
Property Value
Type Description
System.String

SaslKerberosServiceName

Kerberos principal name that Kafka runs as, not including /hostname@REALM

default: kafka importance: low

Declaration
public string SaslKerberosServiceName { get; set; }
Property Value
Type Description
System.String

SaslMechanism

SASL mechanism to use for authentication. Supported: GSSAPI, PLAIN, SCRAM-SHA-256, SCRAM-SHA-512. NOTE: Despite the name, you may not configure more than one mechanism.

Declaration
public SaslMechanism? SaslMechanism { get; set; }
Property Value
Type Description
System.Nullable<SaslMechanism>

SaslOauthbearerConfig

SASL/OAUTHBEARER configuration. The format is implementation-dependent and must be parsed accordingly. The default unsecured token implementation (see https://tools.ietf.org/html/rfc7515#appendix-A.5) recognizes space-separated name=value pairs with valid names including principalClaimName, principal, scopeClaimName, scope, and lifeSeconds. The default value for principalClaimName is "sub", the default value for scopeClaimName is "scope", and the default value for lifeSeconds is 3600. The scope value is CSV format with the default value being no/empty scope. For example: principalClaimName=azp principal=admin scopeClaimName=roles scope=role1,role2 lifeSeconds=600. In addition, SASL extensions can be communicated to the broker via extension_NAME=value. For example: principal=admin extension_traceId=123

default: '' importance: low

Declaration
public string SaslOauthbearerConfig { get; set; }
Property Value
Type Description
System.String

SaslPassword

SASL password for use with the PLAIN and SASL-SCRAM-.. mechanism

default: '' importance: high

Declaration
public string SaslPassword { get; set; }
Property Value
Type Description
System.String

SaslUsername

SASL username for use with the PLAIN and SASL-SCRAM-.. mechanisms

default: '' importance: high

Declaration
public string SaslUsername { get; set; }
Property Value
Type Description
System.String

SecurityProtocol

Protocol used to communicate with brokers.

default: plaintext importance: high

Declaration
public SecurityProtocol? SecurityProtocol { get; set; }
Property Value
Type Description
System.Nullable<SecurityProtocol>

SocketKeepaliveEnable

Enable TCP keep-alives (SO_KEEPALIVE) on broker sockets

default: false importance: low

Declaration
public bool? SocketKeepaliveEnable { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

SocketMaxFails

Disconnect from broker when this number of send failures (e.g., timed out requests) is reached. Disable with 0. WARNING: It is highly recommended to leave this setting at its default value of 1 to avoid the client and broker to become desynchronized in case of request timeouts. NOTE: The connection is automatically re-established.

default: 1 importance: low

Declaration
public int? SocketMaxFails { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SocketNagleDisable

Disable the Nagle algorithm (TCP_NODELAY) on broker sockets.

default: false importance: low

Declaration
public bool? SocketNagleDisable { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

SocketReceiveBufferBytes

Broker socket receive buffer size. System default is used if 0.

default: 0 importance: low

Declaration
public int? SocketReceiveBufferBytes { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SocketSendBufferBytes

Broker socket send buffer size. System default is used if 0.

default: 0 importance: low

Declaration
public int? SocketSendBufferBytes { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SocketTimeoutMs

Default timeout for network requests. Producer: ProduceRequests will use the lesser value of socket.timeout.ms and remaining message.timeout.ms for the first message in the batch. Consumer: FetchRequests will use fetch.wait.max.ms + socket.timeout.ms. Admin: Admin requests will use socket.timeout.ms or explicitly set rd_kafka_AdminOptions_set_operation_timeout() value.

default: 60000 importance: low

Declaration
public int? SocketTimeoutMs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SslCaLocation

File or directory path to CA certificate(s) for verifying the broker's key. Defaults: On Windows the system's CA certificates are automatically looked up in the Windows Root certificate store. On Mac OSX it is recommended to install openssl using Homebrew, to provide CA certificates. On Linux install the distribution's ca-certificates package. If OpenSSL is statically linked or ssl.ca.location is set to probe a list of standard paths will be probed and the first one found will be used as the default CA certificate location path. If OpenSSL is dynamically linked the OpenSSL library's default path will be used (see OPENSSLDIR in openssl version -a).

default: '' importance: low

Declaration
public string SslCaLocation { get; set; }
Property Value
Type Description
System.String

SslCertificateLocation

Path to client's public key (PEM) used for authentication.

default: '' importance: low

Declaration
public string SslCertificateLocation { get; set; }
Property Value
Type Description
System.String

SslCertificatePem

Client's public key string (PEM format) used for authentication.

default: '' importance: low

Declaration
public string SslCertificatePem { get; set; }
Property Value
Type Description
System.String

SslCipherSuites

A cipher suite is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. See manual page for ciphers(1) and `SSL_CTX_set_cipher_list(3).

default: '' importance: low

Declaration
public string SslCipherSuites { get; set; }
Property Value
Type Description
System.String

SslCrlLocation

Path to CRL for verifying broker's certificate validity.

default: '' importance: low

Declaration
public string SslCrlLocation { get; set; }
Property Value
Type Description
System.String

SslCurvesList

The supported-curves extension in the TLS ClientHello message specifies the curves (standard/named, or 'explicit' GF(2^k) or GF(p)) the client is willing to have the server use. See manual page for SSL_CTX_set1_curves_list(3). OpenSSL >= 1.0.2 required.

default: '' importance: low

Declaration
public string SslCurvesList { get; set; }
Property Value
Type Description
System.String

SslEndpointIdentificationAlgorithm

Endpoint identification algorithm to validate broker hostname using broker certificate. https - Server (broker) hostname verification as specified in RFC2818. none - No endpoint verification. OpenSSL >= 1.0.2 required.

default: none importance: low

Declaration
public SslEndpointIdentificationAlgorithm? SslEndpointIdentificationAlgorithm { get; set; }
Property Value
Type Description
System.Nullable<SslEndpointIdentificationAlgorithm>

SslKeyLocation

Path to client's private key (PEM) used for authentication.

default: '' importance: low

Declaration
public string SslKeyLocation { get; set; }
Property Value
Type Description
System.String

SslKeyPassword

Private key passphrase (for use with ssl.key.location and set_ssl_cert())

default: '' importance: low

Declaration
public string SslKeyPassword { get; set; }
Property Value
Type Description
System.String

SslKeyPem

Client's private key string (PEM format) used for authentication.

default: '' importance: low

Declaration
public string SslKeyPem { get; set; }
Property Value
Type Description
System.String

SslKeystoreLocation

Path to client's keystore (PKCS#12) used for authentication.

default: '' importance: low

Declaration
public string SslKeystoreLocation { get; set; }
Property Value
Type Description
System.String

SslKeystorePassword

Client's keystore (PKCS#12) password.

default: '' importance: low

Declaration
public string SslKeystorePassword { get; set; }
Property Value
Type Description
System.String

SslSigalgsList

The client uses the TLS ClientHello signature_algorithms extension to indicate to the server which signature/hash algorithm pairs may be used in digital signatures. See manual page for SSL_CTX_set1_sigalgs_list(3). OpenSSL >= 1.0.2 required.

default: '' importance: low

Declaration
public string SslSigalgsList { get; set; }
Property Value
Type Description
System.String

StatisticsIntervalMs

librdkafka statistics emit interval. The application also needs to register a stats callback using rd_kafka_conf_set_stats_cb(). The granularity is 1000ms. A value of 0 disables statistics.

default: 0 importance: high

Declaration
public int? StatisticsIntervalMs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

TopicBlacklist

Topic blacklist, a comma-separated list of regular expressions for matching topic names that should be ignored in broker metadata information as if the topics did not exist.

default: '' importance: low

Declaration
public string TopicBlacklist { get; set; }
Property Value
Type Description
System.String

TopicMetadataPropagationMaxMs

Apache Kafka topic creation is asynchronous and it takes some time for a new topic to propagate throughout the cluster to all brokers. If a client requests topic metadata after manual topic creation but before the topic has been fully propagated to the broker the client is requesting metadata from, the topic will seem to be non-existent and the client will mark the topic as such, failing queued produced messages with ERR__UNKNOWN_TOPIC. This setting delays marking a topic as non-existent until the configured propagation max time has passed. The maximum propagation time is calculated from the time the topic is first referenced in the client, e.g., on produce().

default: 30000 importance: low

Declaration
public int? TopicMetadataPropagationMaxMs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

TopicMetadataRefreshFastIntervalMs

When a topic loses its leader a new metadata request will be enqueued with this initial interval, exponentially increasing until the topic metadata has been refreshed. This is used to recover quickly from transitioning leader brokers.

default: 250 importance: low

Declaration
public int? TopicMetadataRefreshFastIntervalMs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

TopicMetadataRefreshIntervalMs

Period of time in milliseconds at which topic and broker metadata is refreshed in order to proactively discover any new brokers, topics, partitions or partition leader changes. Use -1 to disable the intervalled refresh (not recommended). If there are no locally referenced topics (no topic objects created, no messages produced, no subscription or no assignment) then only the broker list will be refreshed every interval but no more often than every 10s.

default: 300000 importance: low

Declaration
public int? TopicMetadataRefreshIntervalMs { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

TopicMetadataRefreshSparse

Sparse metadata requests (consumes less network bandwidth)

default: true importance: low

Declaration
public bool? TopicMetadataRefreshSparse { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable