› ›

基本配置

基本配置编辑

下表包含了您可以使用的最重要的初始化参数。

参数	数据类型	描述
`adapter`	符号	Faraday 的特定适配器（例如，`:patron`）。
`api_key`	字符串，哈希	用于 API 密钥身份验证。可以是 `id` 和 `api_key` 用冒号连接的 base64 编码字符串，也可以是包含 `id` 和 `api_key` 值的哈希。
`compression`	布尔值	是否压缩请求。使用 Gzip 压缩。默认为 `false`。如果响应被压缩，则会自动解压缩。如果使用自定义传输对象，则必须处理请求压缩和响应解压缩。
`enable_meta_header`	布尔值	是否启用向云发送元数据标头。默认为 `true`。
`hosts`	字符串，数组	作为字符串或哈希传递的单个主机，或作为数组传递的多个主机；`host` 或 `url` 键也是有效的。
`log`	布尔值	是否使用默认记录器。默认情况下禁用。
`logger`	对象	与 Logger 兼容的对象的实例。
`opaque_id_prefix`	字符串	在初始化客户端时设置 X-Opaque-Id 的前缀。如果您使用 X-Opaque-Id，则会在每次请求之前将其添加到您设置的 ID 前面。
`opentelemetry_tracer_provider`	`OpenTelemetry::Trace::TracerProvider`	要使用的显式 TracerProvider，而不是 OpenTelemetry 的全局 TracerProvider。这可以实现更好的依赖注入并简化测试。
`randomize_hosts`	布尔值	是否在初始化和重新加载时随机排列连接。默认为 `false`。
`reload_connections`	布尔值，数字	是否在 X 个请求后重新加载连接。默认为 `false`。
`reload_on_failure`	布尔值	是否在失败后重新加载连接。默认为 `false`。
`request_timeout`	整数	要传递给选项中传输的请求超时时间。
`resurrect_after`	整数	指定在多少秒后再次尝试连接死连接。
`retry_on_failure`	布尔值，数字	是否在引发异常之前在请求失败时重试 X 次。默认为 `false`。
`retry_on_status`	数组，数字	指定需要返回哪些状态代码才能重试。
`selector`	常量	使用 {Elastic::Transport::Transport::Connections::Selector::Base} 实现的选择器策略的实例。
`send_get_body_as`	字符串	指定用于带有正文的 GET 请求的 HTTP 方法。默认为 `GET`。
`serializer_class`	常量	指定要使用的序列化器类。它由传输初始化并传递传输实例。
`sniffer_timeout`	整数	指定重新加载连接的超时时间（以秒为单位）。默认为 `1`。
`trace`	布尔值	是否使用默认跟踪器。默认情况下禁用。
`tracer`	对象	指定与 Logger 兼容的对象的实例。
`transport`	对象	指定传输实例。
`transport_class`	常量	指定要使用的传输类。它由客户端初始化并传递主机和所有参数。
`transport_options`	哈希	指定要传递给 `Faraday::Connection` 构造函数的选项。

« 配置高级配置 »