aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/binary-logging.md
diff options
context:
space:
mode:
authorGravatar murgatroid99 <mlumish@google.com>2016-02-16 14:11:56 -0800
committerGravatar murgatroid99 <mlumish@google.com>2016-02-16 14:11:56 -0800
commit3c49ade48500758abcd0e701a0c7c674356e889e (patch)
treed868603f2d9f563aa578c96f7c663ace007478cd /doc/binary-logging.md
parent18c4a532d564e1e38c458c2b400160a2a0a38f68 (diff)
Clarify API section of binary logging doc
Diffstat (limited to 'doc/binary-logging.md')
-rw-r--r--doc/binary-logging.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/binary-logging.md b/doc/binary-logging.md
index 84fd991411..69020d9828 100644
--- a/doc/binary-logging.md
+++ b/doc/binary-logging.md
@@ -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.