Skip to content

Commit

Permalink
Add component subheadings
Browse files Browse the repository at this point in the history
  • Loading branch information
jajanet committed Jun 25, 2020
1 parent 79509ed commit 0c049db
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions sdk/src/zpages/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,35 @@
# zPages
## Summary
zPages allow easy viewing of tracing information. When included for a process, zPages will display basic information about that process on a webpage. There are currently two types of zPages: TraceZ and RPCz. on a webpage.
zPages allow easy viewing of tracing information. When included for a process, zPages will display basic information about that process on a webpage. There are currently two types of zPages: TraceZ and RPCz.

This is useful because it's quicker to get running than adding extra code and installing external exporters.It also helps with debugging latency issues and deadlocks.

This idea originates from one of OpenTelemetry's predecessors, [OpenCensus](https://opencensus.io/). You can read more about it [here](https://opencensus.io/).
The idea of 'zPages' originates from one of OpenTelemetry's predecessors, [OpenCensus](https://opencensus.io/). You can read more about it [here](https://opencensus.io/). There has also been similar implementations and solutions at companies like Uber.

The basic flow of zPages reads from the processes spans using a SpanProcessor, which exports spans to the appropriate DataAggregator that gets information from spans to send to the HttpServer.
On a high level, zPages work by reading a processes spans using a SpanProcessor, which exports spans to the appropriate DataAggregator to then send to the HttpServer.

TODO: Add picture examples for span overview and specific span view

> TODO: Add picture examples for span overview and individual span view
### TraceZ
TraceZ is a type of zPage that shows information on tracing spans, and allows users to look closer at specific and individual spans. Details a user would view include: span id, name, status, and timestamps.
TraceZ is a type of zPage that shows information on tracing spans, and allows users to look closer at specific and individual spans. Details a user would view include span id, name, status, and timestamps. The individual components of TraceZ are as follows:

#### TracezSpanProcessor
Serving as the starting point of a zPage, SpanProcessor collects spans and provides an interface for DataAggregator.

#### TracezDataAggregator
This uses the SpanProcessor to do various functions to send spans to the HttpServer.

#### TracezHttpServer
Interactive webpages are generated and served using this, which gets information using the DataAggregator.


### RPCz
RPCz is a type of zPage that provides details on instrumented sent and received RPC messages. There is currently no ongoing development of RPCz.

# Getting Started

TODO: Add instructions to add zPages
> TODO: Add instructions to add zPages
### Links of Interest
- [TracezSpanProcessor Design Doc](https://docs.google.com/document/d/1kO4iZARYyr-EGBlY2VNM3ELU3iw6ZrC58Omup_YT-fU/edit#)
Expand Down

0 comments on commit 0c049db

Please sign in to comment.