Skip to content

Commit 53955e3

Browse files
pavolloffaypavolloffay
authored
Collect Zipkin v2 json (#518)
* Collect Zipkin v2 json Signed-off-by: Pavol Loffay <ploffay@redhat.com> * fix make Signed-off-by: Pavol Loffay <ploffay@redhat.com> * remove submodule Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Trasform messaging spans Signed-off-by: Pavol Loffay <ploffay@redhat.com> * http handler tests Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Fix review comments Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Preallocate spans slice Signed-off-by: Pavol Loffay <ploffay@redhat.com>
1 parent 6897ca2 commit 53955e3

25 files changed

+2076
-43
lines changed

‎Makefile

+12-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
PROJECT_ROOT=github.com/jaegertracing/jaeger
2-
TOP_PKGS := $(shell glide novendor | grep -v -e ./thrift-gen/... -e ./examples/... -e ./scripts/...)
2+
TOP_PKGS := $(shell glide novendor | grep -v -e ./thrift-gen/... -e swagger-gen... -e ./examples/... -e ./scripts/...)
33

44
# all .go files that don't exist in hidden directories
5-
ALL_SRC := $(shell find . -name "*.go" | grep -v -e vendor -e thrift-gen \
5+
ALL_SRC := $(shell find . -name "*.go" | grep -v -e vendor -e thrift-gen -e swagger-gen \
66
-e ".*/\..*" \
77
-e ".*/_.*" \
88
-e ".*/mocks.*")
@@ -34,6 +34,11 @@ THRIFT_GO_ARGS=thrift_import="github.com/apache/thrift/lib/go/thrift"
3434
THRIFT_GEN=$(shell which thrift-gen)
3535
THRIFT_GEN_DIR=thrift-gen
3636

37+
SWAGGER_VER=0.12.0
38+
SWAGGER_IMAGE=quay.io/goswagger/swagger:$(SWAGGER_VER)
39+
SWAGGER=docker run --rm -it -u ${shell id -u} -v "${PWD}:/go/src/${PROJECT_ROOT}" -w /go/src/${PROJECT_ROOT} $(SWAGGER_IMAGE)
40+
SWAGGER_GEN_DIR=swagger-gen
41+
3742
PASS=$(shell printf "\033[32mPASS\033[0m")
3843
FAIL=$(shell printf "\033[31mFAIL\033[0m")
3944
COLORIZE=$(SED) ''/PASS/s//$(PASS)/'' | $(SED) ''/FAIL/s//$(FAIL)/''
@@ -219,6 +224,11 @@ idl-submodule:
219224
thrift-image:
220225
$(THRIFT) -version
221226

227+
.PHONY: generate-zipkin-swagger
228+
generate-zipkin-swagger: idl-submodule
229+
$(SWAGGER) generate server -f ./idl/swagger/zipkin2-api.yaml -t $(SWAGGER_GEN_DIR) -O PostSpans --exclude-main
230+
rm $(SWAGGER_GEN_DIR)/restapi/operations/post_spans_urlbuilder.go $(SWAGGER_GEN_DIR)/restapi/server.go $(SWAGGER_GEN_DIR)/restapi/configure_zipkin.go $(SWAGGER_GEN_DIR)/models/trace.go $(SWAGGER_GEN_DIR)/models/list_of_traces.go $(SWAGGER_GEN_DIR)/models/dependency_link.go
231+
222232
.PHONY: docs
223233
docs: $(MKDOCS_VIRTUAL_ENV)
224234
bash -c 'source $(MKDOCS_VIRTUAL_ENV)/bin/activate; mkdocs serve'

‎cmd/collector/app/zipkin/fixtures/zipkin_01.json

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[
2+
{
3+
"traceId":"1",
4+
"id":"2",
5+
"parentId": "1",
6+
"name":"foo",
7+
"kind": "CLIENT",
8+
"debug": true,
9+
"shared": true,
10+
"timestamp": 1,
11+
"duration": 10,
12+
"localEndpoint":{
13+
"serviceName":"foo",
14+
"ipv4":"10.43.17.42"
15+
},
16+
"remoteEndpoint":{
17+
"serviceName":"bar",
18+
"ipv4":"10.43.17.43"
19+
},
20+
"annotations": [{
21+
"value": "foo",
22+
"timestamp": 1
23+
}],
24+
"tags": {
25+
"foo": "bar"
26+
}
27+
}
28+
]

‎cmd/collector/app/zipkin/http_handler.go

+81-7
Original file line numberDiff line numberDiff line change
@@ -17,44 +17,54 @@ package zipkin
1717
import (
1818
"compress/gzip"
1919
"fmt"
20+
"io"
2021
"io/ioutil"
2122
"net/http"
2223
"strings"
2324
"time"
2425

2526
"github.com/apache/thrift/lib/go/thrift"
27+
"github.com/go-openapi/loads"
28+
"github.com/go-openapi/strfmt"
29+
"github.com/go-openapi/swag"
2630
"github.com/gorilla/mux"
2731
tchanThrift "github.com/uber/tchannel-go/thrift"
2832

2933
"github.com/jaegertracing/jaeger/cmd/collector/app"
34+
"github.com/jaegertracing/jaeger/swagger-gen/models"
35+
"github.com/jaegertracing/jaeger/swagger-gen/restapi"
36+
"github.com/jaegertracing/jaeger/swagger-gen/restapi/operations"
3037
"github.com/jaegertracing/jaeger/thrift-gen/zipkincore"
3138
)
3239

3340
// APIHandler handles all HTTP calls to the collector
3441
type APIHandler struct {
3542
zipkinSpansHandler app.ZipkinSpansHandler
43+
zipkinV2Formats strfmt.Registry
3644
}
3745

3846
// NewAPIHandler returns a new APIHandler
3947
func NewAPIHandler(
4048
zipkinSpansHandler app.ZipkinSpansHandler,
4149
) *APIHandler {
50+
swaggerSpec, _ := loads.Analyzed(restapi.SwaggerJSON, "")
4251
return &APIHandler{
4352
zipkinSpansHandler: zipkinSpansHandler,
53+
zipkinV2Formats: operations.NewZipkinAPI(swaggerSpec).Formats(),
4454
}
4555
}
4656

4757
// RegisterRoutes registers Zipkin routes
4858
func (aH *APIHandler) RegisterRoutes(router *mux.Router) {
4959
router.HandleFunc("/api/v1/spans", aH.saveSpans).Methods(http.MethodPost)
60+
router.HandleFunc("/api/v2/spans", aH.saveSpansV2).Methods(http.MethodPost)
5061
}
5162

5263
func (aH *APIHandler) saveSpans(w http.ResponseWriter, r *http.Request) {
5364
bRead := r.Body
5465
defer r.Body.Close()
55-
5666
if strings.Contains(r.Header.Get("Content-Encoding"), "gzip") {
57-
gz, err := gzip.NewReader(r.Body)
67+
gz, err := gunzip(bRead)
5868
if err != nil {
5969
http.Error(w, fmt.Sprintf(app.UnableToReadBodyErrFormat, err), http.StatusBadRequest)
6070
return
@@ -84,15 +94,79 @@ func (aH *APIHandler) saveSpans(w http.ResponseWriter, r *http.Request) {
8494
return
8595
}
8696

87-
if len(tSpans) > 0 {
88-
ctx, _ := tchanThrift.NewContext(time.Minute)
89-
if _, err = aH.zipkinSpansHandler.SubmitZipkinBatch(ctx, tSpans); err != nil {
90-
http.Error(w, fmt.Sprintf("Cannot submit Zipkin batch: %v", err), http.StatusInternalServerError)
97+
if err := aH.saveThriftSpans(tSpans); err != nil {
98+
http.Error(w, fmt.Sprintf("Cannot submit Zipkin batch: %v", err), http.StatusInternalServerError)
99+
return
100+
}
101+
102+
w.WriteHeader(http.StatusAccepted)
103+
}
104+
105+
func (aH *APIHandler) saveSpansV2(w http.ResponseWriter, r *http.Request) {
106+
bRead := r.Body
107+
defer r.Body.Close()
108+
if strings.Contains(r.Header.Get("Content-Encoding"), "gzip") {
109+
gz, err := gunzip(bRead)
110+
if err != nil {
111+
http.Error(w, fmt.Sprintf(app.UnableToReadBodyErrFormat, err), http.StatusBadRequest)
91112
return
92113
}
114+
defer gz.Close()
115+
bRead = gz
93116
}
94117

95-
w.WriteHeader(http.StatusAccepted)
118+
bodyBytes, err := ioutil.ReadAll(bRead)
119+
if err != nil {
120+
http.Error(w, fmt.Sprintf(app.UnableToReadBodyErrFormat, err), http.StatusInternalServerError)
121+
return
122+
}
123+
124+
contentType := r.Header.Get("Content-Type")
125+
if contentType != "application/json" {
126+
http.Error(w, "Unsupported Content-Type", http.StatusBadRequest)
127+
return
128+
}
129+
130+
var spans models.ListOfSpans
131+
if err = swag.ReadJSON(bodyBytes, &spans); err != nil {
132+
http.Error(w, fmt.Sprintf(app.UnableToReadBodyErrFormat, err), http.StatusBadRequest)
133+
return
134+
}
135+
if err = spans.Validate(aH.zipkinV2Formats); err != nil {
136+
http.Error(w, fmt.Sprintf(app.UnableToReadBodyErrFormat, err), http.StatusBadRequest)
137+
return
138+
}
139+
140+
tSpans, err := spansV2ToThrift(spans)
141+
if err != nil {
142+
http.Error(w, fmt.Sprintf(app.UnableToReadBodyErrFormat, err), http.StatusBadRequest)
143+
return
144+
}
145+
146+
if err := aH.saveThriftSpans(tSpans); err != nil {
147+
http.Error(w, fmt.Sprintf("Cannot submit Zipkin batch: %v", err), http.StatusInternalServerError)
148+
return
149+
}
150+
151+
w.WriteHeader(operations.PostSpansAcceptedCode)
152+
}
153+
154+
func gunzip(r io.ReadCloser) (*gzip.Reader, error) {
155+
gz, err := gzip.NewReader(r)
156+
if err != nil {
157+
return nil, err
158+
}
159+
return gz, nil
160+
}
161+
162+
func (aH *APIHandler) saveThriftSpans(tSpans []*zipkincore.Span) error {
163+
if len(tSpans) > 0 {
164+
ctx, _ := tchanThrift.NewContext(time.Minute)
165+
if _, err := aH.zipkinSpansHandler.SubmitZipkinBatch(ctx, tSpans); err != nil {
166+
return err
167+
}
168+
}
169+
return nil
96170
}
97171

98172
func deserializeThrift(b []byte) ([]*zipkincore.Span, error) {

‎cmd/collector/app/zipkin/http_handler_test.go

+47-11
Original file line numberDiff line numberDiff line change
@@ -103,20 +103,13 @@ func waitForSpans(t *testing.T, handler *mockZipkinHandler, expecting int) {
103103
}
104104

105105
func TestThriftFormat(t *testing.T) {
106-
server, handler := initializeTestServer(nil)
106+
server, _ := initializeTestServer(nil)
107107
defer server.Close()
108-
109108
bodyBytes := zipkinSerialize([]*zipkincore.Span{{}})
110109
statusCode, resBodyStr, err := postBytes(server.URL+`/api/v1/spans`, bodyBytes, createHeader("application/x-thrift"))
111110
assert.NoError(t, err)
112111
assert.EqualValues(t, http.StatusAccepted, statusCode)
113112
assert.EqualValues(t, "", resBodyStr)
114-
115-
handler.zipkinSpansHandler.(*mockZipkinHandler).err = fmt.Errorf("Bad times ahead")
116-
statusCode, resBodyStr, err = postBytes(server.URL+`/api/v1/spans`, bodyBytes, createHeader("application/x-thrift"))
117-
assert.NoError(t, err)
118-
assert.EqualValues(t, http.StatusInternalServerError, statusCode)
119-
assert.EqualValues(t, "Cannot submit Zipkin batch: Bad times ahead\n", resBodyStr)
120113
}
121114

122115
func TestJsonFormat(t *testing.T) {
@@ -228,9 +221,52 @@ func TestCannotReadBodyFromRequest(t *testing.T) {
228221
req, err := http.NewRequest(http.MethodPost, "whatever", &errReader{})
229222
assert.NoError(t, err)
230223
rw := dummyResponseWriter{}
231-
handler.saveSpans(&rw, req)
232-
assert.EqualValues(t, http.StatusInternalServerError, rw.myStatusCode)
233-
assert.EqualValues(t, "Unable to process request body: Simulated error reading body\n", rw.myBody)
224+
225+
tests := []struct {
226+
handler func(w http.ResponseWriter, r *http.Request)
227+
}{
228+
{handler: handler.saveSpans},
229+
{handler: handler.saveSpansV2},
230+
}
231+
for _, test := range tests {
232+
test.handler(&rw, req)
233+
assert.EqualValues(t, http.StatusInternalServerError, rw.myStatusCode)
234+
assert.EqualValues(t, "Unable to process request body: Simulated error reading body\n", rw.myBody)
235+
}
236+
}
237+
238+
func TestSaveSpansV2(t *testing.T) {
239+
server, handler := initializeTestServer(nil)
240+
defer server.Close()
241+
tests := []struct {
242+
body []byte
243+
resBody string
244+
code int
245+
headers map[string]string
246+
}{
247+
{body: []byte("[]"), code: http.StatusAccepted},
248+
{body: gzipEncode([]byte("[]")), code: http.StatusAccepted, headers: map[string]string{"Content-Encoding": "gzip"}},
249+
{body: []byte("[]"), code: http.StatusBadRequest, headers: map[string]string{"Content-Type": "text/html"}, resBody: "Unsupported Content-Type\n"},
250+
{body: []byte("[]"), code: http.StatusBadRequest, headers: map[string]string{"Content-Encoding": "gzip"}, resBody: "Unable to process request body: unexpected EOF\n"},
251+
{body: []byte("not good"), code: http.StatusBadRequest, resBody: "Unable to process request body: invalid character 'o' in literal null (expecting 'u')\n"},
252+
{body: []byte("[{}]"), code: http.StatusBadRequest, resBody: "Unable to process request body: validation failure list:\nid in body is required\ntraceId in body is required\n"},
253+
{body: []byte(`[{"id":"1111111111111111", "traceId":"1111111111111111", "localEndpoint": {"ipv4": "A"}}]`), code: http.StatusBadRequest, resBody: "Unable to process request body: wrong ipv4\n"},
254+
}
255+
for _, test := range tests {
256+
h := createHeader("application/json")
257+
for k, v := range test.headers {
258+
h.Set(k, v)
259+
}
260+
statusCode, resBody, err := postBytes(server.URL+`/api/v2/spans`, test.body, h)
261+
require.NoError(t, err)
262+
assert.EqualValues(t, test.code, statusCode)
263+
assert.EqualValues(t, test.resBody, resBody)
264+
}
265+
handler.zipkinSpansHandler.(*mockZipkinHandler).err = fmt.Errorf("Bad times ahead")
266+
statusCode, resBody, err := postBytes(server.URL+`/api/v2/spans`, []byte(`[{"id":"1111111111111111", "traceId":"1111111111111111"}]`), createHeader("application/json"))
267+
require.NoError(t, err)
268+
assert.EqualValues(t, http.StatusInternalServerError, statusCode)
269+
assert.EqualValues(t, "Cannot submit Zipkin batch: Bad times ahead\n", resBody)
234270
}
235271

236272
type errReader struct{}

‎cmd/collector/app/zipkin/json.go

+16-10
Original file line numberDiff line numberDiff line change
@@ -153,29 +153,35 @@ func cutLongID(id string) string {
153153
}
154154

155155
func endpointToThrift(e endpoint) (*zipkincore.Endpoint, error) {
156-
ipv4, err := parseIpv4(e.IPv4)
156+
return eToThrift(e.IPv4, e.IPv6, e.Port, e.ServiceName)
157+
}
158+
159+
func eToThrift(ip4 string, ip6 string, p int32, service string) (*zipkincore.Endpoint, error) {
160+
ipv4, err := parseIpv4(ip4)
157161
if err != nil {
158162
return nil, err
159163
}
160-
port := e.Port
161-
if port >= (1 << 15) {
162-
// Zipkin.thrift defines port as i16, so values between (2^15 and 2^16-1) must be encoded as negative
163-
port = port - (1 << 16)
164-
}
165-
166-
ipv6, err := parseIpv6(e.IPv6)
164+
port := port(p)
165+
ipv6, err := parseIpv6(string(ip6))
167166
if err != nil {
168167
return nil, err
169168
}
170-
171169
return &zipkincore.Endpoint{
172-
ServiceName: e.ServiceName,
170+
ServiceName: service,
173171
Port: int16(port),
174172
Ipv4: ipv4,
175173
Ipv6: ipv6,
176174
}, nil
177175
}
178176

177+
func port(p int32) int32 {
178+
if p >= (1 << 15) {
179+
// Zipkin.thrift defines port as i16, so values between (2^15 and 2^16-1) must be encoded as negative
180+
p = p - (1 << 16)
181+
}
182+
return p
183+
}
184+
179185
func annoToThrift(a annotation) (*zipkincore.Annotation, error) {
180186
endpoint, err := endpointToThrift(a.Endpoint)
181187
if err != nil {

0 commit comments

Comments
 (0)