Google BigQuery 输出插件
编辑Google BigQuery 输出插件
编辑- 插件版本:v4.6.0
- 发布日期:2024-09-16
- 变更日志
其他版本请参见 版本化插件文档。
安装
编辑对于默认情况下未捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-output-google_bigquery
轻松安装。更多详情请参见 使用插件。
获取帮助
编辑如有关于插件的问题,请在 Discuss 论坛中发帖提问。如发现错误或有功能请求,请在 Github 中提交问题。如需查看 Elastic 支持的插件列表,请查阅 Elastic 支持矩阵。
描述
编辑概要
编辑此 Logstash 插件使用流式 API 将事件上传到 Google BigQuery,以便数据几乎可以立即查询。
您可以将其配置为定期刷新,在 N 个事件后刷新或在摄取一定数量的数据后刷新。
环境配置
编辑您必须在 Google Cloud 帐户上启用 BigQuery 并创建一个数据集来保存此插件生成的表。
您还必须授予此插件使用的服务帐户对数据集的访问权限。
您可以使用 Logstash 条件语句 和多个配置块来上传具有不同结构的事件。
用法
编辑这是一个 Logstash 配置示例
output { google_bigquery { project_id => "folkloric-guru-278" (required) dataset => "logs" (required) csv_schema => "path:STRING,status:INTEGER,score:FLOAT" (required) json_key_file => "/path/to/key.json" (optional) error_directory => "/tmp/bigquery-errors" (required) date_pattern => "%Y-%m-%dT%H:00" (optional) flush_interval_secs => 30 (optional) } }
指定 csv_schema 或 json_schema。 |
|
如果未使用密钥,则插件会尝试查找 应用程序默认凭据 |
注意事项
编辑- 使用流式 API 将数据插入 BigQuery 需要支付少量费用。
- 此插件在内存中缓冲事件,因此请确保刷新配置适合您的用例,并考虑使用 Logstash 持久队列。
- 当满足
batch_size
、batch_size_bytes
或flush_interval_secs
时(以先满足的为准),事件将被刷新。如果您发现处理延迟或吞吐量低,请尝试调整这些设置。
Google BigQuery 输出配置选项
编辑此插件支持以下配置选项以及稍后描述的 常用选项。
设置 | 输入类型 | 必填 |
---|---|---|
否 |
||
否 |
||
否 |
||
是 |
||
否 |
||
已弃用 |
||
是 |
||
否 |
||
否 |
||
否 |
||
否 |
||
已弃用 |
||
是 |
||
已弃用 |
||
否 |
||
否 |
||
否 |
||
已弃用 |
||
已弃用 |
||
已弃用 |
另请参见 常用选项,了解所有输出插件支持的选项列表。
batch_size
编辑在 4.0.0 中添加。
- 值类型为 数字
- 默认值为
128
一次上传的消息最大数量。此数字必须小于 10,000。批量处理可以在一定程度上提高性能和吞吐量,但代价是每个请求的延迟。每个请求的行数太少,每个请求的开销会使摄取效率低下。每个请求的行数太多,吞吐量可能会下降。BigQuery 建议每个请求使用大约 500 行,但是使用具有代表性的数据(模式和数据大小)进行实验将帮助您确定理想的批量大小。
csv_schema
编辑- 值类型为 字符串
- 默认值为
nil
日志数据的模式。它必须遵循格式 name1:type1(,name2:type2)*
。例如,path:STRING,status:INTEGER,score:FLOAT
。
date_pattern
编辑- 值类型为 字符串
- 默认值为
"%Y-%m-%dT%H:00"
BigQuery 表的时间模式,默认为每小时的表。必须使用 Time.strftime 模式:www.ruby-doc.org/core-2.0/Time.html#method-i-strftime
error_directory
编辑在 4.0.0 中添加。
- 这是一个必填设置。
- 值类型为 字符串
- 默认值为
"/tmp/bigquery"
。
存储由于错误而无法上传的事件的位置。默认情况下,如果插入中的任何消息无效,则所有消息都将失败。您可以使用 skip_invalid_rows
来允许部分插入。
考虑使用额外的 Logstash 输入将这些内容传输到警报平台,以便您可以手动修复事件。
或者使用 GCS FUSE 透明地上传到 GCS 存储桶。
文件名遵循模式 [表名]-[UNIX 时间戳].log
ignore_unknown_values
编辑- 值类型为 布尔值
- 默认值为
false
指示 BigQuery 是否应忽略表模式中未表示的值。如果为 true,则会丢弃额外值。如果为 false,BigQuery 将拒绝包含额外字段的记录,作业将失败。默认值为 false。
您可能希望添加一个类似于以下内容的 Logstash 过滤器来删除它添加的常用字段
mutate { remove_field => ["@version","@timestamp","path","host","type", "message"] }
json_key_file
编辑在 4.0.0 中添加。
替换 key_password
和 service_account
。
- 值类型为 字符串
- 默认值为
nil
如果 Logstash 在 Google Compute Engine 中运行,则插件可以使用 GCE 的应用程序默认凭据。在 GCE 之外,您需要指定服务帐户 JSON 密钥文件。
json_schema
编辑- 值类型为 哈希表
- 默认值为
nil
作为哈希表的日志数据的模式。这些可以包括嵌套记录、描述和模式。
示例
json_schema => { fields => [{ name => "endpoint" type => "STRING" description => "Request route" }, { name => "status" type => "INTEGER" mode => "NULLABLE" }, { name => "params" type => "RECORD" mode => "REPEATED" fields => [{ name => "key" type => "STRING" }, { name => "value" type => "STRING" }] }] }
skip_invalid_rows
编辑在 4.1.0 中添加。
- 值类型为 布尔值
- 默认值为
false
即使存在无效行,也要插入请求的所有有效行。默认值为 false,如果存在任何无效行,则会导致整个请求失败。
常用选项
编辑所有输出插件都支持这些配置选项