From b3891b39d024ca7b3ed84a1396d05ff08f10d72e Mon Sep 17 00:00:00 2001 From: wineandchord Date: Wed, 27 Sep 2023 17:45:32 +0800 Subject: [PATCH] docs: update readme and changelog --- filterextensions/CHANGELOG.md | 9 --------- filterextensions/README.md | 4 ---- hystrix/CHANGELOG.md | 9 --------- hystrix/README.md | 1 - jwt/CHANGELOG.md | 12 ------------ jwt/README.md | 2 -- masking/README.md | 2 -- mock/CHANGELOG.md | 7 ------- mock/README.md | 1 - referer/CHANGELOG.md | 7 ------- referer/README.md | 6 +----- transinfo-blocker/CHANGELOG.md | 7 ------- tvar/CHANGELOG.md | 7 ------- tvar/README.md | 12 +----------- tvar/filter.go | 4 ---- validation/README.md | 5 ----- validation/README_ZH.md | 2 -- 17 files changed, 2 insertions(+), 95 deletions(-) diff --git a/filterextensions/CHANGELOG.md b/filterextensions/CHANGELOG.md index 8b2cfcf..e69de29 100644 --- a/filterextensions/CHANGELOG.md +++ b/filterextensions/CHANGELOG.md @@ -1,9 +0,0 @@ -# Changelog - -## [0.1.0](https://git.woa.com/trpc-go/trpc-filter/tree/filterextensions/v0.1.0) (2022-07-25) - -### Features - -- 扩展了 `trpc_go.yaml` 的解析方式，以「插件」+「拦截器」的方式实现了 method 粒度的拦截器 -- 新增 CHANGELOG.md 文件 -- 升级 trpc-go 到 v0.9.4，适配新版本 filter 签名 \ No newline at end of file diff --git a/filterextensions/README.md b/filterextensions/README.md index 75f8183..3ed2754 100644 --- a/filterextensions/README.md +++ b/filterextensions/README.md @@ -1,7 +1,3 @@ -[![BK Pipelines Status](https://api.bkdevops.qq.com/process/api/external/pipelines/projects/pcgtrpcproject/p-7c6d21257da948469e47d9ed3b4845ff/badge?X-DEVOPS-PROJECT-ID=pcgtrpcproject)](http://devops.oa.com/process/api-html/user/builds/projects/pcgtrpcproject/pipelines/p-7c6d21257da948469e47d9ed3b4845ff/latestFinished?X-DEVOPS-PROJECT-ID=pcgtrpcproject) -[![Coverage](https://tcoverage.woa.com/api/getCoverage/getTotalImg/?pipeline_id=p-7c6d21257da948469e47d9ed3b4845ff)](http://macaron.oa.com/api/coverage/getTotalLink/?pipeline_id=p-7c6d21257da948469e47d9ed3b4845ff) -[![GoDoc](https://img.shields.io/badge/API%20Docs-GoDoc-green)](http://godoc.oa.com/trpc.group/trpc-go/trpc-filter/filter_extensions) - ## tRPC-Go 拦截器扩展 tRPC-Go 支持在 `trpc_go.yaml` 中配置拦截器，但是拦截器的精度只到 service 层，无法作更细粒度的配置，如为 method 配置拦截器。 diff --git a/hystrix/CHANGELOG.md b/hystrix/CHANGELOG.md index fad56ea..e69de29 100644 --- a/hystrix/CHANGELOG.md +++ b/hystrix/CHANGELOG.md @@ -1,9 +0,0 @@ -# Changelog - -## [0.1.0](https://git.woa.com/trpc-go/trpc-filter/tree/hystrix/v0.1.0) (2022-07-25) - -### Features - -- Based on Netflix open source hystrix components. -- Add CHANGELOG.md file. -- Upgrade trpc-go to v0.9.4 to adapt to the new version filter signature. \ No newline at end of file diff --git a/hystrix/README.md b/hystrix/README.md index 616da59..b28496b 100644 --- a/hystrix/README.md +++ b/hystrix/README.md @@ -1,5 +1,4 @@ ## tRPC-Go [hystrix] fuse protection plugin -[![BK Pipelines Status](https://api.bkdevops.qq.com/process/api/external/pipelines/projects/pcgtrpcproject/p-942764d8bdb64eb1ad280822bfc78e97/badge?X-DEVOPS-PROJECT-ID=pcgtrpcproject)](http://devops.oa.com:/ms/process/api-html/user/builds/projects/pcgtrpcproject/pipelines/p-942764d8bdb64eb1ad280822bfc78e97/latestFinished?X-DEVOPS-PROJECT-ID=pcgtrpcproject)[![Coverage](https://tcoverage.woa.com/api/getCoverage/getTotalImg/?pipeline_id=p-942764d8bdb64eb1ad280822bfc78e97)](http://macaron.oa.com/api/coverage/getTotalLink/?pipeline_id=p-942764d8bdb64eb1ad280822bfc78e97)[![GoDoc](https://img.shields.io/badge/API%20Docs-GoDoc-green)](http://godoc.oa.com/trpc.group/trpc-go/trpc-filter/hystrix) ### hystrix plugin introduction The plugin is based on Netflix's open source hystrix component, see https://github.com/afex/hystrix-go diff --git a/jwt/CHANGELOG.md b/jwt/CHANGELOG.md index 62ff270..e69de29 100644 --- a/jwt/CHANGELOG.md +++ b/jwt/CHANGELOG.md @@ -1,12 +0,0 @@ -# Change Log - -## [0.2.0](https://git.woa.com/trpc-go/trpc-filter/tree/jwt/v0.2.0) (2022-06-27) - -### Features -- server filter 签名升级，适配 trpc-go 0.9.0 版本 - -## [0.1.0](https://git.woa.com/trpc-go/trpc-filter/tree/jwt/v0.1.0) (2021-09-02) - -### Features - -- jwt 用户身份验证拦截器 \ No newline at end of file diff --git a/jwt/README.md b/jwt/README.md index c3bc898..9f59ee1 100644 --- a/jwt/README.md +++ b/jwt/README.md @@ -1,7 +1,5 @@ # tRPC-Go [jwt] 用户身份验证拦截器 -[![BK Pipelines Status](https://api.bkdevops.qq.com/process/api/external/pipelines/projects/pcgtrpcproject/p-5351dee5801b4df98c03692007da4c5f/badge?X-DEVOPS-PROJECT-ID=pcgtrpcproject)](http://devops.oa.com/process/api-html/user/builds/projects/pcgtrpcproject/pipelines/p-5351dee5801b4df98c03692007da4c5f/latestFinished?X-DEVOPS-PROJECT-ID=pcgtrpcproject) [![Coverage](https://badge.tcoverage.woa.com/api/getCoverage/getTotalImg/?pipeline_id=p-5351dee5801b4df98c03692007da4c5f)](http://macaron.oa.com/api/coverage/getTotalLink/?pipeline_id=p-5351dee5801b4df98c03692007da4c5f) [![GoDoc](https://img.shields.io/badge/API%20Docs-GoDoc-green)](http://godoc.oa.com/trpc.group/trpc-go/trpc-filter/jwt) - ## jwt 插件使用说明 ### I. 必要条件 diff --git a/masking/README.md b/masking/README.md index 5cc3c0d..ccc9f94 100644 --- a/masking/README.md +++ b/masking/README.md @@ -37,8 +37,6 @@ server: ## 编写proto协议文件 -更加详细指引可参考：https://git.woa.com/devsec/protoc-gen-secv - ``` syntax = "proto3"; diff --git a/mock/CHANGELOG.md b/mock/CHANGELOG.md index ab76470..e69de29 100644 --- a/mock/CHANGELOG.md +++ b/mock/CHANGELOG.md @@ -1,7 +0,0 @@ -# Change Log - -## [0.1.0](https://git.woa.com/trpc-go/trpc-filter/tree/mock/v0.1.0) (2022-07-19) - -### Features - -- Upgrade trpc-go to v0.9.4, adapt to new filter signature version. diff --git a/mock/README.md b/mock/README.md index 7128410..ead4985 100644 --- a/mock/README.md +++ b/mock/README.md @@ -1,6 +1,5 @@ # mock -[![BK Pipelines Status](https://api.bkdevops.qq.com/process/api/external/pipelines/projects/pcgtrpcproject/p-39d43cbb08d847a799ef26493deea97f/badge?X-DEVOPS-PROJECT-ID=pcgtrpcproject)](http://devops.oa.com:/ms/process/api-html/user/builds/projects/pcgtrpcproject/pipelines/p-39d43cbb08d847a799ef26493deea97f/latestFinished?X-DEVOPS-PROJECT-ID=pcgtrpcproject)[![Coverage](https://tcoverage.woa.com/api/getCoverage/getTotalImg/?pipeline_id=p-39d43cbb08d847a799ef26493deea97f)](http://macaron.oa.com/api/coverage/getTotalLink/?pipeline_id=p-39d43cbb08d847a799ef26493deea97f)[![GoDoc](https://img.shields.io/badge/API%20Docs-GoDoc-green)](http://godoc.oa.com/trpc.group/trpc-go/trpc-filter/mock) It implement back-end dependency interface mock calls via interceptors. ## Instructions for use diff --git a/referer/CHANGELOG.md b/referer/CHANGELOG.md index b849db6..e69de29 100644 --- a/referer/CHANGELOG.md +++ b/referer/CHANGELOG.md @@ -1,7 +0,0 @@ -# Change Log - -## [0.1.0](https://git.woa.com/trpc-go/trpc-filter/tree/referer/v0.1.0) (2022-07-21) - -### Features - -- 升级 trpc-go 到 v0.9.4，适配新版本 filter 签名 diff --git a/referer/README.md b/referer/README.md index 196da01..db015dd 100644 --- a/referer/README.md +++ b/referer/README.md @@ -1,7 +1,5 @@ # referer -[![BK Pipelines Status](https://api.bkdevops.qq.com/process/api/external/pipelines/projects/pcgtrpcproject/p-a437407d143f42f6b408ec8f23874fd5/badge?X-DEVOPS-PROJECT-ID=pcgtrpcproject)](http://devops.oa.com:/ms/process/api-html/user/builds/projects/pcgtrpcproject/pipelines/p-a437407d143f42f6b408ec8f23874fd5/latestFinished?X-DEVOPS-PROJECT-ID=pcgtrpcproject) [![Coverage](https://tcoverage.woa.com/api/getCoverage/getTotalImg/?pipeline_id=p-a437407d143f42f6b408ec8f23874fd5)](http://macaron.oa.com/api/coverage/getTotalLink/?pipeline_id=p-a437407d143f42f6b408ec8f23874fd5) [![GoDoc](https://img.shields.io/badge/API%20Docs-GoDoc-green)](http://godoc.oa.com/trpc.group/trpc-go/trpc-filter/referer) - http referer 安全验证 ## 使用说明 @@ -10,7 +8,7 @@ http referer 安全验证 ```golang import ( - _ "trpc.group/trpc-go/trpc-filter/referer" + _ "trpc.group/trpc-go/trpc-filter/referer" ) ``` @@ -27,10 +25,8 @@ plugins: - qq.com path1: - qq.com - - oa.com path2: - NULL - ``` ## 配置说明 diff --git a/transinfo-blocker/CHANGELOG.md b/transinfo-blocker/CHANGELOG.md index ae1cb0b..e69de29 100644 --- a/transinfo-blocker/CHANGELOG.md +++ b/transinfo-blocker/CHANGELOG.md @@ -1,7 +0,0 @@ -# Change Log - -## [0.1.0](https://git.woa.com/trpc-go/trpc-filter/tree/transinfo-blocker/v0.1.0) (2022-07-21) - -### Features - -- 升级 trpc-go 到 v0.9.4，适配新版本 filter 签名 diff --git a/tvar/CHANGELOG.md b/tvar/CHANGELOG.md index 39d70a1..e69de29 100644 --- a/tvar/CHANGELOG.md +++ b/tvar/CHANGELOG.md @@ -1,7 +0,0 @@ -# Change Log - -## [0.1.0](https://git.woa.com/trpc-go/trpc-filter/tree/tvar/v0.1.0) (2022-07-21) - -### Features - -- 升级 trpc-go 到 v0.9.4，适配新版本 filter 签名 diff --git a/tvar/README.md b/tvar/README.md index ac2c576..fbce454 100644 --- a/tvar/README.md +++ b/tvar/README.md @@ -2,8 +2,7 @@ ## 插件简介 -实现serverside、clientside RPC等监控项的统计上报，具体要支持的监控项，详见： -https://git.woa.com/trpc/trpc-proposal/blob/master/A6-tvar.md。 +实现serverside、clientside RPC等监控项的统计上报 注册admin接口：/cmds/stats/rpc 接口可查询监控项，及支持情况 @@ -40,13 +39,6 @@ https://git.woa.com/trpc/trpc-proposal/blob/master/A6-tvar.md。 | rpc_client_xxx_latency_999 | 必须 | client p999延时 | ✔ | | rpc_client_xxx_latency_avg/max/min | 必须 | client延时的avg/max/min | ❌ | -后续PR中可以继续完善的： - -- version 提案中未说明指的是什么版本，以及从哪里获取 -- req/rsp包尺寸 外部依赖：https://git.woa.com/trpc-go/trpc-go/issues/716 -- service协议错误 在filter中也无法做统计，可用框架metrics打点代替 -- latency的avg\max\min 在已经有百分位数支持的前提下，这些价值不大，otel metrics/histogram sdk不支持记录最小、最大 - ## 使用方式 1. 代码中导入包：`import _ "trpc.group/trpc-go/trpc-filter/tvar" @@ -63,5 +55,3 @@ https://git.woa.com/trpc/trpc-proposal/blob/master/A6-tvar.md。 ``` 3. 查询：`curl http://ip:adminport/cmds/stats/rpc` - -详见iwiki使用说明：https://iwiki.woa.com/pages/viewpage.action?pageId=1226665829 \ No newline at end of file diff --git a/tvar/filter.go b/tvar/filter.go index e41fe6c..5c5eea5 100644 --- a/tvar/filter.go +++ b/tvar/filter.go @@ -34,10 +34,6 @@ func RPCServerFilter( serviceReqActiveNum.Add(ctx, 1, attr) serviceQWin.Record() - // TODO req包尺寸依赖：https://git.woa.com/trpc-go/trpc-go/issues/716 - // rsp包尺寸filter里不方便统计 - // serviceReqSize.Record() - begin := time.Now() defer func() { serviceReqActiveNum.Add(ctx, -1, attr) diff --git a/validation/README.md b/validation/README.md index 378ca62..a3be960 100644 --- a/validation/README.md +++ b/validation/README.md @@ -59,11 +59,6 @@ plugins: ## Writing Proto Protocol Files -<<<<<<< HEAD -======= -For more detailed instructions, please refer to: https://git.woa.com/devsec/protoc-gen-secv - ->>>>>>> 6cf84d8 (Translate readme for debuglog, recovery and validation. (merge request !334)) ```protobuf syntax = "proto3"; diff --git a/validation/README_ZH.md b/validation/README_ZH.md index d949f36..ff72492 100644 --- a/validation/README_ZH.md +++ b/validation/README_ZH.md @@ -59,8 +59,6 @@ plugins: ## 编写proto协议文件 -更加详细的指引请参考： - ```protobuf syntax = "proto3";