aboutsummaryrefslogtreecommitdiff
path: root/api/src/main/java/io/opencensus/metrics/package-info.java
diff options
context:
space:
mode:
authorYang Song <songy23@users.noreply.github.com>2018-09-14 15:45:30 -0700
committerGitHub <noreply@github.com>2018-09-14 15:45:30 -0700
commit937d2296642d9bcdae23a2be469d1d0f367ae3de (patch)
tree452b70aefb0a257f4373574a936ffa189f1e23c8 /api/src/main/java/io/opencensus/metrics/package-info.java
parent98fb8ad4e40b67b92d8688f45dbd8ac41399d8d7 (diff)
downloadopencensus-java-937d2296642d9bcdae23a2be469d1d0f367ae3de.tar.gz
Revert "Temporarily move "metrics" package into impl_core/ for release. (#1426)" (#1432)
This reverts commit d3fa0e5c60903f95c184d7c7bafae8fdd12156ad.
Diffstat (limited to 'api/src/main/java/io/opencensus/metrics/package-info.java')
-rw-r--r--api/src/main/java/io/opencensus/metrics/package-info.java32
1 files changed, 32 insertions, 0 deletions
diff --git a/api/src/main/java/io/opencensus/metrics/package-info.java b/api/src/main/java/io/opencensus/metrics/package-info.java
new file mode 100644
index 00000000..33eadf0c
--- /dev/null
+++ b/api/src/main/java/io/opencensus/metrics/package-info.java
@@ -0,0 +1,32 @@
+/*
+ * 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.
+ */
+
+/**
+ * This package describes the Metrics data model. Metrics are a data model for what stats exporters
+ * take as input. This data model may eventually become the wire format for metrics.
+ *
+ * <p>WARNING: Currently all the public classes under this package are marked as {@link
+ * io.opencensus.common.ExperimentalApi}. The classes and APIs under {@link io.opencensus.metrics}
+ * are likely to get backwards-incompatible updates in the future. DO NOT USE except for
+ * experimental purposes.
+ *
+ * <p>Please see
+ * https://github.com/census-instrumentation/opencensus-specs/blob/master/stats/Metrics.md and
+ * https://github.com/census-instrumentation/opencensus-proto/blob/master/opencensus/proto/stats/metrics/metrics.proto
+ * for more details.
+ */
+@io.opencensus.common.ExperimentalApi
+package io.opencensus.metrics;