Include a simple usage example

opentracing · Sep 3, 2016 · 3af5d8d · 3af5d8d
1 parent 2e2cb0e
commit 3af5d8d
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/src/span.js b/src/span.js
@@ -173,6 +173,19 @@ export default class Span {
     /**
      * Add a log record to this Span, optionally at a user-provided timestamp.
      *
+     * For example:
+     *
+     *     span.log({
+     *         size: rpc.size(),  // numeric value
+     *         URI: rpc.URI(),  // string value
+     *         payload: rpc.payload(),  // Object value
+     *         "keys can be arbitrary strings": rpc.foo(),
+     *     });
+     *
+     *     span.log({
+     *         "error.description": error.description(),  // numeric value
+     *     }, error.timestampMillis());
+     *
      * @param {object} keyValuePairs
      *        An object mapping string keys to arbitrary value types. All
      *        Tracer implementations should support bool, string, and numeric