Skip to content

Commit

Permalink
Clarify API section of binary logging doc
Browse files Browse the repository at this point in the history
  • Loading branch information
murgatroid99 committed Feb 16, 2016
1 parent 18c4a53 commit 3c49ade
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion doc/binary-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,14 @@ The log format is described in [this proto file](src/proto/grpc/binary_log/v1alp

## API

The binary logger will be a separate library from gRPC, in each language that we support. The user will need to explicitly call into the library to generate logs. The following API is an example of what it will approximately look like in C++:
The binary logger will be a separate library from gRPC, in each language that we support. The user will need to explicitly call into the library to generate logs. The library will provide the ability to log sending or receiving, as relevant, the following on both the client and the server:

- Initial metadata
- Messages
- Status with trailing metadata from the server
- Additional key/value pairs that are associated with a call but not sent over the wire

The following is an example of what such an API could look like in C++:

```c++
// The context provides the method_name, deadline, peer, and metadata contents.
Expand Down

0 comments on commit 3c49ade

Please sign in to comment.