PAGERDUTY SINK CONNECTOR
To use this connector, specify the name of the connector class in the connector.class configuration property.
connector.class
connector.class=io.confluent.connect.pagerduty.PagerDutySinkConnector
Connector-specific configuration properties are described below.
pagerduty.api.key
Use this API key into any application that needs access to the PagerDuty API. Just like your own password, this key lets an application modify your PagerDuty information.
pagerduty.max.retry.time.seconds
The maximum time upto which pagerduty client will try creating incidents. The least recommended value is 10 seconds.
behavior.on.error
Error handling behavior setting for PagerDuty incident creation. Must be configured to one of the following:
fail
ignore
log
${connector-name}-error
pagerduty.proxy.url
PagerDuty Proxy settings encoded in URL syntax. Use this property only if you need to access PagerDuty through a proxy.
pagerduty.proxy.user
PagerDuty Proxy User. Use this property only if you need to access PagerDuty through a proxy. Using pagerduty.proxy.user instead of embedding the username and password in pagerduty.proxy.url allows the password to be hidden in the logs.
pagerduty.proxy.password
PagerDuty Proxy Password. Use this property only if you need to access PagerDuty through a proxy. Using pagerduty.proxy.password instead of embedding the username and password in pagerduty.proxy.url allows the password to be hidden in the logs.
For more information about Reporter, see Connect Reporter.
reporter.result.topic.name
The name of the topic to produce records to after successfully processing a sink record. Use ${connector} within the pattern to specify the current connector name. Leave blank to disable error reporting behavior.
${connector}
+
.
_
-
reporter.result.topic.replication.factor
The replication factor of the result topic when it is automatically created by this connector. This determines how many broker failures can be tolerated before data loss occurs. This should be 1 in development environments and ALWAYS at least 3 in production environments.
reporter.result.topic.partitions
The number of partitions in the result topic when it is automatically created by this connector. This number of partitions should be the same as the number of input partitions to handle the potential throughput.
reporter.error.topic.name
The name of the topic to produce records to after each unsuccessful record sink attempt. Use ${connector} within the pattern to specify the current connector name. Leave blank to disable error reporting behavior.
reporter.error.topic.replication.factor
The replication factor of the error topic when it is automatically created by this connector. This determines how many broker failures can be tolerated before data loss occurs. This should be 1 in development environments and ALWAYS at least 3 in production environments.
reporter.error.topic.partitions
The number of partitions in the error topic when it is automatically created by this connector. This number of partitions should be the same as the number of input partitions in order to handle the potential throughput.
reporter.bootstrap.servers
A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers regardless of which bootstrap servers are specified here. This list only impacts the initial hosts used to discover the full set of servers. This list should be in the form host1:port1,host2:port2,.. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list does not need to contain the full set of servers. However, you may want to include more than one in case a server is down.
host1:port1,host2:port2,..
reporter.result.topic.key.format
The format in which the result report key is serialized.
reporter.result.topic.key.format.schemas.enable
reporter.result.topic.key.format.schemas.cache.size
reporter.result.topic.value.format
The format in which the result report value is serialized.
reporter.result.topic.value.format.schemas.cache.size
reporter.result.topic.value.format.schemas.enable
reporter.error.topic.key.format
The format in which the error report key is serialized.
reporter.error.topic.key.format.schemas.cache.size
reporter.error.topic.key.format.schemas.enable
reporter.error.topic.value.format
The format in which the error report value is serialized.
reporter.error.topic.value.format.schemas.cache.size
reporter.error.topic.value.format.schemas.enable
The maximum number of schemas that can be cached in the JSON formatter.
Include schemas within each of the serialized values and keys.
confluent.topic.bootstrap.servers A list of host/port pairs to use for establishing the initial connection to the Kafka cluster used for licensing. All servers in the cluster will be discovered from the initial connection. This list should be in the form <code>host1:port1,host2:port2,…</code>. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).
confluent.topic.bootstrap.servers
confluent.topic Name of the Kafka topic used for Confluent Platform configuration, including licensing information.
confluent.topic
confluent.topic.replication.factor The replication factor for the Kafka topic used for Confluent Platform configuration, including licensing information. This is used only if the topic does not already exist, and the default of 3 is appropriate for production use. If you are using a development environment with less than 3 brokers, you must set this to the number of brokers (often 1).
confluent.topic.replication.factor
Tip
While it is possible to include license-related properties in the connector configuration, starting with Confluent Platform version 6.0, you can now put license-related properties in the Connect worker configuration instead of in each connector configuration.
Note
This connector is proprietary and requires a license. The license information is stored in the _confluent-command topic. If the broker requires SSL for connections, you must include the security-related confluent.topic.* properties as described below.
_confluent-command
confluent.topic.*
confluent.license
Confluent issues enterprise license keys to each subscriber. The license key is text that you can copy and paste as the value for confluent.license. A trial license allows using the connector for a 30-day trial period. A developer license allows using the connector indefinitely for single-broker development environments.
If you are a subscriber, please contact Confluent Support for more information.
confluent.topic.ssl.truststore.location
The location of the trust store file.
confluent.topic.ssl.truststore.password
The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled.
confluent.topic.ssl.keystore.location
The location of the key store file. This is optional for client and can be used for two-way authentication for client.
confluent.topic.ssl.keystore.password
The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured.
confluent.topic.ssl.key.password
The password of the private key in the key store file. This is optional for client.
confluent.topic.security.protocol
Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.
A Confluent enterprise license is stored in the _confluent-command topic. This topic is created by default and contains the license that corresponds to the license key supplied through the confluent.license property.
No public keys are stored in Kafka topics.
The following describes how the default _confluent-command topic is generated under different scenarios:
_confluent command
confluent.license=
confluent.license=<valid-license-key>
Here is an example of the minimal properties for development and testing.
You can change the name of the _confluent-command topic using the confluent.topic property (for instance, if your environment has strict naming conventions). The example below shows this change and the configured Kafka bootstrap server.
confluent.topic=foo_confluent-command confluent.topic.bootstrap.servers=localhost:9092
The example above shows the minimally required bootstrap server property that you can use for development and testing. For a production environment, you add the normal producer, consumer, and topic configuration properties to the connector properties, prefixed with confluent.topic..
confluent.topic.
The _confluent-command topic contains the license that corresponds to the license key supplied through the confluent.license property. It is created by default. Connectors that access this topic require the following ACLs configured:
You can provide access either individually for each principal that will use the license or use a wildcard entry to allow all clients. The following examples show commands that you can use to configure ACLs for the resource cluster and _confluent-command topic.
Set a CREATE and DESCRIBE ACL on the resource cluster:
kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \ --add --allow-principal User:<principal> \ --operation CREATE --operation DESCRIBE --cluster
Set a DESCRIBE, READ, and WRITE ACL on the _confluent-command topic:
kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \ --add --allow-principal User:<principal> \ --operation DESCRIBE --operation READ --operation WRITE --topic _confluent-command
You can override the replication factor using confluent.topic.replication.factor. For example, when using a Kafka cluster as a destination with less than three brokers (for development and testing) you should set the confluent.topic.replication.factor property to 1.
1
You can override producer-specific properties by using the confluent.topic.producer. prefix and consumer-specific properties by using the confluent.topic.consumer. prefix.
confluent.topic.producer.
confluent.topic.consumer.
You can use the defaults or customize the other properties as well. For example, the confluent.topic.client.id property defaults to the name of the connector with -licensing suffix. You can specify the configuration settings for brokers that require SSL or SASL for client connections using this prefix.
confluent.topic.client.id
-licensing
You cannot override the cleanup policy of a topic because the topic always has a single partition and is compacted. Also, do not specify serializers and deserializers using this prefix; they are ignored if added.