/
obsreport_exporter.go
190 lines (166 loc) · 7.39 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
// 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/configtelemetry"
)
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 + "traces"
exportMetricsOperationSuffix = nameSep + "metrics"
exportLogsOperationSuffix = nameSep + "logs"
// 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)
)
// 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, exporterName string) context.Context {
ctx, _ = tag.New(ctx, tag.Upsert(tagKeyExporter, exporterName, tag.WithTTL(tag.TTLNoPropagation)))
return ctx
}
type ExporterObsReport struct {
level configtelemetry.Level
exporterName string
mutators []tag.Mutator
}
func NewExporterObsReport(level configtelemetry.Level, exporterName string) *ExporterObsReport {
return &ExporterObsReport{
level: level,
exporterName: exporterName,
mutators: []tag.Mutator{tag.Upsert(tagKeyProcessor, exporterName, tag.WithTTL(tag.TTLNoPropagation))},
}
}
// StartTracesExportOp is called at the start of an Export operation.
// The returned context should be used in other calls to the ExporterObsReport functions
// dealing with the same export operation.
func (eor *ExporterObsReport) StartTracesExportOp(ctx context.Context) context.Context {
return eor.startSpan(ctx, exportTraceDataOperationSuffix)
}
// EndTracesExportOp completes the export operation that was started with StartTracesExportOp.
func (eor *ExporterObsReport) EndTracesExportOp(ctx context.Context, numSpans int, err error) {
numSent, numFailedToSend := toNumItems(numSpans, err)
recordMetrics(ctx, numSent, numFailedToSend, mExporterSentSpans, mExporterFailedToSendSpans)
endSpan(ctx, err, numSent, numFailedToSend, SentSpansKey, FailedToSendSpansKey)
}
// StartMetricsExportOp is called at the start of an Export operation.
// The returned context should be used in other calls to the ExporterObsReport functions
// dealing with the same export operation.
func (eor *ExporterObsReport) StartMetricsExportOp(ctx context.Context) context.Context {
return eor.startSpan(ctx, exportMetricsOperationSuffix)
}
// EndMetricsExportOp completes the export operation that was started with
// StartMetricsExportOp.
func (eor *ExporterObsReport) EndMetricsExportOp(ctx context.Context, numMetricPoints int, err error) {
numSent, numFailedToSend := toNumItems(numMetricPoints, err)
recordMetrics(ctx, numSent, numFailedToSend, mExporterSentMetricPoints, mExporterFailedToSendMetricPoints)
endSpan(ctx, err, numSent, numFailedToSend, SentMetricPointsKey, FailedToSendMetricPointsKey)
}
// StartLogsExportOp is called at the start of an Export operation.
// The returned context should be used in other calls to the ExporterObsReport functions
// dealing with the same export operation.
func (eor *ExporterObsReport) StartLogsExportOp(ctx context.Context) context.Context {
return eor.startSpan(ctx, exportLogsOperationSuffix)
}
// EndLogsExportOp completes the export operation that was started with StartLogsExportOp.
func (eor *ExporterObsReport) EndLogsExportOp(ctx context.Context, numLogRecords int, err error) {
numSent, numFailedToSend := toNumItems(numLogRecords, err)
recordMetrics(ctx, numSent, numFailedToSend, mExporterSentLogRecords, mExporterFailedToSendLogRecords)
endSpan(ctx, err, numSent, numFailedToSend, SentLogRecordsKey, FailedToSendLogRecordsKey)
}
// startSpan creates the span used to trace the operation. Returning
// the updated context and the created span.
func (eor *ExporterObsReport) startSpan(ctx context.Context, operationSuffix string) context.Context {
spanName := exporterPrefix + eor.exporterName + operationSuffix
ctx, _ = trace.StartSpan(ctx, spanName)
return ctx
}
func recordMetrics(ctx context.Context, numSent, numFailedToSend int64, sentMeasure, failedToSendMeasure *stats.Int64Measure) {
if gLevel == configtelemetry.LevelNone {
return
}
stats.Record(
ctx,
sentMeasure.M(numSent),
failedToSendMeasure.M(numFailedToSend))
}
func endSpan(ctx context.Context, err error, numSent, numFailedToSend int64, sentItemsKey, failedToSendItemsKey string) {
span := trace.FromContext(ctx)
// End span according to errors.
if span.IsRecordingEvents() {
span.AddAttributes(
trace.Int64Attribute(
sentItemsKey, numSent),
trace.Int64Attribute(
failedToSendItemsKey, numFailedToSend),
)
span.SetStatus(errToStatus(err))
}
span.End()
}
func toNumItems(numExportedItems int, err error) (int64, int64) {
if err != nil {
return 0, int64(numExportedItems)
}
return int64(numExportedItems), 0
}