@@ -15,27 +15,27 @@ See the License for the specific language governing permissions and
1515limitations under the License.
1616-->
1717
18- # Q Developer 插件
18+ # Q Developer Plugin
1919
20- 本插件用于从AWS S3获取AWS Q Developer的使用数据,并进行处理和分析。
20+ This plugin is used to retrieve AWS Q Developer usage data from AWS S3, and process and analyze it.
2121
22- ## 功能
22+ ## Features
2323
24- - 从AWS S3指定前缀下获取CSV文件
25- - 解析CSV文件中的用户使用数据
26- - 按用户聚合数据,计算各项指标
24+ - Retrieve CSV files from a specified prefix in AWS S3
25+ - Parse user usage data from CSV files
26+ - Aggregate data by user and calculate various metrics
2727
28- ## 配置
28+ ## Configuration
2929
30- 配置项包括:
30+ Configuration items include:
3131
32- 1 . AWS访问密钥ID
33- 2 . AWS秘钥
34- 3 . AWS区域
35- 4 . S3桶名称
36- 5 . 速率限制(每小时 )
32+ 1 . AWS Access Key ID
33+ 2 . AWS Secret Key
34+ 3 . AWS Region
35+ 4 . S3 Bucket Name
36+ 5 . Rate Limit (per hour )
3737
38- 通过下面的curl可以创建connection
38+ You can create a connection using the following curl command:
3939``` bash
4040curl ' http://localhost:8080/plugins/q_dev/connections' \
4141--header ' Content-Type: application/json' \
@@ -48,38 +48,38 @@ curl 'http://localhost:8080/plugins/q_dev/connections' \
4848 "rateLimitPerHour": 20000
4949}'
5050```
51- 请将以下占位符替换为实际值:
52- <YOUR_ACCESS_KEY_ID>:您的 AWS 访问密钥 ID
53- <YOUR_SECRET_ACCESS_KEY>:您的 AWS 访问密钥
54- <YOUR_S3_BUCKET_NAME>:您要使用的 S3 存储桶名称
55- <AWS_REGION>: 您要使用的 S3 所在的区域
51+ Please replace the following placeholders with actual values:
52+ <YOUR_ACCESS_KEY_ID>: Your AWS access key ID
53+ <YOUR_SECRET_ACCESS_KEY>: Your AWS secret access key
54+ <YOUR_S3_BUCKET_NAME>: The S3 bucket name you want to use
55+ <AWS_REGION>: The region where your S3 bucket is located
5656
57- 通过下面的curl可以获取所有的connection
57+ You can get all connections using the following curl command:
5858``` bash
59- curl Get ' http://localhost:8080/plugins/q_dev/connections'
59+ curl Get ' http://localhost:8080/plugins/q_dev/connections'
6060```
6161
62- ## 数据流程
62+ ## Data Flow
6363
64- 插件包含以下任务:
64+ The plugin includes the following tasks:
6565
66- 1 . ` collectQDevS3Files ` : 从S3收集文件元数据信息,不下载文件内容
67- 2 . ` extractQDevS3Data ` : 使用S3文件元数据,下载CSV数据并解析存储到数据库
68- 3 . ` convertQDevUserMetrics ` : 将用户数据转换为聚合指标,计算平均值和总值
66+ 1 . ` collectQDevS3Files ` : Collects file metadata information from S3, without downloading file content
67+ 2 . ` extractQDevS3Data ` : Uses S3 file metadata to download CSV data and parse it into the database
68+ 3 . ` convertQDevUserMetrics ` : Converts user data into aggregated metrics, calculating averages and totals
6969
70- ## 数据表
70+ ## Data Tables
7171
72- - ` _tool_q_dev_connections ` : 存储AWS S3连接信息
73- - ` _tool_q_dev_s3_file_meta ` : 存储S3文件元数据
74- - ` _tool_q_dev_user_data ` : 存储从CSV文件中解析的用户数据
75- - ` _tool_q_dev_user_metrics ` : 存储聚合后的用户指标
72+ - ` _tool_q_dev_connections ` : Stores AWS S3 connection information
73+ - ` _tool_q_dev_s3_file_meta ` : Stores S3 file metadata
74+ - ` _tool_q_dev_user_data ` : Stores user data parsed from CSV files
75+ - ` _tool_q_dev_user_metrics ` : Stores aggregated user metrics
7676
77- ## 数据收集配置
78- 收集数据步骤
79- 1 . 在Config UI页面上选择左侧的 ` Advanced Mode ` ,点击 ` Blueprints ` ,
80- 2 . 新建Blueprint
81- 3 . ![ img.png] ( img.png ) 点击右侧齿轮
82- 4 . 在 ` JSON Configuration ` 粘贴如下JSON配置:
77+ ## Data Collection Configuration
78+ Steps to collect data:
79+ 1 . On the Config UI page, select ` Advanced Mode ` on the left, click ` Blueprints `
80+ 2 . Create a new Blueprint
81+ 3 . ![ img.png] ( img.png ) Click the gear icon on the right
82+ 4 . Paste the following JSON configuration into ` JSON Configuration ` :
8383
8484``` json
8585[
0 commit comments