1 // Copyright 2017, OpenCensus Authors
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
16 // Package view contains support for collecting and exposing aggregates over stats.
18 // In order to collect measurements, views need to be defined and registered.
19 // A view allows recorded measurements to be filtered and aggregated.
21 // All recorded measurements can be grouped by a list of tags.
23 // OpenCensus provides several aggregation methods: Count, Distribution and Sum.
25 // Count only counts the number of measurement points recorded.
26 // Distribution provides statistical summary of the aggregated data by counting
27 // how many recorded measurements fall into each bucket.
28 // Sum adds up the measurement values.
29 // LastValue just keeps track of the most recently recorded measurement value.
30 // All aggregations are cumulative.
32 // Views can be registerd and unregistered at any time during program execution.
34 // Libraries can define views but it is recommended that in most cases registering
35 // views be left up to applications.
39 // Collected and aggregated data can be exported to a metric collection
40 // backend by registering its exporter.
42 // Multiple exporters can be registered to upload the data to various
43 // different back ends.
44 package view // import "go.opencensus.io/stats/view"
46 // TODO(acetechnologist): Add a link to the language independent OpenCensus
47 // spec when it is available.