io.opentelemetry.sdk.trace.config.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.
 */

/**
 * Classes that holds global trace parameters
 *
 * Contents
 *
 * 
 *   {@link io.opentelemetry.sdk.trace.config.TraceConfig}
 * 
 *
 * Default values for {@link io.opentelemetry.sdk.trace.config.TraceConfig}
 *
 * 
 *   {@code SAMPLER: Samplers.alwaysOn()}
 *   
{@code SPAN_MAX_NUM_ATTRIBUTES: 32}
 *   
{@code SPAN_MAX_NUM_EVENTS: 128}
 *   
{@code SPAN_MAX_NUM_LINKS: 32}
 *   
{@code SPAN_MAX_NUM_ATTRIBUTES_PER_EVENT: 32}
 *   
{@code SPAN_MAX_NUM_ATTRIBUTES_PER_LINK: 32}
 * 
 *
 * Configuration options for {@link io.opentelemetry.sdk.trace.config.TraceConfig} 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.config.TraceConfig} will look for the following names:
 *
 * 

 *   {@code otel.config.sampler.probability}: to set the global default sampler which is used
 *       when constructing a new {@code Span}.
 *   
{@code otel.config.max.attrs}: to set the global default max number of attributes per
 *       {@link io.opentelemetry.trace.Span}.
 *   
{@code otel.config.max.events}: to set the global default max number of {@link
 *       io.opentelemetry.trace.Event}s per {@link io.opentelemetry.trace.Span}.
 *   
{@code otel.config.max.links}: to set the global default max number of {@link
 *       io.opentelemetry.trace.Link} entries per {@link io.opentelemetry.trace.Span}.
 *   
{@code otel.config.max.event.attrs}: to set the global default max number of attributes per
 *       {@link io.opentelemetry.trace.Event}.
 *   
{@code otel.config.max.link.attrs}: to set the global default max number of attributes per
 *       {@link io.opentelemetry.trace.Link}.
 * 
 *
 * For environment variable, {@link io.opentelemetry.sdk.trace.config.TraceConfig} will look for
 * the following names:
 *
 * 

 *   {@code OTEL_CONFIG_SAMPLER_PROBABILITY}: to set the global default sampler which is used
 *       when constructing a new {@code Span}.
 *   
{@code OTEL_CONFIG_MAX_ATTRS}: to set the global default max number of attributes per
 *       {@link io.opentelemetry.trace.Span}.
 *   
{@code OTEL_CONFIG_MAX_EVENTS}: to set the global default max number of {@link
 *       io.opentelemetry.trace.Event}s per {@link io.opentelemetry.trace.Span}.
 *   
{@code OTEL_CONFIG_MAX_LINKS}: to set the global default max number of {@link
 *       io.opentelemetry.trace.Link} entries per {@link io.opentelemetry.trace.Span}.
 *   
{@code OTEL_CONFIG_MAX_EVENT_ATTRS}: to set the global default max number of attributes per
 *       {@link io.opentelemetry.trace.Event}.
 *   
{@code OTEL_CONFIG_MAX_LINK_ATTRS}: to set the global default max number of attributes per
 *       {@link io.opentelemetry.trace.Link}.
 * 
 */
package io.opentelemetry.sdk.trace.config;