Skip to content

Commit

Permalink
Add links from experimental methods to the helper functions that allo…
Browse files Browse the repository at this point in the history
…w access to them. (#6529)

Co-authored-by: Jack Berg <[email protected]>
  • Loading branch information
tylerbenson and jack-berg authored Jul 11, 2024
1 parent 38aefff commit 20bcd75
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import io.opentelemetry.sdk.internal.ScopeConfiguratorBuilder;
import io.opentelemetry.sdk.logs.data.LogRecordData;
import io.opentelemetry.sdk.logs.internal.LoggerConfig;
import io.opentelemetry.sdk.logs.internal.SdkLoggerProviderUtil;
import io.opentelemetry.sdk.resources.Resource;
import java.util.ArrayList;
import java.util.List;
Expand Down Expand Up @@ -111,6 +112,9 @@ public SdkLoggerProviderBuilder setClock(Clock clock) {
* Set the logger configurator, which computes {@link LoggerConfig} for each {@link
* InstrumentationScopeInfo}.
*
* <p>This method is experimental so not public. You may reflectively call it using {@link
* SdkLoggerProviderUtil#setLoggerConfigurator(SdkLoggerProviderBuilder, ScopeConfigurator)}.
*
* <p>Overrides any matchers added via {@link #addLoggerConfiguratorCondition(Predicate,
* LoggerConfig)}.
*
Expand All @@ -126,6 +130,10 @@ SdkLoggerProviderBuilder setLoggerConfigurator(
* Adds a condition to the logger configurator, which computes {@link LoggerConfig} for each
* {@link InstrumentationScopeInfo}.
*
* <p>This method is experimental so not public. You may reflectively call it using {@link
* SdkLoggerProviderUtil#addLoggerConfiguratorCondition(SdkLoggerProviderBuilder, Predicate,
* LoggerConfig)}.
*
* <p>Applies after any previously added conditions.
*
* <p>If {@link #setLoggerConfigurator(ScopeConfigurator)} was previously called, this condition
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public SdkMeterProviderBuilder addResource(Resource resource) {
/**
* Assign an {@link ExemplarFilter} for all metrics created by Meters.
*
* <p>Note: not currently stable but available for experimental use via {@link
* <p>This method is experimental so not public. You may reflectively call it using {@link
* SdkMeterProviderUtil#setExemplarFilter(SdkMeterProviderBuilder, ExemplarFilter)}.
*/
SdkMeterProviderBuilder setExemplarFilter(ExemplarFilter filter) {
Expand Down Expand Up @@ -137,6 +137,10 @@ public SdkMeterProviderBuilder registerMetricReader(MetricReader reader) {
/**
* Registers a {@link MetricReader} with a {@link CardinalityLimitSelector}.
*
* <p>This method is experimental so not public. You may reflectively call it using {@link
* SdkMeterProviderUtil#registerMetricReaderWithCardinalitySelector(SdkMeterProviderBuilder,
* MetricReader, CardinalityLimitSelector)}
*
* <p>Note: not currently stable but available for experimental use via {@link
* SdkMeterProviderUtil#registerMetricReaderWithCardinalitySelector(SdkMeterProviderBuilder,
* MetricReader, CardinalityLimitSelector)}.
Expand All @@ -161,6 +165,9 @@ public SdkMeterProviderBuilder registerMetricProducer(MetricProducer metricProdu
* Set the meter configurator, which computes {@link MeterConfig} for each {@link
* InstrumentationScopeInfo}.
*
* <p>This method is experimental so not public. You may reflectively call it using {@link
* SdkMeterProviderUtil#setMeterConfigurator(SdkMeterProviderBuilder, ScopeConfigurator)}.
*
* <p>Overrides any matchers added via {@link #addMeterConfiguratorCondition(Predicate,
* MeterConfig)}.
*
Expand All @@ -175,6 +182,10 @@ SdkMeterProviderBuilder setMeterConfigurator(ScopeConfigurator<MeterConfig> mete
* Adds a condition to the meter configurator, which computes {@link MeterConfig} for each {@link
* InstrumentationScopeInfo}.
*
* <p>This method is experimental so not public. You may reflectively call it using {@link
* SdkMeterProviderUtil#addMeterConfiguratorCondition(SdkMeterProviderBuilder, Predicate,
* MeterConfig)}.
*
* <p>Applies after any previously added conditions.
*
* <p>If {@link #setMeterConfigurator(ScopeConfigurator)} was previously called, this condition
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ public ViewBuilder setAttributeFilter(Predicate<String> keyFilter) {
/**
* Add an attribute processor.
*
* <p>This method is experimental so not public. You may reflectively call it using {@link
* SdkMeterProviderUtil#appendFilteredBaggageAttributes(ViewBuilder, Predicate)}, {@link
* SdkMeterProviderUtil#appendAllBaggageAttributes(ViewBuilder)}.
*
* <p>Note: not currently stable but additional attribute processors can be configured via {@link
* SdkMeterProviderUtil#appendAllBaggageAttributes(ViewBuilder)}.
*/
Expand All @@ -106,6 +110,9 @@ ViewBuilder addAttributesProcessor(AttributesProcessor attributesProcessor) {
/**
* Set the cardinality limit.
*
* <p>This method is experimental so not public. You may reflectively call it using {@link
* SdkMeterProviderUtil#setCardinalityLimit(ViewBuilder, int)}
*
* <p>Note: not currently stable but cardinality limit can be configured via
* SdkMeterProviderUtil#setCardinalityLimit(ViewBuilder, int).
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import io.opentelemetry.sdk.internal.ScopeConfigurator;
import io.opentelemetry.sdk.internal.ScopeConfiguratorBuilder;
import io.opentelemetry.sdk.resources.Resource;
import io.opentelemetry.sdk.trace.internal.SdkTracerProviderUtil;
import io.opentelemetry.sdk.trace.internal.TracerConfig;
import io.opentelemetry.sdk.trace.samplers.Sampler;
import java.util.ArrayList;
Expand Down Expand Up @@ -158,6 +159,9 @@ public SdkTracerProviderBuilder addSpanProcessor(SpanProcessor spanProcessor) {
* Set the tracer configurator, which computes {@link TracerConfig} for each {@link
* InstrumentationScopeInfo}.
*
* <p>This method is experimental so not public. You may reflectively call it using {@link
* SdkTracerProviderUtil#setTracerConfigurator(SdkTracerProviderBuilder, ScopeConfigurator)}.
*
* <p>Overrides any matchers added via {@link #addTracerConfiguratorCondition(Predicate,
* TracerConfig)}.
*
Expand All @@ -173,6 +177,10 @@ SdkTracerProviderBuilder setTracerConfigurator(
* Adds a condition to the tracer configurator, which computes {@link TracerConfig} for each
* {@link InstrumentationScopeInfo}.
*
* <p>This method is experimental so not public. You may reflectively call it using {@link
* SdkTracerProviderUtil#addTracerConfiguratorCondition(SdkTracerProviderBuilder, Predicate,
* TracerConfig)}.
*
* <p>Applies after any previously added conditions.
*
* <p>If {@link #setTracerConfigurator(ScopeConfigurator)} was previously called, this condition
Expand Down

0 comments on commit 20bcd75

Please sign in to comment.