Skip to content
This repository was archived by the owner on Jun 14, 2023. It is now read-only.

Commit 140002c

Browse files
authored
Add missing documentation (#63)
1 parent e61c0b1 commit 140002c

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

README.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,13 @@ will inject the context generated by its parent.
8383

8484
```go
8585
//Create a new context
86-
entrySpan, entryCtx, err := h.tracer.CreateEntrySpan(context.Background(), ...)
86+
entrySpan, entryCtx, err := tracer.CreateEntrySpan(context.Background(), ...)
8787

8888
// Some operation
8989
...
9090

9191
// Link two spans by injecting entrySpan context into exitSpan
92-
exitSpan, err := t.tracer.CreateExitSpan(entryCtx, ...)
93-
92+
exitSpan, err := tracer.CreateExitSpan(entryCtx, ...)
9493
```
9594

9695
### Crossing process
@@ -102,19 +101,18 @@ upstream service.
102101

103102
```go
104103
//Extract context from HTTP request header `sw8`
105-
span, ctx, err := h.tracer.CreateEntrySpan(r.Context(), "/api/login", func() (string, error) {
104+
span, ctx, err := tracer.CreateEntrySpan(r.Context(), "/api/login", func() (string, error) {
106105
return r.Header.Get("sw8"), nil
107106
})
108107

109108
// Some operation
110109
...
111110

112111
// Inject context into HTTP request header `sw8`
113-
span, err := t.tracer.CreateExitSpan(req.Context(), "/service/validate", "tomcat-service:8080", func(header string) error {
112+
span, err := tracer.CreateExitSpan(req.Context(), "/service/validate", "tomcat-service:8080", func(header string) error {
114113
req.Header.Set(propagation.Header, header)
115114
return nil
116115
})
117-
118116
```
119117

120118
## Tag

docs/GRPC-Reporter-Option.md

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
| ---------- | --- |
77
| `reporter.WithLogger` | setup logger for gRPC reporter |
88
| `reporter.WithCheckInterval` | setup service and endpoint registry check interval |
9+
| `reporter.WithMaxSendQueueSize` | setup send span queue buffer length |
910
| `reporter.WithInstanceProps` | setup service instance properties eg: org=SkyAPM |
1011
| `reporter.WithTransportCredentials` | setup transport layer security |
1112
| `reporter.WithAuthentication` | used Authentication for gRPC |

0 commit comments

Comments
 (0)