aboutsummaryrefslogtreecommitdiffstats
path: root/metrics/src
diff options
context:
space:
mode:
authorYang Song <songy23@users.noreply.github.com>2018-06-05 17:08:43 -0700
committerGitHub <noreply@github.com>2018-06-05 17:08:43 -0700
commit4f1b11a7573c30fabfaa1a90244da7b8604dba61 (patch)
tree89a1d82e2e54e49a8962f11742b3b08de6b06347 /metrics/src
parenteaa577023bacf8b7d9404d9c95d40b15d19f4e5a (diff)
downloadplatform_external_opencensus-java-4f1b11a7573c30fabfaa1a90244da7b8604dba61.tar.gz
platform_external_opencensus-java-4f1b11a7573c30fabfaa1a90244da7b8604dba61.tar.bz2
platform_external_opencensus-java-4f1b11a7573c30fabfaa1a90244da7b8604dba61.zip
Metrics: Move Metrics to a separate artifact. (#1216)
* Move Metrics to a separate artifact. * Fix review comments. * Update one TODO about the naming of the artifact.
Diffstat (limited to 'metrics/src')
-rw-r--r--metrics/src/main/java/io/opencensus/metrics/package-info.java31
1 files changed, 31 insertions, 0 deletions
diff --git a/metrics/src/main/java/io/opencensus/metrics/package-info.java b/metrics/src/main/java/io/opencensus/metrics/package-info.java
new file mode 100644
index 00000000..f48e3712
--- /dev/null
+++ b/metrics/src/main/java/io/opencensus/metrics/package-info.java
@@ -0,0 +1,31 @@
+/*
+ * 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.
+ *
+ * <p>Currently all the public classes under this package are marked as {@link
+ * io.opencensus.common.ExperimentalApi}. This data model may eventually become the wire format for
+ * metrics.
+ *
+ * <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;