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  * This package describes the Metrics data model. Metrics are a data model for what stats exporters
19  * take as input. This data model may eventually become the wire format for metrics.
20  *
21  * <p>WARNING: Currently all the public classes under this package are marked as {@link
22  * io.opencensus.common.ExperimentalApi}. The classes and APIs under {@link io.opencensus.metrics}
23  * are likely to get backwards-incompatible updates in the future. DO NOT USE except for
24  * experimental purposes.
25  *
26  * <p>Please see
27  * https://github.com/census-instrumentation/opencensus-specs/blob/master/stats/Metrics.md and
28  * https://github.com/census-instrumentation/opencensus-proto/blob/master/opencensus/proto/stats/metrics/metrics.proto
29  * for more details.
30  */
31 @io.opencensus.common.ExperimentalApi
32 package io.opencensus.metrics;
33