Add links from experimental methods to the helper functions that allow access to them. (#6529)

Co-authored-by: Jack Berg <jberg@newrelic.com>
This commit is contained in:
Tyler Benson 2024-07-11 18:03:17 -04:00 committed by GitHub
parent 38aeffff14
commit 20bcd7546b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 35 additions and 1 deletions

View File

@ -16,6 +16,7 @@ import io.opentelemetry.sdk.internal.ScopeConfigurator;
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;
@ -111,6 +112,9 @@ public final class SdkLoggerProviderBuilder {
* 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)}.
*
@ -126,6 +130,10 @@ public final class SdkLoggerProviderBuilder {
* 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

View File

@ -83,7 +83,7 @@ public final class SdkMeterProviderBuilder {
/**
* 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) {
@ -137,6 +137,10 @@ public final class SdkMeterProviderBuilder {
/**
* 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)}.
@ -161,6 +165,9 @@ public final class SdkMeterProviderBuilder {
* 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)}.
*
@ -175,6 +182,10 @@ public final class SdkMeterProviderBuilder {
* 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

View File

@ -94,6 +94,10 @@ public final class ViewBuilder {
/**
* 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)}.
*/
@ -106,6 +110,9 @@ public final class ViewBuilder {
/**
* 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).
*

View File

@ -12,6 +12,7 @@ import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
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;
@ -158,6 +159,9 @@ public final class SdkTracerProviderBuilder {
* 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)}.
*
@ -173,6 +177,10 @@ public final class SdkTracerProviderBuilder {
* 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