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

Commit ca31878

Browse files
authored
Encodings: Add readme. (#245)
1 parent f7b3715 commit ca31878

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

encodings/BinaryEncoding.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,3 @@ https://developers.google.com/protocol-buffers/docs/encoding#varints.
144144
example, a serialized tag context with 10,000 small tags that all have the
145145
same key should be considered too large.
146146

147-
## Related Work
148-
* [TraceContext Project](https://github.com/TraceContext/tracecontext-spec)
149-
* [Stackdriver TraceContext Header](https://cloud.google.com/trace/docs/support)
150-
* [B3 TraceContext Header](https://github.com/openzipkin/b3-propagation)

encodings/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# OpenCensus Library Encoding Package
2+
This documentation serves to document the on-the-wire encoding format supported in
3+
OpenCensus. It describes the key types and the overall behavior.
4+
5+
## Formats
6+
* [Binary Encoding](BinaryEncoding.md)
7+
* [TraceContext Binary Encoding](BinaryEncoding.md#trace-context)
8+
* [TagContext Binary Encoding](BinaryEncoding.md#tag-context)
9+
* [Census Server Stats Encoding](CensusServerStatsEncoding.md)
10+
11+
* HTTP Encoding
12+
* [W3C TraceContext](https://github.com/TraceContext/tracecontext-spec)
13+
* [W3C Correlation Context](https://github.com/w3c/correlation-context)
14+
* [Stackdriver TraceContext Header](https://cloud.google.com/trace/docs/support)
15+
* [B3 TraceContext Header](https://github.com/openzipkin/b3-propagation)

0 commit comments

Comments
 (0)