Skip to content

Commit 20bcd75

Browse files
Add links from experimental methods to the helper functions that allow access to them. (#6529)
Co-authored-by: Jack Berg <[email protected]>
1 parent 38aefff commit 20bcd75

File tree

4 files changed

+35
-1
lines changed

4 files changed

+35
-1
lines changed

sdk/logs/src/main/java/io/opentelemetry/sdk/logs/SdkLoggerProviderBuilder.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
import io.opentelemetry.sdk.internal.ScopeConfiguratorBuilder;
1717
import io.opentelemetry.sdk.logs.data.LogRecordData;
1818
import io.opentelemetry.sdk.logs.internal.LoggerConfig;
19+
import io.opentelemetry.sdk.logs.internal.SdkLoggerProviderUtil;
1920
import io.opentelemetry.sdk.resources.Resource;
2021
import java.util.ArrayList;
2122
import java.util.List;
@@ -111,6 +112,9 @@ public SdkLoggerProviderBuilder setClock(Clock clock) {
111112
* Set the logger configurator, which computes {@link LoggerConfig} for each {@link
112113
* InstrumentationScopeInfo}.
113114
*
115+
* <p>This method is experimental so not public. You may reflectively call it using {@link
116+
* SdkLoggerProviderUtil#setLoggerConfigurator(SdkLoggerProviderBuilder, ScopeConfigurator)}.
117+
*
114118
* <p>Overrides any matchers added via {@link #addLoggerConfiguratorCondition(Predicate,
115119
* LoggerConfig)}.
116120
*
@@ -126,6 +130,10 @@ SdkLoggerProviderBuilder setLoggerConfigurator(
126130
* Adds a condition to the logger configurator, which computes {@link LoggerConfig} for each
127131
* {@link InstrumentationScopeInfo}.
128132
*
133+
* <p>This method is experimental so not public. You may reflectively call it using {@link
134+
* SdkLoggerProviderUtil#addLoggerConfiguratorCondition(SdkLoggerProviderBuilder, Predicate,
135+
* LoggerConfig)}.
136+
*
129137
* <p>Applies after any previously added conditions.
130138
*
131139
* <p>If {@link #setLoggerConfigurator(ScopeConfigurator)} was previously called, this condition

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/SdkMeterProviderBuilder.java

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ public SdkMeterProviderBuilder addResource(Resource resource) {
8383
/**
8484
* Assign an {@link ExemplarFilter} for all metrics created by Meters.
8585
*
86-
* <p>Note: not currently stable but available for experimental use via {@link
86+
* <p>This method is experimental so not public. You may reflectively call it using {@link
8787
* SdkMeterProviderUtil#setExemplarFilter(SdkMeterProviderBuilder, ExemplarFilter)}.
8888
*/
8989
SdkMeterProviderBuilder setExemplarFilter(ExemplarFilter filter) {
@@ -137,6 +137,10 @@ public SdkMeterProviderBuilder registerMetricReader(MetricReader reader) {
137137
/**
138138
* Registers a {@link MetricReader} with a {@link CardinalityLimitSelector}.
139139
*
140+
* <p>This method is experimental so not public. You may reflectively call it using {@link
141+
* SdkMeterProviderUtil#registerMetricReaderWithCardinalitySelector(SdkMeterProviderBuilder,
142+
* MetricReader, CardinalityLimitSelector)}
143+
*
140144
* <p>Note: not currently stable but available for experimental use via {@link
141145
* SdkMeterProviderUtil#registerMetricReaderWithCardinalitySelector(SdkMeterProviderBuilder,
142146
* MetricReader, CardinalityLimitSelector)}.
@@ -161,6 +165,9 @@ public SdkMeterProviderBuilder registerMetricProducer(MetricProducer metricProdu
161165
* Set the meter configurator, which computes {@link MeterConfig} for each {@link
162166
* InstrumentationScopeInfo}.
163167
*
168+
* <p>This method is experimental so not public. You may reflectively call it using {@link
169+
* SdkMeterProviderUtil#setMeterConfigurator(SdkMeterProviderBuilder, ScopeConfigurator)}.
170+
*
164171
* <p>Overrides any matchers added via {@link #addMeterConfiguratorCondition(Predicate,
165172
* MeterConfig)}.
166173
*
@@ -175,6 +182,10 @@ SdkMeterProviderBuilder setMeterConfigurator(ScopeConfigurator<MeterConfig> mete
175182
* Adds a condition to the meter configurator, which computes {@link MeterConfig} for each {@link
176183
* InstrumentationScopeInfo}.
177184
*
185+
* <p>This method is experimental so not public. You may reflectively call it using {@link
186+
* SdkMeterProviderUtil#addMeterConfiguratorCondition(SdkMeterProviderBuilder, Predicate,
187+
* MeterConfig)}.
188+
*
178189
* <p>Applies after any previously added conditions.
179190
*
180191
* <p>If {@link #setMeterConfigurator(ScopeConfigurator)} was previously called, this condition

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/ViewBuilder.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,10 @@ public ViewBuilder setAttributeFilter(Predicate<String> keyFilter) {
9494
/**
9595
* Add an attribute processor.
9696
*
97+
* <p>This method is experimental so not public. You may reflectively call it using {@link
98+
* SdkMeterProviderUtil#appendFilteredBaggageAttributes(ViewBuilder, Predicate)}, {@link
99+
* SdkMeterProviderUtil#appendAllBaggageAttributes(ViewBuilder)}.
100+
*
97101
* <p>Note: not currently stable but additional attribute processors can be configured via {@link
98102
* SdkMeterProviderUtil#appendAllBaggageAttributes(ViewBuilder)}.
99103
*/
@@ -106,6 +110,9 @@ ViewBuilder addAttributesProcessor(AttributesProcessor attributesProcessor) {
106110
/**
107111
* Set the cardinality limit.
108112
*
113+
* <p>This method is experimental so not public. You may reflectively call it using {@link
114+
* SdkMeterProviderUtil#setCardinalityLimit(ViewBuilder, int)}
115+
*
109116
* <p>Note: not currently stable but cardinality limit can be configured via
110117
* SdkMeterProviderUtil#setCardinalityLimit(ViewBuilder, int).
111118
*

sdk/trace/src/main/java/io/opentelemetry/sdk/trace/SdkTracerProviderBuilder.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
import io.opentelemetry.sdk.internal.ScopeConfigurator;
1313
import io.opentelemetry.sdk.internal.ScopeConfiguratorBuilder;
1414
import io.opentelemetry.sdk.resources.Resource;
15+
import io.opentelemetry.sdk.trace.internal.SdkTracerProviderUtil;
1516
import io.opentelemetry.sdk.trace.internal.TracerConfig;
1617
import io.opentelemetry.sdk.trace.samplers.Sampler;
1718
import java.util.ArrayList;
@@ -158,6 +159,9 @@ public SdkTracerProviderBuilder addSpanProcessor(SpanProcessor spanProcessor) {
158159
* Set the tracer configurator, which computes {@link TracerConfig} for each {@link
159160
* InstrumentationScopeInfo}.
160161
*
162+
* <p>This method is experimental so not public. You may reflectively call it using {@link
163+
* SdkTracerProviderUtil#setTracerConfigurator(SdkTracerProviderBuilder, ScopeConfigurator)}.
164+
*
161165
* <p>Overrides any matchers added via {@link #addTracerConfiguratorCondition(Predicate,
162166
* TracerConfig)}.
163167
*
@@ -173,6 +177,10 @@ SdkTracerProviderBuilder setTracerConfigurator(
173177
* Adds a condition to the tracer configurator, which computes {@link TracerConfig} for each
174178
* {@link InstrumentationScopeInfo}.
175179
*
180+
* <p>This method is experimental so not public. You may reflectively call it using {@link
181+
* SdkTracerProviderUtil#addTracerConfiguratorCondition(SdkTracerProviderBuilder, Predicate,
182+
* TracerConfig)}.
183+
*
176184
* <p>Applies after any previously added conditions.
177185
*
178186
* <p>If {@link #setTracerConfigurator(ScopeConfigurator)} was previously called, this condition

0 commit comments

Comments
 (0)