简介

最近更新时间:2025-10-14 01:23:23

我的收藏

概述

日志服务(Cloud Log Service,CLS)是一款支持日志(Log)、指标(Metric)数据的采集、ETL、检索分析、可视化及告警的一体化可观测 SaaS 服务。

  • 本章节介绍的 CLS API 接口均为 API 3.0 接口。
  • 您可以调用 API 对 CLS 进行操作,如创建日志主题、上报日志、检索日志等,请确保在使用这些接口前,已充分了解 CLS 产品收费方式
  • CLS 支持的所有接口信息,请参见 API 概览

术语表

CLS API 接口的常见术语请参见下表:

术语 描述
日志集 日志集(Logset)是对日志主题及指标主题的分类,一个日志集可包含多个日志主题和指标主题。日志集本身不存储任何日志数据,仅方便用户管理主题。一个日志集通常对应公司内的某一个项目/业务,建议将某个项目/业务下的多个应用/服务的日志主题归属到同一个日志集下。
日志主题 日志主题(Log Topic)是日志数据在 CLS 平台进行采集、存储、检索和分析的基本单元,采集到的海量日志以日志主题为单元进行管理,包括采集规则配置、保存时间配置、日志检索分析以及日志下载/消费/投递等。
指标主题 指标主题(Metric Topic)是指标数据在 CLS 平台进行采集、存储、检索和分析的基本单元,采集到的指标数据以指标主题为单元进行管理,包括保存时间配置及检索分析等。
机器组 机器组(MachineGroup)是一组需要采集日志的机器列表,日志服务通过机器组来管理所有需要通过 LogListener 采集日志的机器。
主题分区 主题分区(Partition)是 CLS 的最小读写单元,一个日志主题可以包含多个分区,分区数量决定了单个日志主题的最大数据读写能力。
数据加工 数据加工是对日志数据进行过滤、清洗、脱敏、富化、分发至目标日志主题的过程,可理解为日志 ETL(Extract-Transform-Load)。
定时 SQL 分析 定时 SQL 分析是根据指定的时间窗口,周期性对日志数据进行查询(支持检索和 SQL),并将查询结果保存至目标日志主题的过程。
日志组 日志组(LogGroup)是一个包含多条日志的集合。用于上传日志,为提高数据读写效率,将多条日志打包成一个日志组,并以日志组为单位上传到 CLS。一个日志组里的日志具有相同的基本信息(TIMESTAMPFILENAMESOURCEHOSTNAME 和元数据)。
指标 指标(Metric)是用来衡量系统和应用程序性能及运行情况的度量值,例如 CPU 利用率、内存使用率、访问吞吐量、响应耗时和响应成功率等。指标一般会定时产生,每一个时刻都会有一个值,随着时间变化形成一个序列,这个序列一般被称为时间序列(time series),简称时序。用于系统和应用程序中收集和记录数据。

使用限制

使用限制请参见 文档中心>日志服务>产品简介>规格与限制

API 快速入门

您可以使用 API Explorer 工具在线调用 API。
本文以 创建日志主题-上传日志-检索日志 为例,通过 API Explorer 工具调用 API 接口的步骤如下:

  1. 进入 API Explorer 工具页面。更多 API Explorer 工具使用信息,请参见 使用 API Explorer
  2. 调用 CreateLogset 接口,用于创建日志集,返回新创建日志集的 ID。
  3. 调用 CreateTopic 接口,用于创建日志主题,返回新创建日志主题的 ID。
  4. 调用 CreateIndex 接口,创建索引。
  5. 使用 SDK 上传日志,您可以根据业务需求选择语言版本使用。
  6. 调用 SearchLog 接口,检索分析日志。