Skip to content
This repository has been archived by the owner on Oct 3, 2023. It is now read-only.

Commit

Permalink
Add documentation about namespac and package. (#5)
Browse files Browse the repository at this point in the history
* 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
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .gitignore
@@ -1,3 +1,17 @@
# IntelliJ IDEA
.idea
*.iml

# Eclipse
.classpath
.project
.settings
bin

# NetBeans
/.nb-gradle
/.nb-gradle-properties

# OS X
.DS_Store

Expand Down
19 changes: 19 additions & 0 deletions NamespaceAndPackage.md
@@ -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.
13 changes: 13 additions & 0 deletions README.md
@@ -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)

0 comments on commit 2c805c0

Please sign in to comment.