/
obsreport_exporter.go
276 lines (247 loc) · 8.45 KB
/
obsreport_exporter.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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package obsreport
import (
"context"
"go.opencensus.io/stats"
"go.opencensus.io/tag"
"go.opencensus.io/trace"
"go.opentelemetry.io/collector/config/configmodels"
)
const (
// Key used to identify exporters in metrics and traces.
ExporterKey = "exporter"
// Key used to track spans sent by exporters.
SentSpansKey = "sent_spans"
// Key used to track spans that failed to be sent by exporters.
FailedToSendSpansKey = "send_failed_spans"
// Key used to track metric points sent by exporters.
SentMetricPointsKey = "sent_metric_points"
// Key used to track metric points that failed to be sent by exporters.
FailedToSendMetricPointsKey = "send_failed_metric_points"
// Key used to track logs sent by exporters.
SentLogRecordsKey = "sent_log_records"
// Key used to track logs that failed to be sent by exporters.
FailedToSendLogRecordsKey = "send_failed_log_records"
)
var (
tagKeyExporter, _ = tag.NewKey(ExporterKey)
exporterPrefix = ExporterKey + nameSep
exportTraceDataOperationSuffix = nameSep + "TraceDataExported"
exportMetricsOperationSuffix = nameSep + "MetricsExported"
exportLogsOperationSuffix = nameSep + "LogRecordsExported"
// Exporter metrics. Any count of data items below is in the final format
// that they were sent, reasoning: reconciliation is easier if measurements
// on backend and exporter are expected to be the same. Translation issues
// that result in a different number of elements should be reported in a
// separate way.
mExporterSentSpans = stats.Int64(
exporterPrefix+SentSpansKey,
"Number of spans successfully sent to destination.",
stats.UnitDimensionless)
mExporterFailedToSendSpans = stats.Int64(
exporterPrefix+FailedToSendSpansKey,
"Number of spans in failed attempts to send to destination.",
stats.UnitDimensionless)
mExporterSentMetricPoints = stats.Int64(
exporterPrefix+SentMetricPointsKey,
"Number of metric points successfully sent to destination.",
stats.UnitDimensionless)
mExporterFailedToSendMetricPoints = stats.Int64(
exporterPrefix+FailedToSendMetricPointsKey,
"Number of metric points in failed attempts to send to destination.",
stats.UnitDimensionless)
mExporterSentLogRecords = stats.Int64(
exporterPrefix+SentLogRecordsKey,
"Number of log record successfully sent to destination.",
stats.UnitDimensionless)
mExporterFailedToSendLogRecords = stats.Int64(
exporterPrefix+FailedToSendLogRecordsKey,
"Number of log records in failed attempts to send to destination.",
stats.UnitDimensionless)
)
// StartTraceDataExportOp is called at the start of an Export operation.
// The returned context should be used in other calls to the obsreport functions
// dealing with the same export operation.
func StartTraceDataExportOp(
operationCtx context.Context,
exporter string,
) context.Context {
return traceExportDataOp(
operationCtx,
exporter,
exportTraceDataOperationSuffix)
}
// EndTraceDataExportOp completes the export operation that was started with
// StartTraceDataExportOp.
func EndTraceDataExportOp(
exporterCtx context.Context,
numExportedSpans int,
numDroppedSpans int, // TODO: For legacy measurements, to be removed in the future.
err error,
) {
if useLegacy {
stats.Record(exporterCtx, mExporterReceivedSpans.M(int64(numExportedSpans)), mExporterDroppedSpans.M(int64(numDroppedSpans)))
}
endExportOp(
exporterCtx,
numExportedSpans,
err,
configmodels.TracesDataType,
)
}
// StartMetricsExportOp is called at the start of an Export operation.
// The returned context should be used in other calls to the obsreport functions
// dealing with the same export operation.
func StartMetricsExportOp(
operationCtx context.Context,
exporter string,
) context.Context {
return traceExportDataOp(
operationCtx,
exporter,
exportMetricsOperationSuffix)
}
// EndMetricsExportOp completes the export operation that was started with
// StartMetricsExportOp.
func EndMetricsExportOp(
exporterCtx context.Context,
numExportedPoints int,
numExportedTimeSeries int, // TODO: For legacy measurements, to be removed in the future.
numDroppedTimeSeries int, // TODO: For legacy measurements, to be removed in the future.
err error,
) {
if useLegacy {
stats.Record(exporterCtx, mExporterReceivedTimeSeries.M(int64(numExportedTimeSeries)), mExporterDroppedTimeSeries.M(int64(numDroppedTimeSeries)))
}
endExportOp(
exporterCtx,
numExportedPoints,
err,
configmodels.MetricsDataType,
)
}
// StartLogsExportOp is called at the start of an Export operation.
// The returned context should be used in other calls to the obsreport functions
// dealing with the same export operation.
func StartLogsExportOp(
operationCtx context.Context,
exporter string,
) context.Context {
return traceExportDataOp(
operationCtx,
exporter,
exportLogsOperationSuffix)
}
// EndLogsExportOp completes the export operation that was started with
// StartLogsExportOp.
func EndLogsExportOp(
exporterCtx context.Context,
numExportedLogs int,
numDroppedLogs int, // TODO: For legacy measurements, to be removed in the future.
err error,
) {
if useLegacy {
stats.Record(exporterCtx, mExporterReceivedLogRecords.M(int64(numExportedLogs)), mExporterDroppedLogRecords.M(int64(numDroppedLogs)))
}
endExportOp(
exporterCtx,
numExportedLogs,
err,
configmodels.LogsDataType,
)
}
// ExporterContext adds the keys used when recording observability metrics to
// the given context returning the newly created context. This context should
// be used in related calls to the obsreport functions so metrics are properly
// recorded.
func ExporterContext(
ctx context.Context,
exporter string,
) context.Context {
if useLegacy {
ctx, _ = tag.New(ctx, tag.Upsert(LegacyTagKeyExporter, exporter, tag.WithTTL(tag.TTLNoPropagation)))
}
ctx, _ = tag.New(ctx, tag.Upsert(tagKeyExporter, exporter, tag.WithTTL(tag.TTLNoPropagation)))
return ctx
}
// traceExportDataOp creates the span used to trace the operation. Returning
// the updated context and the created span.
func traceExportDataOp(
exporterCtx context.Context,
exporterName string,
operationSuffix string,
) context.Context {
spanName := exporterPrefix + exporterName + operationSuffix
ctx, _ := trace.StartSpan(exporterCtx, spanName)
return ctx
}
// endExportOp records the observability signals at the end of an operation.
func endExportOp(
exporterCtx context.Context,
numExportedItems int,
err error,
dataType configmodels.DataType,
) {
numSent := numExportedItems
numFailedToSend := 0
if err != nil {
numSent = 0
numFailedToSend = numExportedItems
}
if useNew {
var sentMeasure, failedToSendMeasure *stats.Int64Measure
switch dataType {
case configmodels.TracesDataType:
sentMeasure = mExporterSentSpans
failedToSendMeasure = mExporterFailedToSendSpans
case configmodels.MetricsDataType:
sentMeasure = mExporterSentMetricPoints
failedToSendMeasure = mExporterFailedToSendMetricPoints
case configmodels.LogsDataType:
sentMeasure = mExporterSentLogRecords
failedToSendMeasure = mExporterFailedToSendLogRecords
default:
panic("unknown data type for internal metrics")
}
stats.Record(
exporterCtx,
sentMeasure.M(int64(numSent)),
failedToSendMeasure.M(int64(numFailedToSend)))
}
span := trace.FromContext(exporterCtx)
// End span according to errors.
if span.IsRecordingEvents() {
var sentItemsKey, failedToSendItemsKey string
switch dataType {
case configmodels.TracesDataType:
sentItemsKey = SentSpansKey
failedToSendItemsKey = FailedToSendSpansKey
case configmodels.MetricsDataType:
sentItemsKey = SentMetricPointsKey
failedToSendItemsKey = FailedToSendMetricPointsKey
case configmodels.LogsDataType:
sentItemsKey = SentLogRecordsKey
failedToSendItemsKey = FailedToSendLogRecordsKey
}
span.AddAttributes(
trace.Int64Attribute(
sentItemsKey, int64(numSent)),
trace.Int64Attribute(
failedToSendItemsKey, int64(numFailedToSend)),
)
span.SetStatus(errToStatus(err))
}
span.End()
}