Feature: support endpoint name grouping by OpenAPI definitions. by wankai123 · Pull Request #7130 · apache/skywalking

wankai123 · 2021-06-18T02:13:58Z

Support endpoint name grouping by OpenAPI definitions

If this is non-trivial feature, paste the links/URLs to the design doc.
Update the documentation to include this new feature.
Tests(including UT, IT, E2E) are added to verify the new feature.
If it's UI related, attach the screenshots below.
If this pull request closes/resolves/fixes an existing issue, replace the issue number. Closes #.
Update the CHANGES log.

Related to #7113
More information about the feature please see docs/en/setup/backend/endpoint-grouping-rules.md

codecov · 2021-06-18T02:22:27Z

Codecov Report

Merging #7130 (e014c05) into master (002f4c2) will increase coverage by 2.65%.
The diff coverage is 48.74%.

@@             Coverage Diff              @@
##             master    #7130      +/-   ##
============================================
+ Coverage     50.35%   53.01%   +2.65%     
- Complexity     2692     4263    +1571     
============================================
  Files           740     1876    +1136     
  Lines         18265    40707   +22442     
  Branches       1766     4534    +2768     
============================================
+ Hits           9198    21579   +12381     
- Misses         8337    18063    +9726     
- Partials        730     1065     +335

Impacted Files	Coverage Δ
.../log4j/v1/x/SkyWalkingContextPatternConverter.java	`0.00% <0.00%> (ø)`
...oolkit/log/log4j/v1/x/TraceIdPatternConverter.java	`0.00% <ø> (ø)`
...m/toolkit/log/log4j/v1/x/TraceIdPatternLayout.java	`0.00% <ø> (ø)`
...m/toolkit/log/log4j/v1/x/TraceIdPatternParser.java	`0.00% <0.00%> (ø)`
...lkit/log/log4j/v1/x/log/GRPCLogClientAppender.java	`0.00% <0.00%> (ø)`
...m/toolkit/log/log4j/v2/x/Log4j2OutputAppender.java	`0.00% <ø> (ø)`
...4j/v2/x/Log4j2SkyWalkingContextOutputAppender.java	`0.00% <0.00%> (ø)`
...kit/log/log4j/v2/x/SkyWalkingContextConverter.java	`0.00% <0.00%> (ø)`
...lkit/log/log4j/v2/x/log/GRPCLogClientAppender.java	`0.00% <0.00%> (ø)`
...lkit/log/logback/v1/x/LogbackPatternConverter.java	`0.00% <ø> (ø)`
... and 1880 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 528ee6d...e014c05. Read the comment docs.

.../library-util/src/main/java/org/apache/skywalking/oap/server/library/util/ResourceUtils.java

oap-server/server-core/pom.xml

docs/en/setup/backend/endpoint-grouping-rules.md

...org/apache/skywalking/oap/server/core/config/group/openapi/EndpointGroupingRule4Openapi.java

...ache/skywalking/oap/server/core/config/group/openapi/EndpointGroupingRuleReader4Openapi.java

...e/src/main/java/org/apache/skywalking/oap/server/core/config/group/EndpointNameGrouping.java

oap-server/server-core/pom.xml

fix/polish some typo and codes Co-authored-by: kezhenxu94 <kezhenxu94@apache.org>

docs/en/setup/backend/endpoint-grouping-rules.md

kezhenxu94

LGTM once CI pass. Thanks!!!

docs/en/setup/backend/endpoint-grouping-rules.md

.../library-util/src/main/java/org/apache/skywalking/oap/server/library/util/ResourceUtils.java

…ead the max depth 1 of the directory

docs/en/setup/backend/endpoint-grouping-rules.md

...ache/skywalking/oap/server/core/config/group/openapi/EndpointGroupingRuleReader4Openapi.java

…doesn't set service name and in root folder directly

docs/en/setup/backend/endpoint-grouping-rules.md

wu-sheng

It is good for me. Thanks.

kezhenxu94 · 2021-06-19T15:23:33Z

...pache/skywalking/oap/server/core/config/group/openapi/EndpointGroupingBenchmark4Openapi.java

+                rule.addGroupedRule("serviceA", "GET:/products1/{id}/" + +i, "GET:/products1/([^/]+)/" + i);
+                rule.addGroupedRule("serviceA", "POST:/products1/{id}/" + +i, "POST:/products1/([^/]+)/" + i);
+                rule.addGroupedRule("serviceA", "GET:/products2/{id}/" + +i, "GET:/products2/([^/]+)/" + i);
+                rule.addGroupedRule("serviceA", "POST:/products3/{id}/" + +i, "POST:/products3/([^/]+)/" + i);
+                rule.addGroupedRule("serviceA", "GET:/products3/{id}/" + +i, "GET:/products3/([^/]+)/" + i);


Not important though, "GET:/products1/{id}/" + +i looks tricky, why not just "GET:/products1/{id}/" + i?

Update:

I think what you want is "GET:/products1/{id}/" + ++i

Haha, interesting, it is better to fix before merge.

thanks, @kezhenxu94, I tested +i but forgot to remove them.

kezhenxu94 · 2021-06-19T15:23:43Z

...pache/skywalking/oap/server/core/config/group/openapi/EndpointGroupingBenchmark4Openapi.java

+                rule.addGroupedRule("serviceA", "GET:/products1/{id}/" + +i, "GET:/products1/([^/]+)/" + i);
+                rule.addGroupedRule("serviceA", "POST:/products1/{id}/" + +i, "POST:/products1/([^/]+)/" + i);
+                rule.addGroupedRule("serviceA", "GET:/products2/{id}/" + +i, "GET:/products2/([^/]+)/" + i);
+                rule.addGroupedRule("serviceA", "POST:/products3/{id}/" + +i, "POST:/products3/([^/]+)/" + i);
+                rule.addGroupedRule("serviceA", "GET:/products3/{id}/" + +i, "GET:/products3/([^/]+)/" + i);


kezhenxu94 · 2021-06-19T15:23:53Z

...pache/skywalking/oap/server/core/config/group/openapi/EndpointGroupingBenchmark4Openapi.java

+                rule.addGroupedRule("serviceA", "GET:/products1/{id}/" + +i, "GET:/products1/([^/]+)/" + i);
+                rule.addGroupedRule("serviceA", "POST:/products1/{id}/" + +i, "POST:/products1/([^/]+)/" + i);
+                rule.addGroupedRule("serviceA", "GET:/products2/{id}/" + +i, "GET:/products2/([^/]+)/" + i);
+                rule.addGroupedRule("serviceA", "POST:/products3/{id}/" + +i, "POST:/products3/([^/]+)/" + i);
+                rule.addGroupedRule("serviceA", "GET:/products3/{id}/" + +i, "GET:/products3/([^/]+)/" + i);


wankai123 added 5 commits June 18, 2021 08:53

Support endpoint name grouping by OpenAPI definitions

f718f39

Merge branch 'master' of github.com:apache/skywalking into openAPI

e2f4672

polish some docs and configs

4bd111e

turn off enableEndpointNameGroupingByOpenapi

83007d8

polish docs

a555601

wu-sheng added this to the 8.7.0 milestone Jun 18, 2021

wu-sheng added backend OAP backend related. feature New feature labels Jun 18, 2021

wu-sheng requested review from dmsolr, kezhenxu94, mrproliu and wu-sheng June 18, 2021 02:26

polish docs

73c887f

sonatype-lift bot reviewed Jun 18, 2021

View reviewed changes

.../library-util/src/main/java/org/apache/skywalking/oap/server/library/util/ResourceUtils.java Outdated Show resolved Hide resolved

sonatype-lift bot reviewed Jun 18, 2021

View reviewed changes

oap-server/server-core/pom.xml Outdated Show resolved Hide resolved

sonatype-lift bot reviewed Jun 18, 2021

View reviewed changes

oap-server/server-core/pom.xml Outdated Show resolved Hide resolved

sonatype-lift bot reviewed Jun 18, 2021

View reviewed changes

oap-server/server-core/pom.xml Outdated Show resolved Hide resolved

kezhenxu94 reviewed Jun 18, 2021

View reviewed changes

wankai123 and others added 2 commits June 18, 2021 12:46

Apply suggestions from code review

d41c5cc

fix/polish some typo and codes Co-authored-by: kezhenxu94 <kezhenxu94@apache.org>

remove swagger dependency

5ac177e

wu-sheng reviewed Jun 18, 2021

View reviewed changes

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

wu-sheng reviewed Jun 18, 2021

View reviewed changes

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

wu-sheng reviewed Jun 18, 2021

View reviewed changes

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

wu-sheng reviewed Jun 18, 2021

View reviewed changes

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

kezhenxu94 reviewed Jun 18, 2021

View reviewed changes

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

wu-sheng and others added 3 commits June 18, 2021 16:11

Merge branch 'master' into openAPI

fcae896

polish docs

8a4e0a3

Merge branch 'openAPI' of github.com:wankai123/skywalking into openAPI

2794f04

kezhenxu94 reviewed Jun 18, 2021

View reviewed changes

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

kezhenxu94 previously approved these changes Jun 18, 2021

View reviewed changes

kezhenxu94 requested a review from wu-sheng June 18, 2021 10:37

wu-sheng reviewed Jun 18, 2021

View reviewed changes

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

Merge branch 'master' into openAPI

69b37b6

wu-sheng dismissed kezhenxu94’s stale review via 69b37b6 June 18, 2021 13:18

wu-sheng reviewed Jun 18, 2021

View reviewed changes

.../library-util/src/main/java/org/apache/skywalking/oap/server/library/util/ResourceUtils.java Outdated Show resolved Hide resolved

wankai123 added 2 commits June 19, 2021 16:29

set directory name as the default service name, set the file reader r…

9912a51

…ead the max depth 1 of the directory

Merge branch 'openAPI' of github.com:wankai123/skywalking into openAPI

e13d088

wu-sheng reviewed Jun 19, 2021

View reviewed changes

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

wu-sheng reviewed Jun 19, 2021

View reviewed changes

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

wu-sheng reviewed Jun 19, 2021

View reviewed changes

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

wu-sheng reviewed Jun 19, 2021

View reviewed changes

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

sonatype-lift bot reviewed Jun 19, 2021

View reviewed changes

...ache/skywalking/oap/server/core/config/group/openapi/EndpointGroupingRuleReader4Openapi.java Show resolved Hide resolved

Merge branch 'master' into openAPI

f2c22d2

wu-sheng mentioned this pull request Jun 19, 2021

Dynamic configuration for a set of configurations. #7081

Closed

wankai123 added 3 commits June 19, 2021 22:43

set this feature enabled by default, throw exception if openAPI file …

90d7167

…doesn't set service name and in root folder directly

Merge branch 'openAPI' of github.com:wankai123/skywalking into openAPI

084499b

polish doc

026a6d5

wu-sheng reviewed Jun 19, 2021

View reviewed changes

docs/en/setup/backend/endpoint-grouping-rules.md Outdated Show resolved Hide resolved

Update docs/en/setup/backend/endpoint-grouping-rules.md

814eb19

wu-sheng previously approved these changes Jun 19, 2021

View reviewed changes

kezhenxu94 previously approved these changes Jun 19, 2021

View reviewed changes

polish codes

e014c05

wankai123 dismissed stale reviews from kezhenxu94 and wu-sheng via e014c05 June 19, 2021 16:14

wu-sheng approved these changes Jun 19, 2021

View reviewed changes

wu-sheng merged commit 19a068d into apache:master Jun 19, 2021

wu-sheng mentioned this pull request Jun 20, 2021

Format all HTTP related operation name in METHOD:URI #7135

Closed

wankai123 deleted the openAPI branch June 21, 2021 02:29

BFergerson mentioned this pull request Oct 14, 2022

[Feature] endpoint name grouping by OpenAPI definitions in Node.js agent #9787

Closed

3 tasks

Comments

Conversation

wankai123 commented Jun 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Support endpoint name grouping by OpenAPI definitions

Uh oh!

codecov bot commented Jun 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kezhenxu94 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wu-sheng left a comment

Choose a reason for hiding this comment

Uh oh!

kezhenxu94 Jun 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wu-sheng Jun 19, 2021

Choose a reason for hiding this comment

Uh oh!

wankai123 Jun 19, 2021

Choose a reason for hiding this comment

Uh oh!

kezhenxu94 Jun 19, 2021

Choose a reason for hiding this comment

Uh oh!

kezhenxu94 Jun 19, 2021

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

wankai123 commented Jun 18, 2021 •

edited

Loading

codecov bot commented Jun 18, 2021 •

edited

Loading

kezhenxu94 left a comment •

edited

Loading

kezhenxu94 Jun 19, 2021 •

edited

Loading