文档中心

日志服务

请输入

CLI 参考

日志服务 CLI 概述

本章节介绍火山引擎日志服务提供的 CLI 工具。

功能介绍

火山引擎日志服务 TLS 提供官方 CLI 工具 volclog，满足自动化开发等各种场景。覆盖日志项目、日志主题、索引、检索分析、告警、消费组、数据加工等主要业务域，提供快捷命令、底层 API 调用和部分可选技能。

volclog默认为自动化版，主路径使用契约优先的 tool / workflow / raw；同时保留volclog-human ，面向人工交互的 Shortcut。

功能	说明
双发行版	提供自动化和人工交互版本，两者共享相同的 tool / workflow / raw 运行时语义。 volclog：自动化版，Agent/CI 优先。 volclog-human：人工交互 Shortcut 版。
业务范围广	覆盖日志项目、日志主题、索引、检索分析、告警、机器组、采集规则、ETL、消费组等领域。
完整的安全保障	提供 --dry-run，结构化 envelope、trace 工件与 file delivery，让预检查、验证和恢复更直接。
灵活的凭证接入	提供本地 profile、显式 region/endpoint、环境变量，以及一次性的 --secrets-file 注入。
分层使用	默认从 tool / workflow / raw 开始。仅当明确需要 volclog-human 的人工交互层时，才进入 Shortcut。

核心能力

日志服务 CLI 工具支持的核心能力，详情如下：

功能	说明
日志项目（Project）	创建、查询、修改和删除日志项目。
日志主题（Topic）	创建、查询、修改和删除日志主题，管理日志生命周期。
索引与检索（Index & Log）	创建与管理索引，提供日志检索能力、导出 SQL 分析、下载原始日志。
指标主题（Metric Topic）	创建指标主题，支持基于 PromQL 的监控指标查询。
告警与通知（Alarm）	配置告警策略、通知渠道，保障业务异常秒级触达。
仪表盘（Dashboard）	创建与管理可视化仪表盘，实时洞察数据变化。
消费与投递（Consumer/Shipper）	管理消费组，配置数据投递至外部存储（如 TOS、Kafka 等）。
数据加工（ETL/Processor）	日志的清洗、富化、分发与格式化处理。
机器组与采集（Host/Collector）	管理日志服务机器组，配置并下发 LogCollector 采集规则。
权限管理	支持多种鉴权方式访问日志服务： AK/SK 长期凭证 STS 临时凭证（临时 AK/SK + Session Token）

使用限制

类别	要求
操作系统与架构	支持 Linux、macOS、Windows。架构为 amd64/x86_64 或 arm64/aarch64。
安装依赖	使用二进制安装不依赖 Node.js；使用 NPM 安装需要 Node.js >= 18，且安装环境可访问 GitHub Release。
凭证与配置	确保与目标日志服务网络互通。获取火山引擎账号的 AccessKey ID、AccessKey Secret。获取目标日志服务的 Region、服务地址（Endpoint）信息。说明推荐通过环境变量动态获取火山引擎密钥等身份认证信息，以免 AccessKey 硬编码引发数据安全风险。可通过 Profile、环境变量或 --secrets-file 等方式。
大结果输出	自动化或沙箱环境建议提前准备可写目录，并对大查询显式使用 --output-mode file --output-dir。

参考文档

参考文档	说明
快速开始	介绍如何选择volclog版本，准备环境、安装工具和验证请求等，快速开始使用 volclog 。
权限认证	介绍 volclog 的鉴权方式，以及如何选择、配置、验证、刷新和清理登录状态。包括静态 AK/SK和通过安全令牌服务 STS 服务申请临时安全令牌，使指定的 IAM 用户在指定时间内访问权限范围内的日志服务资源等。
解析配置	介绍 volclog 如何解析配置。包括文件存放位置、配置档如何选择、configure set 如何更新字段、运行时值如何优先，以及当前目录的项目配置如何工作等。
命令使用方法	介绍 volclog 如何运行命令、如何发现工具和工作流、tool exec、workflow exec 和 raw 的工作方式、上下文和选择器如何交互，以及输出、过滤和追踪的行为。
实战指导	使用默认的 volclog 命令面（tool、workflow、raw），介绍如下端到端场景。如何接入日志服务并验证日志可检索创建日志项目和日志主题，发送一条示例日志，并确认能正常检索该日志。如何导出告警信息以供离线分析获取告警中出现的查询日志，用有界检索验证后，导出检索结果以供离线分析。如何诊断未采集到日志的机器组/采集器流水线判断机器组及其采集器规则是否配置正确，以及是否正常上报机器组状态。
高级配置	介绍 volclog 的高级运维决策、边界情况和模式。包括过滤与投影、大结果交付、分页、不完整结果、追踪与诊断工件、错误恢复、瘦客户端边界、稳定的检索、直方图和分析规则等。
人工终端场景	介绍 volclog 面向人工终端操作的volclog-human的常用 Shortcut 命令。包括何时使用 Shortcut，以及在日志服务中的常见使用场景。

最近更新时间：2026.08.12 09:58:49

这个页面对您有帮助吗？

有用

无用