You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/basic-config.asciidoc
+26-26Lines changed: 26 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -8,30 +8,30 @@ can use.
8
8
[cols="<,<,<"]
9
9
|===
10
10
11
-
| **Parameter** | **Data type** | **Description**
12
-
| `adapter` | Symbol | A specific adapter for Faraday (for example, `:patron`).
13
-
| `api_key` | String, Hash | For API key Authentication. Either the base64 encoding of `id` and `api_key` joined by a colon as a string, or a hash with the `id` and `api_key` values.
14
-
| `compression` | Boolean | Whether to compress requests. Gzip compression is used. Defaults to `false`. Responses are automatically inflated if they are compressed. If a custom transport object is used, it must handle the request compression and response inflation.
15
-
| `enable_meta_header` | Boolean | Whether to enable sending the meta data header to Cloud. Defaults to `true`.
16
-
| `hosts` | String, Array | Single host passed as a string or hash, or multiple hosts passed as an array; `host` or `url` keys are also valid.
17
-
| `log` | Boolean | Whether to use the default logger. Disabled by default.
18
-
| `logger` | Object | An instance of a Logger-compatible object.
19
-
| `opaque_id_prefix` | String | Sets a prefix for X-Opaque-Id when initializing the client. This is prepended to the id you set before each request if you're using X-Opaque-Id.
20
-
| `opentelemetry_tracer_provider` | OpenTelemetry::Trace::TracerProvider | An explicit TracerProvider to use instead of the global one with OpenTelemetry. This enables better dependency injection and simplifies testing.
21
-
| `randomize_hosts` | Boolean | Whether to shuffle connections on initialization and reload. Defaults to `false`.
22
-
| `reload_connections` | Boolean, Number | Whether to reload connections after X requests. Defaults to `false`.
23
-
| `reload_on_failure` | Boolean | Whether to reload connections after failure. Defaults to `false`.
24
-
| `request_timeout` | Integer | The request timeout to be passed to transport in options.
25
-
| `resurrect_after` | Integer | Specifies after how many seconds a dead connection should be tried again.
26
-
| `retry_on_failure` | Boolean, Number | Whether to retry X times when request fails before raising and exception. Defaults to `false`.
27
-
| `retry_on_status` | Array, Number | Specifies which status code needs to be returned to retry.
28
-
| `selector` | Constant | An instance of selector strategy implemented with {Elastic::Transport::Transport::Connections::Selector::Base}.
29
-
| `send_get_body_as` | String | Specifies the HTTP method to use for GET requests with a body. Defaults to `GET`.
30
-
| `serializer_class` | Constant | Specifies a serializer class to use. It is initialized by the transport and passed the transport instance.
31
-
| `sniffer_timeout` | Integer | Specifies the timeout for reloading connections in seconds. Defaults to `1`.
32
-
| `trace` | Boolean | Whether to use the default tracer. Disabled by default.
33
-
| `tracer` | Object | Specifies an instance of a Logger-compatible object.
34
-
| `transport` | Object | Specifies a transport instance.
35
-
| `transport_class` | Constant | Specifies a transport class to use. It is initialized by the client and passed hosts and all arguments.
36
-
| `transport_options` | Hash | Specifies the options to be passed to the `Faraday::Connection` constructor.
11
+
| **Parameter** | **Data type** | **Description**
12
+
| `adapter` | Symbol | A specific adapter for Faraday (for example, `:patron`).
13
+
| `api_key` | String, Hash | For API key Authentication. Either the base64 encoding of `id` and `api_key` joined by a colon as a string, or a hash with the `id` and `api_key` values.
14
+
| `compression` | Boolean | Whether to compress requests. Gzip compression is used. Defaults to `false`. Responses are automatically inflated if they are compressed. If a custom transport object is used, it must handle the request compression and response inflation.
15
+
| `enable_meta_header` | Boolean | Whether to enable sending the meta data header to Cloud. Defaults to `true`.
16
+
| `hosts` | String, Array | Single host passed as a string or hash, or multiple hosts passed as an array; `host` or `url` keys are also valid.
17
+
| `log` | Boolean | Whether to use the default logger. Disabled by default.
18
+
| `logger` | Object | An instance of a Logger-compatible object.
19
+
| `opaque_id_prefix` | String | Sets a prefix for X-Opaque-Id when initializing the client. This is prepended to the id you set before each request if you're using X-Opaque-Id.
20
+
| `opentelemetry_tracer_provider` | `OpenTelemetry::Trace::TracerProvider` | An explicit TracerProvider to use instead of the global one with OpenTelemetry. This enables better dependency injection and simplifies testing.
21
+
| `randomize_hosts` | Boolean | Whether to shuffle connections on initialization and reload. Defaults to `false`.
22
+
| `reload_connections` | Boolean, Number | Whether to reload connections after X requests. Defaults to `false`.
23
+
| `reload_on_failure` | Boolean | Whether to reload connections after failure. Defaults to `false`.
24
+
| `request_timeout` | Integer | The request timeout to be passed to transport in options.
25
+
| `resurrect_after` | Integer | Specifies after how many seconds a dead connection should be tried again.
26
+
| `retry_on_failure` | Boolean, Number | Whether to retry X times when request fails before raising and exception. Defaults to `false`.
27
+
| `retry_on_status` | Array, Number | Specifies which status code needs to be returned to retry.
28
+
| `selector` | Constant | An instance of selector strategy implemented with {Elastic::Transport::Transport::Connections::Selector::Base}.
29
+
| `send_get_body_as` | String | Specifies the HTTP method to use for GET requests with a body. Defaults to `GET`.
30
+
| `serializer_class` | Constant | Specifies a serializer class to use. It is initialized by the transport and passed the transport instance.
31
+
| `sniffer_timeout` | Integer | Specifies the timeout for reloading connections in seconds. Defaults to `1`.
32
+
| `trace` | Boolean | Whether to use the default tracer. Disabled by default.
33
+
| `tracer` | Object | Specifies an instance of a Logger-compatible object.
34
+
| `transport` | Object | Specifies a transport instance.
35
+
| `transport_class` | Constant | Specifies a transport class to use. It is initialized by the client and passed hosts and all arguments.
36
+
| `transport_options` | Hash | Specifies the options to be passed to the `Faraday::Connection` constructor.
0 commit comments