diff options
author | Bogdan Drutu <bdrutu@google.com> | 2018-06-08 13:05:49 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-06-08 13:05:49 -0700 |
commit | 54198be41c52238977b24bd76eee3da2abf43b96 (patch) | |
tree | ac67b59489e86debfaec1e2bb969a6a3156f64f1 | |
parent | f655b9175c1829c42327f7b53464295426b7185f (diff) | |
download | opencensus-java-54198be41c52238977b24bd76eee3da2abf43b96.tar.gz |
Add package-info for all main packages in opencensus-api. (#1245)
* Add package-info for all main packages in opencensus-api.
* Fix format.
3 files changed, 71 insertions, 0 deletions
diff --git a/api/src/main/java/io/opencensus/common/package-info.java b/api/src/main/java/io/opencensus/common/package-info.java new file mode 100644 index 00000000..1ebfd7cf --- /dev/null +++ b/api/src/main/java/io/opencensus/common/package-info.java @@ -0,0 +1,18 @@ +/* + * Copyright 2018, OpenCensus 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. + */ + +/** Common API between different packages in this artifact. */ +package io.opencensus.common; diff --git a/api/src/main/java/io/opencensus/stats/package-info.java b/api/src/main/java/io/opencensus/stats/package-info.java new file mode 100644 index 00000000..981daa0e --- /dev/null +++ b/api/src/main/java/io/opencensus/stats/package-info.java @@ -0,0 +1,20 @@ +/* + * Copyright 2018, OpenCensus 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. + */ + +/** API for stats recording. */ +// TODO: Add more details. +// TODO: Add code examples. +package io.opencensus.stats; diff --git a/api/src/main/java/io/opencensus/trace/package-info.java b/api/src/main/java/io/opencensus/trace/package-info.java new file mode 100644 index 00000000..77f39aba --- /dev/null +++ b/api/src/main/java/io/opencensus/trace/package-info.java @@ -0,0 +1,33 @@ +/* + * Copyright 2018, OpenCensus 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. + */ + +/** + * API for distributed tracing. + * + * <p>Distributed tracing, also called distributed request tracing, is a technique that helps + * debugging distributed applications. + * + * <p>Trace represents a tree of spans. A trace has a root span that encapsulates all the spans from + * start to end, and the children spans being the distinct calls invoked in between. + * + * <p>{@link io.opencensus.trace.Span} represents a single operation within a trace. + * + * <p>{@link io.opencensus.trace.Span Spans} are propagated in-process in the {@code + * io.grpc.Context} and between process using one of the wire propagation formats supported in the + * {@code io.opencensus.trace.propagation} package. + */ +// TODO: Add code examples. +package io.opencensus.trace; |