A-Tune-Collector/README-add-data-collecting-output-description.patch

48 lines
2.6 KiB
Diff
Raw Normal View History

2023-08-01 09:43:39 +08:00
From c8d0e4c3030808fe0a575e595d8bd9a51d30124a Mon Sep 17 00:00:00 2001
From: HuBin95 <hubin73@huawei.com>
Date: Mon, 7 Mar 2022 02:10:24 +0000
Subject: [PATCH 02/11] README: add data collecting output description
---
README.en.md | 4 +++-
README.md | 4 +++-
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/README.en.md b/README.en.md
index 2f11270..8a54fa4 100644
--- a/README.en.md
+++ b/README.en.md
@@ -52,9 +52,11 @@ Table 1 **collect_data.json** file
| sample_num | Sample number to be collected. | Integer | > 0 |
| interval | Interval for collecting data, in seconds. | Integer | > 0 |
| output_dir | Path for storing collected data. | Character string | - |
-| workload_type | Application load type of the collection environment. The default value is **default**. | Character string | - |
+| workload_type | Application load type of the collection environment, used as output file name. The default value is **default**. | Character string | - |
| collection_items | Table 2 lists the system parameters to be collected. | List | - |
+When data collecting is finished, the data will be saved as: `${output_dir}/${workload_type}-${finish_timestamp}.csv`
+
Table 2 Description of the **collection_items** configuration
| Parameter | Description | Type | Value Range |
diff --git a/README.md b/README.md
index 36d5954..c121c8d 100644
--- a/README.md
+++ b/README.md
@@ -53,9 +53,11 @@ python3 collect_data.py [OPTIONS]
| sample_num | 待采集的次数 | 整型 | >0 |
| interval | 待采集的间隔时间,单位为秒 | 整型 | >0 |
| output_dir | 采集完后数据存储的文件路径 | 字符串 | - |
-| workload_type | 采集环境的应用负载类型默认为default | 字符串 | - |
+| workload_type | 采集环境的应用负载类型用作输出文件名默认为default | 字符串 | - |
| collection_items | 需要采集的系统参数项参见表2 | 列表 | - |
+最终采集完后,数据将保存为: `${output_dir}/${workload_type}-${finish_timestamp}.csv`
+
表2 collection_items项配置说明
| **配置名称** | **配置说明** | **参数类型** | **取值范围** |
--
2.27.0