-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
metrics_v2.tmpl
308 lines (278 loc) · 11.3 KB
/
metrics_v2.tmpl
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
// Code generated by mdatagen. DO NOT EDIT.
package {{ .Package }}
import (
{{- if .Metrics | parseImportsRequired }}
"strconv"
"fmt"
{{- end }}
"time"
"go.opentelemetry.io/collector/pdata/pcommon"
"go.opentelemetry.io/collector/pdata/pmetric"
{{- if .SemConvVersion }}
conventions "go.opentelemetry.io/collector/semconv/v{{ .SemConvVersion }}"
{{- end }}
)
// MetricSettings provides common settings for a particular metric.
type MetricSettings struct {
Enabled bool `mapstructure:"enabled"`
}
// MetricsSettings provides settings for {{ .Name }} metrics.
type MetricsSettings struct {
{{- range $name, $metric := .Metrics }}
{{ $name.Render }} MetricSettings `mapstructure:"{{ $name }}"`
{{- end }}
}
func DefaultMetricsSettings() MetricsSettings {
return MetricsSettings{
{{- range $name, $metric := .Metrics }}
{{ $name.Render }}: MetricSettings{
Enabled: {{ $metric.Enabled }},
},
{{- end }}
}
}
{{ range $name, $info := .Attributes }}
{{- if $info.Enum -}}
// Attribute{{ $name.Render }} specifies the a value {{ $name }} attribute.
type Attribute{{ $name.Render }} int
const (
_ Attribute{{ $name.Render }} = iota
{{- range $info.Enum }}
Attribute{{ $name.Render }}{{ . | publicVar }}
{{- end }}
)
// String returns the string representation of the Attribute{{ $name.Render }}.
func (av Attribute{{ $name.Render }}) String() string {
switch av {
{{- range $info.Enum }}
case Attribute{{ $name.Render }}{{ . | publicVar }}:
return "{{ . }}"
{{- end }}
}
return ""
}
// MapAttribute{{ $name.Render }} is a helper map of string to Attribute{{ $name.Render }} attribute value.
var MapAttribute{{ $name.Render }} = map[string]Attribute{{ $name.Render }}{
{{- range $info.Enum }}
"{{ . }}": Attribute{{ $name.Render }}{{ . | publicVar }},
{{- end }}
}
{{ end }}
{{- end }}
{{ range $name, $metric := .Metrics -}}
type metric{{ $name.Render }} struct {
data pmetric.Metric // data buffer for generated metric.
settings MetricSettings // metric settings provided by user.
capacity int // max observed number of data points added to the metric.
}
// init fills {{ $name }} metric with initial data.
func (m *metric{{ $name.Render }}) init() {
m.data.SetName("{{ $name }}")
m.data.SetDescription("{{ $metric.Description }}")
m.data.SetUnit("{{ $metric.Unit }}")
m.data.SetDataType(pmetric.MetricDataType{{ $metric.Data.Type }})
{{- if $metric.Data.HasMonotonic }}
m.data.{{ $metric.Data.Type }}().SetIsMonotonic({{ $metric.Data.Monotonic }})
{{- end }}
{{- if $metric.Data.HasAggregated }}
m.data.{{ $metric.Data.Type }}().SetAggregationTemporality({{ $metric.Data.Aggregated.Type }})
{{- end }}
{{- if $metric.Attributes }}
m.data.{{ $metric.Data.Type }}().DataPoints().EnsureCapacity(m.capacity)
{{- end }}
}
func (m *metric{{ $name.Render }}) recordDataPoint(start pcommon.Timestamp, ts pcommon.Timestamp
{{- if $metric.Data.HasMetricValueType }}, val {{ $metric.Data.MetricValueType.BasicType }}{{ end }}
{{- range $metric.Attributes -}}, {{ .RenderUnexported }}AttributeValue string {{ end }}) {
if !m.settings.Enabled {
return
}
dp := m.data.{{ $metric.Data.Type }}().DataPoints().AppendEmpty()
dp.SetStartTimestamp(start)
dp.SetTimestamp(ts)
{{- if $metric.Data.HasMetricValueType }}
dp.Set{{ $metric.Data.MetricValueType }}Val(val)
{{- end }}
{{- range $metric.Attributes }}
dp.Attributes().Insert("{{ attributeKey .}}", pcommon.NewValueString({{ .RenderUnexported }}AttributeValue))
{{- end }}
}
// updateCapacity saves max length of data point slices that will be used for the slice capacity.
func (m *metric{{ $name.Render }}) updateCapacity() {
if m.data.{{ $metric.Data.Type }}().DataPoints().Len() > m.capacity {
m.capacity = m.data.{{ $metric.Data.Type }}().DataPoints().Len()
}
}
// emit appends recorded metric data to a metrics slice and prepares it for recording another set of data points.
func (m *metric{{ $name.Render }}) emit(metrics pmetric.MetricSlice) {
if m.settings.Enabled && m.data.{{ $metric.Data.Type }}().DataPoints().Len() > 0 {
m.updateCapacity()
m.data.MoveTo(metrics.AppendEmpty())
m.init()
}
}
func newMetric{{ $name.Render }}(settings MetricSettings) metric{{ $name.Render }} {
m := metric{{ $name.Render }}{settings: settings}
if settings.Enabled {
m.data = pmetric.NewMetric()
m.init()
}
return m
}
{{ end -}}
// MetricsBuilder provides an interface for scrapers to report metrics while taking care of all the transformations
// required to produce metric representation defined in metadata and user settings.
type MetricsBuilder struct {
startTime pcommon.Timestamp // start time that will be applied to all recorded data points.
metricsCapacity int // maximum observed number of metrics per resource.
resourceCapacity int // maximum observed number of resource attributes.
metricsBuffer pmetric.Metrics // accumulates metrics data before emitting.
{{- range $name, $metric := .Metrics }}
metric{{ $name.Render }} metric{{ $name.Render }}
{{- end }}
}
// metricBuilderOption applies changes to default metrics builder.
type metricBuilderOption func(*MetricsBuilder)
// WithStartTime sets startTime on the metrics builder.
func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption {
return func(mb *MetricsBuilder) {
mb.startTime = startTime
}
}
func NewMetricsBuilder(settings MetricsSettings, options ...metricBuilderOption) *MetricsBuilder {
mb := &MetricsBuilder{
startTime: pcommon.NewTimestampFromTime(time.Now()),
metricsBuffer: pmetric.NewMetrics(),
{{- range $name, $metric := .Metrics }}
metric{{ $name.Render }}: newMetric{{ $name.Render }}(settings.{{ $name.Render }}),
{{- end }}
}
for _, op := range options {
op(mb)
}
return mb
}
// updateCapacity updates max length of metrics and resource attributes that will be used for the slice capacity.
func (mb *MetricsBuilder) updateCapacity(rm pmetric.ResourceMetrics) {
if mb.metricsCapacity < rm.ScopeMetrics().At(0).Metrics().Len() {
mb.metricsCapacity = rm.ScopeMetrics().At(0).Metrics().Len()
}
if mb.resourceCapacity < rm.Resource().Attributes().Len() {
mb.resourceCapacity = rm.Resource().Attributes().Len()
}
}
// ResourceMetricsOption applies changes to provided resource metrics.
type ResourceMetricsOption func(pmetric.ResourceMetrics)
{{- range $name, $attr := .ResourceAttributes }}
// With{{ $name.Render }} sets provided value as "{{ $name }}" attribute for current resource.
func With{{ $name.Render }}(val {{ $attr.Type.Primitive }}) ResourceMetricsOption {
return func(rm pmetric.ResourceMetrics) {
rm.Resource().Attributes().Upsert{{ $attr.Type }}("{{ $name }}", val)
}
}
{{ end }}
// WithStartTimeOverride overrides start time for all the resource metrics data points.
// This option should be only used if different start time has to be set on metrics coming from different resources.
func WithStartTimeOverride(start pcommon.Timestamp) ResourceMetricsOption {
return func(rm pmetric.ResourceMetrics) {
metrics := rm.ScopeMetrics().At(0).Metrics()
for i := 0; i < metrics.Len(); i++ {
dps := pmetric.NewNumberDataPointSlice()
switch metrics.At(i).DataType() {
case pmetric.MetricDataTypeGauge:
dps = metrics.At(i).Gauge().DataPoints()
case pmetric.MetricDataTypeSum:
dps = metrics.At(i).Sum().DataPoints()
}
for j := 0; j < dps.Len(); j++ {
dps.At(j).SetStartTimestamp(start)
}
}
}
}
// EmitForResource saves all the generated metrics under a new resource and updates the internal state to be ready for
// recording another set of data points as part of another resource. This function can be helpful when one scraper
// needs to emit metrics from several resources. Otherwise calling this function is not required,
// just `Emit` function can be called instead.
// Resource attributes should be provided as ResourceMetricsOption arguments.
func (mb *MetricsBuilder) EmitForResource(rmo ...ResourceMetricsOption) {
rm := pmetric.NewResourceMetrics()
{{- if .SemConvVersion }}
rm.SetSchemaUrl(conventions.SchemaURL)
{{- end }}
rm.Resource().Attributes().EnsureCapacity(mb.resourceCapacity)
ils := rm.ScopeMetrics().AppendEmpty()
ils.Scope().SetName("otelcol/{{ .Name }}")
ils.Metrics().EnsureCapacity(mb.metricsCapacity)
{{- range $name, $metric := .Metrics }}
mb.metric{{- $name.Render }}.emit(ils.Metrics())
{{- end }}
for _, op := range rmo {
op(rm)
}
if ils.Metrics().Len() > 0 {
mb.updateCapacity(rm)
rm.MoveTo(mb.metricsBuffer.ResourceMetrics().AppendEmpty())
}
}
// Emit returns all the metrics accumulated by the metrics builder and updates the internal state to be ready for
// recording another set of metrics. This function will be responsible for applying all the transformations required to
// produce metric representation defined in metadata and user settings, e.g. delta or cumulative.
func (mb *MetricsBuilder) Emit(rmo ...ResourceMetricsOption) pmetric.Metrics {
mb.EmitForResource(rmo...)
metrics := pmetric.NewMetrics()
mb.metricsBuffer.MoveTo(metrics)
return metrics
}
{{ range $name, $metric := .Metrics -}}
// Record{{ $name.Render }}DataPoint adds a data point to {{ $name }} metric.
func (mb *MetricsBuilder) Record{{ $name.Render }}DataPoint(ts pcommon.Timestamp
{{- if $metric.Data.HasMetricInputType }}, val {{ $metric.Data.MetricInputType.String }}
{{- else }}
{{- if $metric.Data.HasMetricValueType }}, val {{ $metric.Data.MetricValueType.BasicType }}{{- end }}
{{- end -}}
{{- range $metric.Attributes -}}
, {{ .RenderUnexported }}AttributeValue {{ if (attributeInfo .).Enum }}Attribute{{ .Render }}{{ else }}string{{ end }}
{{- end }})
{{- if $metric.Data.HasMetricInputType }} error{{ end }} {
{{- if $metric.Data.HasMetricInputType }}
{{- if $metric.Data.HasMetricValueType }}
{{- if eq $metric.Data.MetricValueType.BasicType "float64" }}
if f, err := strconv.ParseFloat(val, 64); err != nil {
return fmt.Errorf("failed to parse float for {{ $name.Render }}, value was %s: %w", val, err)
} else {
mb.metric{{ $name.Render }}.recordDataPoint(mb.startTime, ts
{{- if $metric.Data.HasMetricValueType }}, f {{ end }}
{{- range $metric.Attributes -}} , {{ .RenderUnexported }}AttributeValue{{ end }})
}
{{- end }}
{{- if eq $metric.Data.MetricValueType.BasicType "int64" }}
if i, err := strconv.ParseInt(val, 10, 64); err != nil {
return fmt.Errorf("failed to parse int for {{ $name.Render }}, value was %s: %w", val, err)
} else {
mb.metric{{ $name.Render }}.recordDataPoint(mb.startTime, ts
{{- if $metric.Data.HasMetricValueType }}, i {{ end }}
{{- range $metric.Attributes -}}
, {{ .RenderUnexported }}AttributeValue{{ if (attributeInfo .).Enum }}.String(){{ end }}
{{- end }})
}
{{- end }}
return nil
{{- end }}
{{- else }}
mb.metric{{ $name.Render }}.recordDataPoint(mb.startTime, ts
{{- if $metric.Data.HasMetricValueType }}, val {{ end }}
{{- range $metric.Attributes -}}
, {{ .RenderUnexported }}AttributeValue{{ if (attributeInfo .).Enum }}.String(){{ end }}
{{- end }})
{{- end }}
}
{{ end }}
// Reset resets metrics builder to its initial state. It should be used when external metrics source is restarted,
// and metrics builder should update its startTime and reset it's internal state accordingly.
func (mb *MetricsBuilder) Reset(options ...metricBuilderOption) {
mb.startTime = pcommon.NewTimestampFromTime(time.Now())
for _, op := range options {
op(mb)
}
}