diff --git a/.gitignore b/.gitignore index 0898940..5655275 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,17 @@ +# IntelliJ IDEA +.idea +*.iml + +# Eclipse +.classpath +.project +.settings +bin + +# NetBeans +/.nb-gradle +/.nb-gradle-properties + # OS X .DS_Store diff --git a/NamespaceAndPackage.md b/NamespaceAndPackage.md new file mode 100644 index 0000000..1b38e70 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/README.md b/README.md index 42e1ff6..53b17f2 100644 --- a/README.md +++ b/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)