Added an option to have baggage through Observation API #688

marcingrzejszczak · 2024-05-07T13:54:40Z

whenever a key-value matches a preconfigured baggage config and an Observation started a scope then automatically baggages will also be started

fixes gh-455

TODO:

docs
boot autoconfig to set up baggage on baggagemanagers

related #455

whenever a key-value matches a preconfigured baggage config and an Observation started a scope then automatically baggages will also be started fixes gh-455

shakuzen · 2024-05-08T03:39:04Z

...acing-bridge-brave/src/main/java/io/micrometer/tracing/brave/bridge/BraveBaggageManager.java

+
+    private static List<String> remoteFields(List<String> tagFields, List<String> remoteFields) {
+        List<String> combined = new ArrayList<>(tagFields);
+        combined.addAll(remoteFields);


Why are these combined? It looks like the other baggage managers don't combine them.

So when you have tag fields it means that it's baggage that additionally will be tagged. Inc case of Brave we never had a constructor that accepts just remote fields and I can't introduce one cause we have a constructor for tag fields already. So it does make sense to combine them. Of course I should combine those for other baggage managers too - I'll look into that, thanks

Is it better to create a unique set of fields?
The values seem to be used in the handler for contains, so in the end, it doesn't need to be unique here, but just for clarity.

I think I'm still confused. The assumption seems to be that all tagFields are remote baggage. Is local baggage that should also be tagged not possible? In the test code, it looks like the baggage key to be tagged is local baggage:

.add(BaggagePropagationConfig.SingleBaggageField.local(BaggageField.create(TAG_KEY)))

So shouldn't that not be combined with remote fields?

From the point of view of a baggage manager there is no concept of local fields. That is really brave specific and has to be configured via propagation configuration. I understand that this might be confusing. We can rename this from remoteFields to baggageFields and that way that will mean all baggage regardless of whether it's local or remote. WDYT?

That sounds good.

jonatan-ivanov · 2024-05-08T04:22:35Z

...acing-bridge-brave/src/main/java/io/micrometer/tracing/brave/bridge/BraveBaggageManager.java

     */
-    public BraveBaggageManager(List<String> tagFields) {
+    public BraveBaggageManager(List<String> tagFields, List<String> remoteFields) {


Shouldn't we introduce a new ctor?
Can any of these be null?

We can't - type inference is the same. They can't be null, we have non null api by default. We can pass empty collections

jonatan-ivanov · 2024-05-08T04:26:26Z

...ometer-tracing-bridge-otel/src/test/java/io/micrometer/tracing/otel/bridge/BaggageTests.java

- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except


The license format is different for other files.

That's strange

jonatan-ivanov · 2024-05-08T04:34:56Z

...eter-tracing-bridge-brave/src/test/java/io/micrometer/tracing/brave/bridge/BaggageTests.java

+        then(tracer.getBaggage(KEY_1).get()).isNull();
+        then(tracer.getBaggage(OBSERVATION_BAGGAGE_KEY).get()).isNull();


Can we do these check before opening the scope too?

ttddyy · 2024-05-08T18:33:33Z

...acing-bridge-brave/src/main/java/io/micrometer/tracing/brave/bridge/BraveBaggageManager.java

+
+    private static List<String> remoteFields(List<String> tagFields, List<String> remoteFields) {
+        List<String> combined = new ArrayList<>(tagFields);
+        combined.addAll(remoteFields);


Is it better to create a unique set of fields?
The values seem to be used in the handler for contains, so in the end, it doesn't need to be unique here, but just for clarity.

ttddyy · 2024-05-08T18:40:09Z

micrometer-tracing/src/main/java/io/micrometer/tracing/handler/RevertingScope.java

+    }
+
+    private static List<KeyValue> matchingBaggageKeyValues(Tracer tracer, ContextView context) {
+        List<String> lowerCaseRemoteFields = new ArrayList<>();


Good to make it a Set for being used with contains for small performance optimization.

Thanks, I've applied both suggestions

ttddyy · 2024-05-09T18:38:35Z

micrometer-tracing/src/main/java/io/micrometer/tracing/handler/RevertingScope.java

+        for (String remoteField : tracer.getBaggageFields()) {
+            lowerCaseRemoteFields.add(remoteField.toLowerCase());
+        }
+        Set<KeyValue> baggageKeyValues = new HashSet<>();


nit: Different from the lowerCaseRemoteFields variable, this baggageKeyValues variable (and the return type of this method, etc) might be better to keep as List. That way, creating BaggageInScope is always in a predictable order which might give an easier debug experience, just in case. If the ordering doesn't really matter, then Set is ok.

You're right, I fixed that

marcingrzejszczak · 2024-05-20T15:50:35Z

cc @mhalbritter once we merge this, the constructors for baggagemanagers changed (non breaking change) so in boot we could start using the remote fields property to set the baggage fields on the baggage managers

mhalbritter · 2024-08-12T09:22:14Z

Currently looking at the changes in boot. Looks like the OtelBaggageManager had remote fields already.

So this is the only required change in Boot?

===================================================================
diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/BraveAutoConfiguration.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/BraveAutoConfiguration.java
--- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/BraveAutoConfiguration.java	(revision 5141045f6f64b1ec265aeba2b9bdb647f655fc21)
+++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/BraveAutoConfiguration.java	(date 1723454089310)
@@ -155,7 +155,10 @@
 	@ConditionalOnMissingBean(io.micrometer.tracing.Tracer.class)
 	BraveTracer braveTracerBridge(brave.Tracer tracer, CurrentTraceContext currentTraceContext) {
 		return new BraveTracer(tracer, new BraveCurrentTraceContext(currentTraceContext),
-				new BraveBaggageManager(this.tracingProperties.getBaggage().getTagFields()));
+				new BraveBaggageManager(
+						this.tracingProperties.getBaggage().getTagFields(),
+						this.tracingProperties.getBaggage().getRemoteFields()
+				));
 	}
 
 	@Bean

So we need to change the propagation somehow? https://github.com/spring-projects/spring-boot/blob/4b0bed23b054e400c33589d27812c0ad686421e7/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/BravePropagationConfigurations.java#L113 and https://github.com/spring-projects/spring-boot/blob/a0a804cfdf05f3e15bcc119c06ac3a85939c4ba0/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/OpenTelemetryPropagationConfigurations.java#L73 ?

jonatan-ivanov · 2024-08-16T02:20:41Z

@mhalbritter I think that's it, since OtelBaggageManager has both, BraveBaggageManager needs the remote fields passed.

I don't think propagators should be changed since they are using the baggages after they are set (this change sets them from the Observation).

If you want to play with this or write tests to see that Boot's auto-configuration results in the right behavior, here's a test example with OTel, Brave should only differ in the "configuration" part of the test: https://docs.micrometer.io/tracing/reference/1.4-SNAPSHOT/api.html#_baggage_with_micrometer_observation_api

mhalbritter · 2024-08-16T07:31:53Z

Thanks @jonatan-ivanov !

mhalbritter · 2024-08-16T08:06:28Z

It's on main.

Added an option to have baggage through Observation API

7c5d17f

whenever a key-value matches a preconfigured baggage config and an Observation started a scope then automatically baggages will also be started fixes gh-455

shakuzen reviewed May 8, 2024

View reviewed changes

jonatan-ivanov reviewed May 8, 2024

View reviewed changes

Updates following the review

0592488

marcingrzejszczak marked this pull request as ready for review May 8, 2024 08:01

marcingrzejszczak requested review from ttddyy, jonatan-ivanov and shakuzen May 8, 2024 08:01

ttddyy reviewed May 8, 2024

View reviewed changes

Changes following review

544aa1c

marcingrzejszczak added this to the 1.4.0-M1 milestone May 9, 2024

Changes following review

085e916

ttddyy reviewed May 9, 2024

View reviewed changes

Changes following review

464d419

marcingrzejszczak merged commit 4b2a93e into main May 20, 2024
6 checks passed

marcingrzejszczak deleted the baggage_through_observation branch May 20, 2024 15:50

mhalbritter mentioned this pull request Aug 16, 2024

Auto-configure remote fields on BraveBaggageManager spring-projects/spring-boot#41884

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added an option to have baggage through Observation API #688

Added an option to have baggage through Observation API #688

marcingrzejszczak commented May 7, 2024 •

edited

Loading

shakuzen May 8, 2024

marcingrzejszczak May 8, 2024

ttddyy May 8, 2024

shakuzen May 9, 2024

marcingrzejszczak May 9, 2024

shakuzen May 9, 2024

jonatan-ivanov May 8, 2024

marcingrzejszczak May 8, 2024

jonatan-ivanov May 8, 2024

marcingrzejszczak May 8, 2024

jonatan-ivanov May 8, 2024

marcingrzejszczak May 8, 2024

ttddyy May 8, 2024

ttddyy May 8, 2024

marcingrzejszczak May 9, 2024

ttddyy May 9, 2024

marcingrzejszczak May 10, 2024

marcingrzejszczak commented May 20, 2024

mhalbritter commented Aug 12, 2024

jonatan-ivanov commented Aug 16, 2024

mhalbritter commented Aug 16, 2024

mhalbritter commented Aug 16, 2024

		then(tracer.getBaggage(KEY_1).get()).isNull();
		then(tracer.getBaggage(OBSERVATION_BAGGAGE_KEY).get()).isNull();

Added an option to have baggage through Observation API #688

Added an option to have baggage through Observation API #688

Conversation

marcingrzejszczak commented May 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcingrzejszczak commented May 20, 2024

mhalbritter commented Aug 12, 2024

jonatan-ivanov commented Aug 16, 2024

mhalbritter commented Aug 16, 2024

mhalbritter commented Aug 16, 2024

marcingrzejszczak commented May 7, 2024 •

edited

Loading