From 140002c944931ebc0e8e1ea6f7dca128108cf4e7 Mon Sep 17 00:00:00 2001 From: zhang-wei Date: Wed, 17 Jun 2020 21:40:12 +0800 Subject: [PATCH] Add missing documentation (#63) --- README.md | 10 ++++------ docs/GRPC-Reporter-Option.md | 1 + 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b9a85d6..c998a3e 100644 --- a/README.md +++ b/README.md @@ -83,14 +83,13 @@ will inject the context generated by its parent. ```go //Create a new context -entrySpan, entryCtx, err := h.tracer.CreateEntrySpan(context.Background(), ...) +entrySpan, entryCtx, err := tracer.CreateEntrySpan(context.Background(), ...) // Some operation ... // Link two spans by injecting entrySpan context into exitSpan -exitSpan, err := t.tracer.CreateExitSpan(entryCtx, ...) - +exitSpan, err := tracer.CreateExitSpan(entryCtx, ...) ``` ### Crossing process @@ -102,7 +101,7 @@ upstream service. ```go //Extract context from HTTP request header `sw8` -span, ctx, err := h.tracer.CreateEntrySpan(r.Context(), "/api/login", func() (string, error) { +span, ctx, err := tracer.CreateEntrySpan(r.Context(), "/api/login", func() (string, error) { return r.Header.Get("sw8"), nil }) @@ -110,11 +109,10 @@ span, ctx, err := h.tracer.CreateEntrySpan(r.Context(), "/api/login", func() (st ... // Inject context into HTTP request header `sw8` -span, err := t.tracer.CreateExitSpan(req.Context(), "/service/validate", "tomcat-service:8080", func(header string) error { +span, err := tracer.CreateExitSpan(req.Context(), "/service/validate", "tomcat-service:8080", func(header string) error { req.Header.Set(propagation.Header, header) return nil }) - ``` ## Tag diff --git a/docs/GRPC-Reporter-Option.md b/docs/GRPC-Reporter-Option.md index a278128..017e9ff 100644 --- a/docs/GRPC-Reporter-Option.md +++ b/docs/GRPC-Reporter-Option.md @@ -6,6 +6,7 @@ | ---------- | --- | | `reporter.WithLogger` | setup logger for gRPC reporter | | `reporter.WithCheckInterval` | setup service and endpoint registry check interval | +| `reporter.WithMaxSendQueueSize` | setup send span queue buffer length | | `reporter.WithInstanceProps` | setup service instance properties eg: org=SkyAPM | | `reporter.WithTransportCredentials` | setup transport layer security | | `reporter.WithAuthentication` | used Authentication for gRPC | \ No newline at end of file