Commit db086681 authored by Arjun Satish's avatar Arjun Satish
Browse files

CC-1372: Update docs 



Make config names consistent with existing ones. Add some lines to describe
what happens when the timeouts happen.

Signed-off-by: default avatarArjun Satish <arjun@confluent.io>
parent e9a9470a

docs/configuration_options.rst

+3 −3
Original line number Diff line number Diff line
@@ -61,15 +61,15 @@ Connector 
  * Default: 100

  * Importance: low



``conn.timeout.ms``

  How long to wait (in milliseconds) when establishing a connection to the Elasticsearch server.

``connection.timeout.ms``

  How long to wait in milliseconds when establishing a connection to the Elasticsearch server. The task fails if the client fails to connect to the server in this interval, and will need to be restarted.



  * Type: int

  * Default: 1000

  * Importance: low



``read.timeout.ms``

  How long to wait (in milliseconds) for the Elasticsearch server to send responses.

  How long to wait in milliseconds for the Elasticsearch server to send a response. The task fails if any read operation times out, and will need to be restarted to resume further operations.



  * Type: int

  * Default: 3000

src/main/java/io/confluent/connect/elasticsearch/ElasticsearchSinkConnectorConfig.java

+8 −4
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ public class ElasticsearchSinkConnectorConfig extends AbstractConfig { 
  public static final String TOPIC_KEY_IGNORE_CONFIG = "topic.key.ignore";

  public static final String SCHEMA_IGNORE_CONFIG = "schema.ignore";

  public static final String TOPIC_SCHEMA_IGNORE_CONFIG = "topic.schema.ignore";

  public static final String CONNECTION_TIMEOUT_MS_CONFIG = "conn.timeout.ms";

  public static final String CONNECTION_TIMEOUT_MS_CONFIG = "connection.timeout.ms";

  public static final String READ_TIMEOUT_MS_CONFIG = "read.timeout.ms";



  protected static ConfigDef baseConfigDef() {
@@ -84,10 +84,14 @@ public class ElasticsearchSinkConnectorConfig extends AbstractConfig { 
                  + "This avoids retrying in a tight loop under failure scenarios.",

                  group, ++order, Width.SHORT, "Retry Backoff (ms)")

          .define(CONNECTION_TIMEOUT_MS_CONFIG, Type.INT, 1000, Importance.LOW, "How long to wait "

                  + "(in milliseconds) when establishing a connection to the Elasticsearch server.",

                  + "in milliseconds when establishing a connection to the Elasticsearch server. "

                  + "The task fails if the client fails to connect to the server in this "

                  + "interval, and will need to be restarted.",

                  group, ++order, Width.SHORT, "Connection Timeout")

          .define(READ_TIMEOUT_MS_CONFIG, Type.INT, 3000, Importance.LOW, "How long to wait (in "

                  + "milliseconds) for the Elasticsearch server to send responses.",

          .define(READ_TIMEOUT_MS_CONFIG, Type.INT, 3000, Importance.LOW, "How long to wait in "

                  + "milliseconds for the Elasticsearch server to send a response. The task fails "

                  + "if any read operation times out, and will need to be restarted to resume "

                  + "further operations.",

                  group, ++order, Width.SHORT, "Read Timeout");

    }