io.opentelemetry.sdk.trace.export.package-info Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lightstep-opentelemetry-auto-exporter Show documentation
Lightstep OpenTelemetry Auto Exporter
The newest version!
/*
 * Copyright 2020, OpenTelemetry Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Utilities that allows different tracing services to export recorded data for sampled spans in
 * their own format.
 *
 * Contents
 *
 * 
 *   {@link io.opentelemetry.sdk.trace.export.SpanExporter}
 *   
{@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor}
 *   
{@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor}
 *   
{@link io.opentelemetry.sdk.trace.export.MultiSpanExporter}
 * 
 *
 * Default values for {@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor}
 *
 * 
 *   {@code REPORT_ONLY_SAMPLED: true} *
 * 
 *
 * Configuration options for {@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor} can be
 * read from system properties, environment variables, or {@link java.util.Properties} objects.
 *
 * 
For system properties and {@link java.util.Properties} objects, {@link
 * io.opentelemetry.sdk.trace.export.SimpleSpanProcessor} will look for the following names:
 *
 * 

 *   {@code otel.ssp.export.sampled}: sets whether only sampled spans should be exported.
 * 
 *
 * For environment variables, {@link io.opentelemetry.sdk.trace.export.SimpleSpanProcessor} will
 * look for the following names:
 *
 * 

 *   {@code OTEL_SSP_EXPORT_SAMPLED}: sets whether only sampled spans should be exported.
 * 
 *
 * Default values for {@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor}
 *
 * 
 *   {@code SCHEDULE_DELAY_MILLIS: 5000}
 *   
{@code MAX_QUEUE_SIZE: 2048}
 *   
{@code MAX_EXPORT_BATCH_SIZE: 512}
 *   
{@code EXPORT_TIMEOUT_MILLIS: 30_000}
 *   
{@code REPORT_ONLY_SAMPLED: true}
 * 
 *
 * Configuration options for {@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor} can be
 * read from system properties, environment variables, or {@link java.util.Properties} objects.
 *
 * 
For system properties and {@link java.util.Properties} objects, {@link
 * io.opentelemetry.sdk.trace.export.BatchSpanProcessor} will look for the following names:
 *
 * 

 *   {@code otel.bsp.schedule.delay}: sets the delay interval between two consecutive exports.
 *   
{@code otel.bsp.max.queue}: sets the maximum queue size.
 *   
{@code otel.bsp.max.export.batch}: sets the maximum batch size.
 *   
{@code otel.bsp.export.timeout}: sets the maximum allowed time to export data.
 *   
{@code otel.bsp.export.sampled}: sets whether only sampled spans should be exported.
 * 
 *
 * For environment variables, {@link io.opentelemetry.sdk.trace.export.BatchSpanProcessor} will
 * look for the following names:
 *
 * 

 *   {@code OTEL_BSP_SCHEDULE_DELAY}: sets the delay interval between two consecutive exports.
 *   
{@code OTEL_BSP_MAX_QUEUE}: sets the maximum queue size.
 *   
{@code OTEL_BSP_MAX_EXPORT_BATCH}: sets the maximum batch size.
 *   
{@code OTEL_BSP_EXPORT_TIMEOUT}: sets the maximum allowed time to export data.
 *   
{@code OTEL_BSP_EXPORT_SAMPLED}: sets whether only sampled spans should be exported.
 * 
 */
package io.opentelemetry.sdk.trace.export;