文档中心

日志服务

投递日志到 Splunk

使用 Add-On 插件投递日志到 Splunk

使用 Add-On 插件投递日志到 Splunk

本文档介绍通过插件将日志服务 Topic 数据投递到 Splunk 的基本方法。

前提条件

推荐使用 IAM 用户进行访问鉴权。使用 IAM 用户前，需确认火山引擎主账号已创建 IAM 用户，且已为其授予消费相关的权限。详细说明请参考可授予的权限。

已获取当前登录账号的密钥 Access Key。详细信息请参考创建密钥。

已创建日志项目和日志主题。详细操作步骤请参考创建资源。

已获取日志服务 Volcengine TLS Add-On 插件包。详情可参考 Volcengine TLS Add-On 下载地址。

确认环境依赖：

系统：仅支持 Linux。

Python：3.9.x 及以后版本。

Splunk：10.0.x 及以后版本。

安装 Splunk Enterprise

准备 Linux 环境，安装 Splunk Enterprise 版本。详情可参考 Splunk 官网。

安装日志服务插件

登录 Splunk Enterprise Web。

说明

在浏览器中访问 http://<host name or ip address>:8000，输入账号密码，登录 Splunk Enterprise Web。

选择 Apps > Manage Apps，进入应用管理页。

单击 Install App From File，进入应用安装页。

在弹窗中，选择并上传提前下载的日志服务 Volcengine TLS Add-On 插件包。

安装成功后即可在应用首页查看到应用 Volcengine Torch Log Service Add-on for Splunk。

配置访问日志服务凭证

单击应用名称，进入应用页面。

单击Configuration，进入 AccessKeys 和日志级别配置页签。

在 AccessKeys ，单击Add，根据界面提示添加火山引擎账户信息。

参数	说明
Name	自定义的标识名。
AccessKey	火山引擎账号的 Access Key ID。
SecretKey	火山引擎账号的 Secret Access Key。
SecurityToken	临时身份凭证，若通过角色扮演的方式获取的访问凭证时需填写。详情可参考 IAM 概述

添加完成后，在列表页可查看相关信息。

创建 Input 任务

单击 Inputs，进入 Input 任务页签。

单击 Create New Input，配置 Input 任务信息。

在 Input 任务弹窗中，配置如下信息。

基础信息：

参数	说明
Name	Input 任务名称，用于 TLS 消费者名称。
Group	TLS 消费组名称。
Project	TLS 项目 ID。
Topics	TLS Topic ID，多个 ID 使用 “,” 分割。
Region	待访问的 TLS 区域。
Endpoint	TLS 服务的接入地址。
AccessKey	火山访问凭证，即上述步骤配置的凭证。
Index	数据写入使用的 Splunk Indexer。
Interval	若任务异常退出时，会以此周期定时重试任务。

（可选）配置Advanced Settings：

参数	说明
ConsumeFrom	消费开始的位置，当且仅当消费组不存在消费记录时生效。 begin（默认值），从最早的位置开始消费。 end：从最新的位置开始消费。秒级 Unix 时间戳：从指定的时间开始消费。
HeartbeatInterval	心跳执行的周期。单位为秒，默认为 20 秒。
CheckpointInterval	消费进度提交周期。单位为秒，默认为 5 秒。
FetchInterval	消息读取的周期。单位为毫秒，默认为 200 毫秒。
Compression	拉取消息的压缩方式。 lz4（默认值） zlib none：不使用任何压缩方式。
OrderedConsume	是否开启顺序消费。不开启（默认值）。开启：则在 shard 分裂时会优先消费完父 shard 的数据后，再去消费分裂产生的子 shard。

查看 Input 任务。

任务创建完成后，在列表页面仅展示配置信息，可以通过单击折叠按钮查看所有配置。

单击 Active 按钮可以暂停/继续任务，任务运行成功后，可在 Search 页签查询数据。

查询 Input 任务同步的数据

单击 Search，进入查询页签。

执行如下命令查询对应日志主题中的数据。

以查询 Input 任务名称为volc_tls_test为例，请替换为实际环境设置的值。

* source="volcengine_tls_input://volc_tls_test"

说明

若无法搜索到数据，可参考如下进行排查：

检查 TLS 的 Topic 中是否已经写入了数据。

检查 TLS 中的日志时间是否过于久远，可以尝试增加查询时间。

最近更新时间：2026.10.19 17:52:10

这个页面对您有帮助吗？

有用

有用

无用

无用