Google Cloud Storage 输入插件
编辑Google Cloud Storage 输入插件
编辑- 插件版本:v0.15.0
- 发布日期:2023-08-22
- 更新日志
有关其他版本,请参阅版本化插件文档。
安装
编辑对于默认未捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-input-google_cloud_storage
轻松安装。有关更多详细信息,请参阅使用插件。
获取帮助
编辑有关该插件的问题,请在Discuss论坛中开一个主题。对于错误或功能请求,请在Github中开一个问题。有关 Elastic 支持的插件列表,请查阅Elastic 支持矩阵。
描述
编辑从 Google Cloud Storage 存储桶中的文件中提取事件。
用例示例
- 将Stackdriver 日志从 Cloud Storage 存储桶读取到 Elastic 中。
- 将来自冷存储的 gzip 压缩日志读取到 Elastic 中。
- 从 Elastic 转储还原数据。
- 从 Cloud Storage 提取数据,使用 Logstash 转换,并将其加载到 BigQuery 中。
注意:虽然此项目部分由 Google 维护,但这不是 Google 的官方产品。
安装说明
尝试安装此插件可能会导致错误
Bundler::VersionConflict: Bundler could not find compatible versions for gem "mimemagic": In Gemfile: logstash-input-google_cloud_storage (= 0.11.0) was resolved to 0.11.0, which depends on mimemagic (>= 0.3.7) Could not find gem 'mimemagic (>= 0.3.7)', which is required by gem 'logstash-input-google_cloud_storage (= 0.11.0)', in any of the sources or in gems cached in vendor/cache
如果发生此错误,您可以通过将“mimemagic”依赖项直接手动安装到 Logstash 的内部 Ruby Gems 缓存中来解决此问题,该缓存位于 vendor/bundle/jruby/<ruby_version>/gems/
。可以使用 Logstash 安装 bin/
文件夹内的捆绑 Ruby gem 实例来完成此操作。
要手动将“mimemagic”gem 安装到 Logstash 中,请使用
bin/ruby -S gem install mimemagic -v '>= 0.3.7'
mimemagic gem 还要求存在 shared-mime-info
包,可以使用 apt-get install shared-mime-info
在 Debian/Ubuntu 上或 yum install shared-mime-info
在 Red Hat/RockyOS 发行版上安装它。
然后像往常一样安装插件,使用
bin/logstash-plugin install logstash-input-google_cloud_storage
元数据属性
编辑该插件公开了有关正在读取的对象的几个元数据属性。您可以在管道的后面访问这些属性,以增强数据或执行条件逻辑。
键 | 类型 | 描述 |
---|---|---|
|
|
从中读取文件的存储桶的名称。 |
|
|
对象的名称。 |
|
|
对象上的元数据映射。 |
|
|
数据的 MD5 哈希值。使用 base64 编码。 |
|
|
CRC32c 校验和,如 RFC 4960 中所述。使用大端字节顺序以 base64 编码。 |
|
|
对象的内容生成。用于对象版本控制 |
|
|
事件在文件中的位置。从 1 开始索引。 |
|
|
描述此行的确定性唯一 ID。这允许您将幂等插入到 Elasticsearch 中。 |
有关对象元数据的更多信息,请参阅官方文档。
示例配置
编辑基本
编辑从 my-logs-bucket
每分钟读取 JSON 日志的基本配置。例如,Stackdriver 日志。
input { google_cloud_storage { interval => 60 bucket_id => "my-logs-bucket" json_key_file => "/home/user/key.json" file_matches => ".*json" codec => "json_lines" } } output { stdout { codec => rubydebug } }
将幂等插入到 Elasticsearch 中
编辑如果您的管道可能多次插入同一个文件,则可以使用 line_id
元数据键作为确定性 id。
ID 的格式为:gs://<bucket_id>/<object_id>:<line_num>@<generation>
。line_num
表示从文件反序列化的第 n 个事件,从 1 开始。generation
是 Cloud Storage 为对象生成的唯一 ID。当一个对象被覆盖时,它会获得一个新的生成。
input { google_cloud_storage { bucket_id => "batch-jobs-output" } } output { elasticsearch { document_id => "%{[@metadata][gcs][line_id]}" } }
从 Cloud Storage 到 BigQuery
编辑从 Cloud Storage 提取数据,使用 Logstash 转换,并将其加载到 BigQuery 中。
input { google_cloud_storage { interval => 60 bucket_id => "batch-jobs-output" file_matches => "purchases.*.csv" json_key_file => "/home/user/key.json" codec => "plain" } } filter { csv { columns => ["transaction", "sku", "price"] convert => { "transaction" => "integer" "price" => "float" } } } output { google_bigquery { project_id => "my-project" dataset => "logs" csv_schema => "transaction:INTEGER,sku:INTEGER,price:FLOAT" json_key_file => "/path/to/key.json" error_directory => "/tmp/bigquery-errors" ignore_unknown_values => true } }
Google Cloud Storage 输入配置选项
编辑此插件支持以下配置选项以及稍后描述的通用选项。
设置 | 输入类型 | 必需 |
---|---|---|
是 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
另请参阅通用选项,获取所有输入插件支持的选项列表。
json_key_file
编辑- 值类型为路径
- 此设置没有默认值。
用于将用户验证到存储桶的密钥的路径。此服务用户应该具有 storage.objects.update
权限,以便可以在对象上创建元数据,从而防止它被多次扫描。
如果未提供密钥,该插件将尝试使用默认应用程序凭据,如果它们不存在,则回退到未经身份验证的模式。
metadata_key
编辑- 值类型为字符串
- 默认值为:
x-goog-meta-ls-gcs-input
此键将在对象被插件处理后设置。这样,您可以停止插件,并且不会再次上传文件,或者通过手动设置字段来防止它们被上传。
密钥是一个标志,如果文件在 Logstash 退出之前被部分处理,则会重新发送一些事件。