forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
/
trace_receiver.go
229 lines (195 loc) · 6.65 KB
/
trace_receiver.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package sapmreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sapmreceiver"
import (
"bytes"
"compress/gzip"
"context"
"errors"
"fmt"
"io"
"net/http"
"sync"
"github.com/gorilla/mux"
splunksapm "github.com/signalfx/sapm-proto/gen"
"github.com/signalfx/sapm-proto/sapmprotocol"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/obsreport"
"go.opentelemetry.io/collector/receiver"
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/splunk"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/jaeger"
)
var gzipWriterPool = &sync.Pool{
New: func() interface{} {
return gzip.NewWriter(io.Discard)
},
}
// sapmReceiver receives spans in the Splunk SAPM format over HTTP
type sapmReceiver struct {
settings component.TelemetrySettings
config *Config
server *http.Server
shutdownWG sync.WaitGroup
nextConsumer consumer.Traces
// defaultResponse is a placeholder. For now this receiver returns an empty sapm response.
// This defaultResponse is an optimization so we don't have to proto.Marshal the response
// for every request. At some point this may be removed when there is actual content to return.
defaultResponse []byte
obsrecv *obsreport.Receiver
}
// handleRequest parses an http request containing sapm and passes the trace data to the next consumer
func (sr *sapmReceiver) handleRequest(req *http.Request) error {
sapm, err := sapmprotocol.ParseTraceV2Request(req)
// errors processing the request should return http.StatusBadRequest
if err != nil {
return err
}
ctx := sr.obsrecv.StartTracesOp(req.Context())
td, err := jaeger.ProtoToTraces(sapm.Batches)
if err != nil {
return err
}
if sr.config.AccessTokenPassthrough {
if accessToken := req.Header.Get(splunk.SFxAccessTokenHeader); accessToken != "" {
rSpans := td.ResourceSpans()
for i := 0; i < rSpans.Len(); i++ {
rSpan := rSpans.At(i)
attrs := rSpan.Resource().Attributes()
attrs.PutStr(splunk.SFxAccessTokenLabel, accessToken)
}
}
}
// pass the trace data to the next consumer
err = sr.nextConsumer.ConsumeTraces(ctx, td)
if err != nil {
err = fmt.Errorf("error passing trace data to next consumer: %w", err)
}
sr.obsrecv.EndTracesOp(ctx, "protobuf", td.SpanCount(), err)
return err
}
// HTTPHandlerFunc returns an http.HandlerFunc that handles SAPM requests
func (sr *sapmReceiver) HTTPHandlerFunc(rw http.ResponseWriter, req *http.Request) {
// handle the request payload
err := sr.handleRequest(req)
if err != nil {
// TODO account for this error (throttled logging or metrics)
rw.WriteHeader(http.StatusBadRequest)
return
}
// respBytes are bytes to write to the http.Response
// build the response message
// NOTE currently the response is an empty struct. As an optimization this receiver will pass a
// byte array that was generated in the receiver's constructor. If this receiver needs to return
// more than an empty struct, then the sapm.PostSpansResponse{} struct will need to be marshaled
// and on error a http.StatusInternalServerError should be written to the http.ResponseWriter and
// this function should immediately return.
var respBytes = sr.defaultResponse
rw.Header().Set(sapmprotocol.ContentTypeHeaderName, sapmprotocol.ContentTypeHeaderValue)
// write the response if client does not accept gzip encoding
if req.Header.Get(sapmprotocol.AcceptEncodingHeaderName) != sapmprotocol.GZipEncodingHeaderValue {
// write the response bytes
_, err = rw.Write(respBytes)
if err != nil {
rw.WriteHeader(http.StatusBadRequest)
}
return
}
// gzip the response
// get the gzip writer
writer := gzipWriterPool.Get().(*gzip.Writer)
defer gzipWriterPool.Put(writer)
var gzipBuffer bytes.Buffer
// reset the writer with the gzip buffer
writer.Reset(&gzipBuffer)
// gzip the responseBytes
_, err = writer.Write(respBytes)
if err != nil {
rw.WriteHeader(http.StatusInternalServerError)
return
}
// close the gzip writer and write gzip footer
err = writer.Close()
if err != nil {
rw.WriteHeader(http.StatusInternalServerError)
return
}
// write the successfully gzipped payload
rw.Header().Set(sapmprotocol.ContentEncodingHeaderName, sapmprotocol.GZipEncodingHeaderValue)
_, err = rw.Write(gzipBuffer.Bytes())
if err != nil {
rw.WriteHeader(http.StatusBadRequest)
}
}
// Start starts the sapmReceiver's server.
func (sr *sapmReceiver) Start(_ context.Context, host component.Host) error {
// server.Handler will be nil on initial call, otherwise noop.
if sr.server != nil && sr.server.Handler != nil {
return nil
}
// set up the listener
ln, err := sr.config.HTTPServerSettings.ToListener()
if err != nil {
return fmt.Errorf("failed to bind to address %s: %w", sr.config.Endpoint, err)
}
// use gorilla mux to create a router/handler
nr := mux.NewRouter()
nr.HandleFunc(sapmprotocol.TraceEndpointV2, sr.HTTPHandlerFunc)
// create a server with the handler
sr.server, err = sr.config.HTTPServerSettings.ToServer(host, sr.settings, nr)
if err != nil {
return err
}
sr.shutdownWG.Add(1)
// run the server on a routine
go func() {
defer sr.shutdownWG.Done()
if errHTTP := sr.server.Serve(ln); !errors.Is(errHTTP, http.ErrServerClosed) && errHTTP != nil {
host.ReportFatalError(errHTTP)
}
}()
return nil
}
// Shutdown stops the the sapmReceiver's server.
func (sr *sapmReceiver) Shutdown(context.Context) error {
if sr.server == nil {
return nil
}
err := sr.server.Close()
sr.shutdownWG.Wait()
return err
}
// this validates at compile time that sapmReceiver implements the receiver.Traces interface
var _ receiver.Traces = (*sapmReceiver)(nil)
// newReceiver creates a sapmReceiver that receives SAPM over http
func newReceiver(
params receiver.CreateSettings,
config *Config,
nextConsumer consumer.Traces,
) (receiver.Traces, error) {
// build the response message
defaultResponse := &splunksapm.PostSpansResponse{}
defaultResponseBytes, err := defaultResponse.Marshal()
if err != nil {
return nil, fmt.Errorf("failed to marshal default response body for %v receiver: %w", params.ID, err)
}
transport := "http"
if config.TLSSetting != nil {
transport = "https"
}
obsrecv, err := obsreport.NewReceiver(obsreport.ReceiverSettings{
ReceiverID: params.ID,
Transport: transport,
ReceiverCreateSettings: params,
})
if err != nil {
return nil, err
}
return &sapmReceiver{
settings: params.TelemetrySettings,
config: config,
nextConsumer: nextConsumer,
defaultResponse: defaultResponseBytes,
obsrecv: obsrecv,
}, nil
}