调用CLI命令创建Logtail采集配置

更新时间:
复制 MD 格式

调用CLI命令创建Logtail采集管道配置。配置定义了采集什么(输入)、如何解析(处理)、发送到哪里(输出)。

注意事项

在使用CLI命令之前,您需要注意以下事项:

  • 已开通日志服务。

  • 已安装日志服务CLI安装与配置

  • 已创建日志服务ProjectLogstore。

命令格式

aliyun sls create-logtail-pipeline-config --project=<value> --config-name=<value> --inputs=<value> [--processors=<value>] --flushers=<value> [--log-sample=<value>]

命令参数

该命令的必选和特有参数描述如下。

参数名称

数值类型

是否必选

示例值

描述

--project

String

aliyun-test-project

Project名称。

--config-name

String

json-log-config

配置名称。

--inputs

String

见示例

输入插件配置,JSON格式。

--processors

String

见示例

处理插件配置,JSON格式,可多次使用。

--flushers

String

见示例

输出插件配置,JSON格式。

--log-sample

String

见示例

日志样例。

关于该命令的全局参数,请参见全局参数。

命令示例

创建JSON日志采集配置

  • 命令示例

aliyun sls create-logtail-pipeline-config --project="aliyun-test-project" \
  --config-name json-log-config \
  --inputs '{"Type":"input_file","FilePaths":["/app/**/output.json"],"EnableContainerDiscovery":false,"MaxDirSearchDepth":1,"FileEncoding":"utf8"}' \
  --processors '{"Type":"processor_parse_json_native","SourceKey":"content"}' \
  --flushers '{"Type":"flusher_sls","Logstore":"aliyun-test-logstore","TelemetryType":"logs","Region":"cn-hangzhou","Endpoint":"cn-hangzhou-intranet.log.aliyuncs.com"}' \
  --log-sample '{"status": 200, "latency": 4152, "method": "GetUserConfig"}'
  • 返回示例

命令执行成功后,无响应消息。

创建分隔符日志采集配置

  • 命令示例

aliyun sls create-logtail-pipeline-config --project="aliyun-test-project" \
  --config-name delimiter-log-config \
  --inputs '{"Type":"input_file","FilePaths":["/app/**/access.log"],"EnableContainerDiscovery":false,"MaxDirSearchDepth":1,"FileEncoding":"utf8"}' \
  --processors '{"Type":"processor_parse_delimiter_native","SourceKey":"content","Separator":"|","Quote":"\\u0000","KeepingSourceWhenParseFail":true,"Keys":["remote_addr","time_iso8601","method","uri","protocol","status","sent_bytes","user_agent","latency"]}' \
  --flushers '{"Type":"flusher_sls","Logstore":"aliyun-test-logstore","TelemetryType":"logs","Region":"cn-hangzhou","Endpoint":"cn-hangzhou-intranet.log.aliyuncs.com"}'
  • 返回示例

命令执行成功后,无响应消息。

创建正则日志采集配置(复杂配置写入文件)

  • 命令示例

# 创建配置文件
cat > /tmp/processor_regex.json << 'EOF'
{
  "Type": "processor_parse_regex_native",
  "SourceKey": "content",
  "Regex": "(\\d+-\\d+-\\d+\\s\\S+)\\s\\S+\\s\\[(\\w+)]\\s\\S+\\s(\\w+)\\s\\S+\\s(\\S+)\\s\\S+\\s(.*)",
  "Keys": ["time", "level", "func", "class", "content"]
}
EOF

cat > /tmp/processor_time.json << 'EOF'
{
  "Type": "processor_parse_timestamp_native",
  "SourceKey": "time",
  "SourceFormat": "%Y-%m-%d %H:%M:%S,%f"
}
EOF

# 创建采集配置
aliyun sls create-logtail-pipeline-config --project="aliyun-test-project" \
  --config-name regex-time-config \
  --inputs '{"Type":"input_file","FilePaths":["/app/**/app.log"],"EnableContainerDiscovery":false,"MaxDirSearchDepth":1,"FileEncoding":"utf8"}' \
  --processors "$(cat /tmp/processor_regex.json)" \
  --processors "$(cat /tmp/processor_time.json)" \
  --flushers '{"Type":"flusher_sls","Logstore":"aliyun-test-logstore","TelemetryType":"logs","Region":"cn-hangzhou","Endpoint":"cn-hangzhou-intranet.log.aliyuncs.com"}'
  • 返回示例

命令执行成功后,无响应消息。

相关文档

  • 在调用API接口过程中,若服务端返回结果中包含错误信息,则表示调用API接口失败。您可以参考API错误码对照表查找对应的解决方法。更多信息,请参见PutLogs

  • 阿里云OpenAPI开发者门户提供调试、SDK、示例和配套文档。通过OpenAPI,您无需手动封装请求和签名操作,就可以快速对日志服务API进行调试。更多信息,请参见OpenAPI开发者门户

API参考

创建Logtail流水线配置