1 /*
2  * Copyright 2018, OpenCensus Authors
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /**
18  * API for distributed tracing.
19  *
20  * <p>Distributed tracing, also called distributed request tracing, is a technique that helps
21  * debugging distributed applications.
22  *
23  * <p>Trace represents a tree of spans. A trace has a root span that encapsulates all the spans from
24  * start to end, and the children spans being the distinct calls invoked in between.
25  *
26  * <p>{@link io.opencensus.trace.Span} represents a single operation within a trace.
27  *
28  * <p>{@link io.opencensus.trace.Span Spans} are propagated in-process in the {@code
29  * io.grpc.Context} and between process using one of the wire propagation formats supported in the
30  * {@code io.opencensus.trace.propagation} package.
31  */
32 // TODO: Add code examples.
33 package io.opencensus.trace;
34