open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

clean up the package-level docs for the sdk trace export package. (#3208) 

Resolves #2903
This commit is contained in:
John Watson 2021-05-06 16:15:41 -07:00 committed by GitHub
parent 910e66c8db
commit 15a1160e56
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
sdk/trace/src/main/java/io/opentelemetry/sdk/trace/export/package-info.java
View File

@ -4,8 +4,8 @@
*/ */
/** /**
* Utilities that allows different tracing services to export recorded data for sampled spans in * Utilities that allow tracing services to export data for sampled spans, as well as providing
* their own format. * in-process span processing APIs.
* *
* <h2>Contents</h2> * <h2>Contents</h2>
* *
@ -13,66 +13,11 @@
* <li>{@link io.opentelemetry.sdk.trace.export.SpanExporter} * <li>{@link io.opentelemetry.sdk.trace.export.SpanExporter}
* <li>{@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor} * <li>{@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor}
* <li>{@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor} * <li>{@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor}
* <li>{@link io.opentelemetry.sdk.trace.export.BatchSpanProcessorBuilder}
* </ul> * </ul>
* *
* <h2>Default values for {@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor}</h2> * <p>Configuration options for components in this package can be read from system properties or
* * environment variables with the use of the opentelemetry-autoconfiguration module.
* <ul>
* <li>{@code REPORT_ONLY_SAMPLED: true} *
* </ul>
*
* <p>Configuration options for {@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor} can be
* read from system properties, environment variables, or {@link java.util.Properties} objects.
*
* <p>For system properties and {@link java.util.Properties} objects, {@link
* io.opentelemetry.sdk.trace.export.SimpleSpanProcessor} will look for the following names:
*
* <ul>
* <li>{@code otel.ssp.export.sampled}: sets whether only sampled spans should be exported.
* </ul>
*
* <p>For environment variables, {@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor} will
* look for the following names:
*
* <ul>
* <li>{@code OTEL_SSP_EXPORT_SAMPLED}: sets whether only sampled spans should be exported.
* </ul>
*
* <h2>Default values for {@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor}</h2>
*
* <ul>
* <li>{@code SCHEDULE_DELAY_MILLIS: 5000}
* <li>{@code MAX_QUEUE_SIZE: 2048}
* <li>{@code MAX_EXPORT_BATCH_SIZE: 512}
* <li>{@code EXPORT_TIMEOUT_MILLIS: 30_000}
* <li>{@code REPORT_ONLY_SAMPLED: true}
* </ul>
*
* <p>Configuration options for {@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor} can be
* read from system properties, environment variables, or {@link java.util.Properties} objects.
*
* <p>For system properties and {@link java.util.Properties} objects, {@link
* io.opentelemetry.sdk.trace.export.BatchSpanProcessor} will look for the following names:
*
* <ul>
* <li>{@code otel.bsp.schedule.delay.millis}: sets the delay interval between two consecutive
* exports.
* <li>{@code otel.bsp.max.queue.size}: sets the maximum queue size.
* <li>{@code otel.bsp.max.export.batch.size}: sets the maximum batch size.
* <li>{@code otel.bsp.export.timeout.millis}: sets the maximum allowed time to export data.
* <li>{@code otel.bsp.export.sampled}: sets whether only sampled spans should be exported.
* </ul>
*
* <p>For environment variables, {@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor} will
* look for the following names:
*
* <ul>
* <li>{@code OTEL_BSP_SCHEDULE_DELAY}: sets the delay interval between two consecutive exports.
* <li>{@code OTEL_BSP_MAX_QUEUE_SIZE}: sets the maximum queue size.
* <li>{@code OTEL_BSP_MAX_EXPORT_BATCH_SIZE}: sets the maximum batch size.
* <li>{@code OTEL_BSP_EXPORT_TIMEOUT}: sets the maximum allowed time to export data.
* <li>{@code OTEL_BSP_EXPORT_SAMPLED}: sets whether only sampled spans should be exported.
* </ul>
*/ */
@ParametersAreNonnullByDefault @ParametersAreNonnullByDefault
package io.opentelemetry.sdk.trace.export; package io.opentelemetry.sdk.trace.export;