Skip to content

Commit 92633e2

Browse files
committed
Improve javadoc
1 parent 5e8e639 commit 92633e2

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

dd-trace-core/src/main/java/datadog/trace/core/propagation/PropagationTags.java

+20-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import static datadog.trace.api.ConfigDefaults.DEFAULT_TRACE_X_DATADOG_TAGS_MAX_LENGTH;
44

55
import datadog.trace.api.Config;
6+
import datadog.trace.api.ProductTraceSource;
67
import datadog.trace.core.propagation.ptags.PTagsFactory;
78
import java.util.HashMap;
89
import java.util.Map;
@@ -100,9 +101,27 @@ public interface Factory {
100101
*/
101102
public abstract void fillTagMap(Map<String, String> tagMap);
102103

103-
/** Add the appsec propagation tag to the propagation tags. */
104+
/**
105+
* Updates the propagated trace source propagation tag to include the specified product.
106+
*
107+
* <p>The product value is parsed and interpreted according to the logic in {@link
108+
* ProductTraceSource}. This method ensures that the given product is marked in the propagated
109+
* trace source.
110+
*
111+
* @param product the product identifier to be added to the propagated trace source. Refer to
112+
* {@link ProductTraceSource} for details on how the value is interpreted.
113+
*/
104114
public abstract void updatePropagatedTraceSource(int product);
105115

116+
/**
117+
* Retrieves the current propagated trace source propagation tag.
118+
*
119+
* <p>The returned value is an encoded bitfield that represents the included products. To
120+
* understand how this value is parsed and interpreted, refer to {@link ProductTraceSource}.
121+
*
122+
* @return the propagated trace source as an integer bitfield. See {@link ProductTraceSource} for
123+
* details on its structure and usage.
124+
*/
106125
public abstract int getPropagatedTraceSource();
107126

108127
public abstract void updateDebugPropagation(String value);

0 commit comments

Comments
 (0)