This repository has been archived by the owner on Oct 3, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation about namespac and package. (#5)
* Add documentation about namespac and package. * Add link to RFC * Update slightly the text for URL model.
- Loading branch information
Bogdan Drutu
committed
Sep 14, 2017
1 parent
8e5cec8
commit 2c805c0
Showing
3 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Namespace and Package names | ||
|
||
## Introduction | ||
This document describes the key package names (namespaces, etc.). This document uses terminology | ||
(MUST, SHOULD, etc) from [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt). | ||
|
||
## Structure | ||
The top level package name MUST be **opencensus** (for URL model MUST use **io.opencensus**). | ||
|
||
The second level package names MUST be: | ||
* **stats**: for all measurement related functionality | ||
* **tags**: for all tagging related functionality | ||
* **context**: for all context related functionality | ||
* **trace**: for all trace functionality | ||
* **common**: for all public API components that are shared across multiple of the above. These are | ||
typically utility classes such as timestamps, etc. | ||
* **internal**: If required, "internal" subdirectories/names of each of the above SHOULD be used | ||
for all internal API components. e.g. common internal can have utility classes such as providers, | ||
string manipulation, etc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,14 @@ | ||
# OpenCensus Specs | ||
|
||
## General Design | ||
* For details about the library structured see [Namespace and Package](https://github.com/census-instrumentation/opencensus-specs/blob/master/NamespaceAndPackage.md) | ||
|
||
## Trace Design | ||
* Data model is defined [here](https://github.com/census-instrumentation/opencensus-proto/blob/master/trace/trace.proto) | ||
|
||
## Tags Design | ||
|
||
## Stats Design | ||
|
||
## Supported Encodings | ||
* Binary encoding is defined [here](https://github.com/census-instrumentation/opencensus-specs/blob/master/encodings/BinaryEncoding.md) |