生成支持包
通过支持包,可以生成包含相关数据(日志、配置和指标数据)的压缩 TAR 文件,用于故障排除或分析。如果需要,您可以将这些捆绑文件发送给 Apstra 支持团队,以帮助诊断收集器的问题。
要使用支持包命令行工具,请运行带有--support-bundle
或-s
标志的命令,flowcoll
如以下示例所示:
基本示例
sudo /usr/share/juniper/bin/flowcoll -s
高级示例
sudo /usr/share/juniper/bin/flowcoll -s -sc /my/config/dir -sl /my/log/dir -st 3 -si 3000
命令成功运行后,该工具会在名为类似 的目录/home
ef_support_bundle-20230831T164759.tar.gz
中生成一个压缩的 TAR 文件。
命令行选项
如果未指定选项,将使用其指定的默认值,如下表所示:
选择 |
速记 |
默认值 |
描述 |
---|---|---|---|
support-bundle |
-s |
false |
启用支持捆绑模式。 |
support-bundle-config-dir |
-sc |
/etc/flowcoll |
收集器配置目录的路径。 |
--support-bundle-logs-dir |
-sl |
/var/log/flowcoll |
收集器日志目录的路径。 |
--support-bundle-metrics-interval |
-si |
1000 |
收集指标的时间间隔(以毫秒为单位)。 |
--support-bundle-metrics-times |
-st |
1 |
收集指标的次数。 |
--support-bundle-output |
-so |
<Working directory> |
输出文件写入到的路径。 |
调整收集间隔 (-si
) 和时间 (st
),可以更轻松地跟踪和发现指标随时间变化的趋势。
按端点生成支持包
您可以使用以下方法生成支持包:
-
HTTP 方法:
POST
-
URL:
/support-bundle
请求正文
request boy 中的所有字段都是可选的。如果未指定任何内容,则使用默认值。
-
logDirPath (字符串):日志文件的目录路径。默认路径为:
/var/log/juniper/flowcoll
-
configDirPath (字符串):配置文件的目录路径。默认路径为:
/etc/juniper
查询参数
-
间隔 (整数):获取指标的时间间隔(以毫秒为单位)。默认间隔为:
1000
ms。 -
Times (整数):获取指标端点的次数。默认值为
1
。
身份验证: 仅 当收集器是专门为其配置的时,此终结点才支持基本身份验证。有关配置详细信息,请参阅 “通用选项 ”部分下的 API 选项。
按端点划分的支持包示例
基本示例
使用默认设置,以下示例显示一个没有任何查询参数或请求正文的基本示例。
curl -X POST \ -H "Content-Type: application/json" \ -O -J \ http://localhost:8080/support-bundle
高级示例
以下示例显示了一个高级 curl
请求,其中包括请求正文和查询参数。
curl -X POST \ -H "Content-Type: application/json" \ -d '{ "logDirPath": "/path/to/log/dir", "configDirPath": "/path/to/log/dir" }' \ -O -J \ http://localhost:8080/support-bundle?interval=2000×=2
反应
表 2 显示了按端点生成支持包时可能会看到的代码和响应。
代码 | 原因 | 说明 |
---|---|---|
200 |
还行 |
成功的响应会返回支持捆绑包文件以供下载。该文件具有以下命名约定: ef_support_bundle-YYYYMMDDTHHmmss.tar.gz YYYYMMDDTHHmmss ,是一个时间戳,用于指示创建捆绑包的时间。 |
400 |
错误的请求 |
表示查询参数无效。 |
500 |
内部服务器错误 |
处理请求时发生内部服务器错误。 |