Adds Micrometer Observation instrumentation by marcingrzejszczak · Pull Request #401 · apache/skywalking-java

marcingrzejszczak · 2022-11-30T16:06:19Z

Add an agent plugin to support

Add a test case for the new plugin, refer to the doc
Add a component id in the component-libraries.yml - Add Micrometer as a component skywalking#10078
Add a logo in the UI repo - Added Micrometer icon skywalking-booster-ui#201

If this pull request closes/resolves/fixes an existing issue, replace the issue number. Closes #.
Update the CHANGES log.

wu-sheng · 2022-12-01T00:45:27Z

@pg-yang @yswdqz Does any of you have time to continue on this one? Marcin finished most parts.

yswdqz · 2022-12-01T03:14:34Z

@pg-yang @yswdqz Does any of you have time to continue on this one? Marcin finished most parts.

Sorry, I don't have time recently.

marcingrzejszczak · 2022-12-01T10:39:55Z

The only thing to look at is the e2e plugin tests and modify the expectedData.yml for the tests to pass.

Also I see that we're currently in Spring naming spans in a different way than skywalking does. Should we leave it like this or rename the spans in the way that Skywalking does it?

wu-sheng · 2022-12-01T10:42:13Z

Also I see that we're currently in Spring naming spans in a different way than skywalking does. Should we leave it like this or rename the spans in the way that Skywalking does it?

It is your call. URI style or ./spacing are helpful for endpoint searching. The endpoint is from span name of entry span.

marcingrzejszczak · 2022-12-01T10:45:07Z

Ok, the user can rename the observations at runtime by providing their own ObservationFilter to the registry, so that is not a problem.

So the only thing that remains is to make the e2e pass and we're done.

marcingrzejszczak · 2022-12-02T15:17:16Z

I've managed to finally set up the e2e scenario with Spring Framework 6, jdk 17.

In Skywalking got the following graph:

The headers get propagated

Got following headers [sw8:"1-ZDA3YTFjNzc4YWEzNDc3NWFmY2Q2MjQ3ZWY0N2ZiMzIuNTYuMTY2OTk5MzEzNzk1NjAwMDE=-ZDA3YTFjNzc4YWEzNDc3NWFmY2Q2MjQ3ZWY0N2ZiMzIuNTYuMTY2OTk5MzEzNzk1NjAwMDA=-1-WW91cl9BcHBsaWNhdGlvbk5hbWU=-MmFiMWNkNWRmZTJmNDJhNDkzNTA3ZjFkNDhiZTJmMTFAMTAuNy4xOC4xOTE=-aHR0cC5zZXJ2ZXIucmVxdWVzdHM=-bG9jYWxob3N0OjIzNDU=", sw8-correlation:"", sw8-x:"0-", accept:"text/plain, application/json, application/*+json, */*", user-agent:"Java/17.0.1", host:"localhost:2345", connection:"keep-alive"]

And the metrics are collected

 - Metric type  [TIMER],        name [http.client.requests],    tags [tag(error=none), tag(exception=none), tag(method=GET), tag(outcome=SUCCESS), tag(status=200), tag(uri=http://localhost:2345/resttemplate-6.x-scenario/resttemplate/syncback)],      measurements [Measurement{statistic='COUNT', value=1.0}, Measurement{statistic='TOTAL_TIME', value=123511.0}, Measurement{statistic='MAX', value=123511.0}]
 - Metric type  [LONG_TASK_TIMER],      name [http.server.requests.active],     tags [tag(exception=none), tag(method=GET), tag(outcome=SUCCESS), tag(status=200), tag(uri=UNKNOWN)],     measurements [Measurement{statistic='ACTIVE_TASKS', value=0.0}, Measurement{statistic='DURATION', value=0.0}]
 - Metric type  [TIMER],        name [http.server.requests],    tags [tag(error=none), tag(exception=none), tag(method=GET), tag(outcome=SUCCESS), tag(status=200), tag(uri=/resttemplate/syncback)],     measurements [Measurement{statistic='COUNT', value=1.0}, Measurement{statistic='TOTAL_TIME', value=68701.0}, Measurement{statistic='MAX', value=68701.0}]
 - Metric type  [LONG_TASK_TIMER],      name [http.client.requests.active],     tags [tag(exception=none), tag(method=GET), tag(outcome=UNKNOWN), tag(status=CLIENT_ERROR), tag(uri=http://localhost:2345/resttemplate-6.x-scenario/resttemplate/syncback)],      measurements [Measurement{statistic='ACTIVE_TASKS', value=0.0}, Measurement{statistic='DURATION', value=0.0}]
 - Metric type  [TIMER],        name [http.server.requests],    tags [tag(error=none), tag(exception=none), tag(method=GET), tag(outcome=SUCCESS), tag(status=200), tag(uri=/resttemplate/case/resttemplate)],    measurements [Measurement{statistic='COUNT', value=1.0}, Measurement{statistic='TOTAL_TIME', value=149568.0}, Measurement{statistic='MAX', value=149568.0}]

apache/skywalking-java#401

…ng 30x status code

wu-sheng · 2022-12-03T12:42:08Z

@mrproliu Could you recheck this as an enhancement of the Micrometer?

BTW, from @marcingrzejszczak , the sleuth is not there, but micrometer still is. https://skywalking.apache.org/docs/main/next/en/setup/backend/spring-sleuth-setup/ the doc should be updated.

@marcingrzejszczak What is your suggestion for this part of the doc? Are these metrics still valid?

Configure the meter config file. It already has the spring sleuth meter config. If you have a customized meter at the agent side, please configure the meter using the steps set out in the meter document.

marcingrzejszczak · 2022-12-03T12:52:11Z

Skywalking has nothing to do with Sleuth. There is no Sleuth meter config, there's only micrometer meter config.

mrproliu · 2022-12-04T07:29:16Z

+/**
+ * A {@link ThreadLocalAccessor} to put and restore current {@code ContextSnapshot} from APM agent.
+ */
+public class SkywalkingContextSnapshotThreadLocalAccessor implements ThreadLocalAccessor<Object> {


When do we need this? I see the agent code, it used to continue the context when cross process? But there also have some TODO not finished.

Actually I would need some feedback from you. When we continue a span between threads, what should be the name of that continued span? Also how can you reset the thread local with a span (how can I remove the active span from thread local)

Usually, we don't continue a span in a new thread. We only support finishing a span in a new thread, or continuous tracing context(capture and continuous snapshot from ContextManager)

When we continue a span between threads, what should be the name of that continued span?

It's usually decided by when you need to cross-thread. Such as when we submit a new thread, we called Thread/{thread_name}/{running_function}.

Also how can you reset the thread local with a span (how can I remove the active span from thread local)

Here has a good demo, you could check this out. In this demo, we capture a snapshot from the tracing context and continue the snapshot in other thread.

mrproliu · 2022-12-04T07:32:21Z

+
+    public static final String INTERCEPT_EVENT_POINT_METHOD = "onEvent";
+
+    public static final String INTERCEPT_CLASS = "org.apache.skywalking.apm.plugin.micrometer.MicrometerDefaultTracingHandlerInterceptor";


The interceptor classes of all instrumentation are not correct, please help to fix it.
In this case, it should be: org.apache.skywalking.apm.toolkit.activation.micrometer.MicrometerDefaultTracingHandlerInterceptor

I guess I'll need to move the classes around again after talking to @wu-sheng but thanks for pointing this out

wu-sheng · 2023-01-17T06:10:51Z

@marcingrzejszczak We have 8.14.0 released now. Could you try to make your plugin test back to the CI pipeline?

marcingrzejszczak · 2023-01-17T08:50:06Z

I will do it asap, thanks :)

marcingrzejszczak and others added 5 commits November 29, 2022 12:52

WIP

3ba28dc

Polish

a2b0151

Moved the code around, added tags and layer setting

64ccece

Added scenario

6ac6b3f

Merge branch 'main' into micrometer

4f165d4

wu-sheng added plugin TBD labels Dec 1, 2022

wu-sheng reviewed Dec 1, 2022

View reviewed changes

Comment thread test/plugin/scenarios/resttemplate-6.x-scenario/config/expectedData.yaml Outdated

wu-sheng reviewed Dec 1, 2022

View reviewed changes

Comment thread test/plugin/scenarios/resttemplate-6.x-scenario/config/expectedData.yaml Outdated

wu-sheng reviewed Dec 1, 2022

View reviewed changes

Comment thread test/plugin/scenarios/resttemplate-6.x-scenario/config/expectedData.yaml Outdated

wu-sheng reviewed Dec 1, 2022

View reviewed changes

Comment thread test/plugin/scenarios/resttemplate-6.x-scenario/config/expectedData.yaml Outdated

marcingrzejszczak and others added 3 commits December 1, 2022 15:19

Merge branch 'main' into micrometer

1458e9d

Polish

72e0c03

Added e2e scenario for resttemplate + mvc with spring framework 6

e4f6164

Updated changes.md

da3bfe2

wu-sheng added this to the 8.14.0 milestone Dec 2, 2022

wu-sheng removed the TBD label Dec 2, 2022

marcingrzejszczak added a commit to marcingrzejszczak/skywalking that referenced this pull request Dec 2, 2022

Add Micrometer as a component

6ae4d62

apache/skywalking-java#401

marcingrzejszczak mentioned this pull request Dec 2, 2022

Add Micrometer as a component apache/skywalking#10078

Merged

2 tasks

marcingrzejszczak added 5 commits December 2, 2022 17:02

Updated the component number

534d3f2

polish

5f306e6

Added missing headers + added test to CI

97c2fc7

Fixed checkstyle

20a9ef2

Changed the link to micrometer - the other one is failing due to havi…

0156eaa

…ng 30x status code

marcingrzejszczak and others added 4 commits December 3, 2022 10:35

Excluded resttemplate 6.x from CI

07834e3

Added docs

dde1a24

Update Application-toolkit-micrometer.md

336a987

Moved micrometer-1.10.x-plugin to apm-toolkit-activation

297210b

wu-sheng requested a review from mrproliu December 3, 2022 12:39

mrproliu reviewed Dec 4, 2022

View reviewed changes

marcingrzejszczak and others added 3 commits December 5, 2022 07:38

Moved micrometer observation to a separate module

972e2ba

Merge branch 'main' into micrometer

a39c752

Update io.micrometer.context.ThreadLocalAccessor

0539ebe

mrproliu approved these changes Dec 6, 2022

View reviewed changes

wu-sheng approved these changes Dec 6, 2022

View reviewed changes

Merge branch 'main' into micrometer

102cacf

wu-sheng merged commit 4f9c2d8 into apache:main Dec 6, 2022

wu-sheng mentioned this pull request Dec 6, 2022

[Feature] Micrometer 1.10 Observation API support apache/skywalking#9578

Closed

3 tasks

marcingrzejszczak mentioned this pull request Jan 26, 2023

Uncommented Mircometer Observation CI test #443

Merged


		public static final String INTERCEPT_EVENT_POINT_METHOD = "onEvent";

		public static final String INTERCEPT_CLASS = "org.apache.skywalking.apm.plugin.micrometer.MicrometerDefaultTracingHandlerInterceptor";

Conversation

marcingrzejszczak commented Nov 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Add an agent plugin to support

Uh oh!

wu-sheng commented Dec 1, 2022

Uh oh!

yswdqz commented Dec 1, 2022

Uh oh!

marcingrzejszczak commented Dec 1, 2022

Uh oh!

wu-sheng commented Dec 1, 2022

Uh oh!

marcingrzejszczak commented Dec 1, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marcingrzejszczak commented Dec 2, 2022

Uh oh!

wu-sheng commented Dec 3, 2022

Uh oh!

marcingrzejszczak commented Dec 3, 2022

Uh oh!

mrproliu Dec 4, 2022

Choose a reason for hiding this comment

Uh oh!

marcingrzejszczak Dec 4, 2022

Choose a reason for hiding this comment

Uh oh!

wu-sheng Dec 5, 2022

Choose a reason for hiding this comment

Uh oh!

mrproliu Dec 5, 2022

Choose a reason for hiding this comment

Uh oh!

mrproliu Dec 4, 2022

Choose a reason for hiding this comment

Uh oh!

marcingrzejszczak Dec 4, 2022

Choose a reason for hiding this comment

Uh oh!

wu-sheng commented Jan 17, 2023

Uh oh!

marcingrzejszczak commented Jan 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

marcingrzejszczak commented Nov 30, 2022 •

edited

Loading