Skip to content
This repository was archived by the owner on Jul 31, 2023. It is now read-only.

Commit e5d36d6

Browse files
author
Ian Sturdy
authored
Add a readme for stats pointing to the top-level headers. (#122)
1 parent e281389 commit e5d36d6

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

opencensus/stats/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Stats API
2+
3+
The primary stats API documentation is in the headers in `opencensus/stats`.
4+
See the following classes and headers for the top-level interfaces:
5+
6+
### Recording data
7+
- A [`Measure`](measure.h) specifyies the resources against which data is
8+
recorded.
9+
- [`recording.h`](recording.h) defines the recording function.
10+
11+
### Accessing data
12+
- A [`ViewDescriptor`](view_descriptor.h) defines what data a view collects,
13+
and provides an interface for registering it for export.
14+
- A [`View`](view.h) provides a handle for accessing data for a view within the
15+
task.

0 commit comments

Comments
 (0)