-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
metricdata.go
256 lines (213 loc) · 6.57 KB
/
metricdata.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
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package main
import (
"errors"
"fmt"
"golang.org/x/text/cases"
"golang.org/x/text/language"
"go.opentelemetry.io/collector/confmap"
"go.opentelemetry.io/collector/pdata/pmetric"
)
var (
_ MetricData = &gauge{}
_ MetricData = &sum{}
_ MetricData = &histogram{}
)
// MetricData is generic interface for all metric datatypes.
type MetricData interface {
Type() string
HasMonotonic() bool
HasAggregated() bool
HasMetricInputType() bool
Instrument() string
IsAsync() bool
}
// AggregationTemporality defines a metric aggregation type.
type AggregationTemporality struct {
// Aggregation describes if the aggregator reports delta changes
// since last report time, or cumulative changes since a fixed start time.
Aggregation pmetric.AggregationTemporality
}
// UnmarshalText implements the encoding.TextUnmarshaler interface.
func (agg *AggregationTemporality) UnmarshalText(text []byte) error {
switch vtStr := string(text); vtStr {
case "cumulative":
agg.Aggregation = pmetric.AggregationTemporalityCumulative
case "delta":
agg.Aggregation = pmetric.AggregationTemporalityDelta
default:
return fmt.Errorf("invalid aggregation: %q", vtStr)
}
return nil
}
// String returns string representation of the aggregation temporality.
func (agg *AggregationTemporality) String() string {
return agg.Aggregation.String()
}
// Mono defines the metric monotonicity.
type Mono struct {
// Monotonic is true if the sum is monotonic.
Monotonic bool `mapstructure:"monotonic"`
}
// MetricInputType defines the metric input value type
type MetricInputType struct {
// InputType is the type the metric needs to be parsed from, options are "string"
InputType string `mapstructure:"input_type"`
}
func (mit MetricInputType) HasMetricInputType() bool {
return mit.InputType != ""
}
// Type returns name of the datapoint type.
func (mit MetricInputType) String() string {
return mit.InputType
}
// MetricValueType defines the metric number type.
type MetricValueType struct {
// ValueType is type of the metric number, options are "double", "int".
ValueType pmetric.NumberDataPointValueType
}
func (mvt *MetricValueType) Unmarshal(parser *confmap.Conf) error {
if !parser.IsSet("value_type") {
return errors.New("missing required field: `value_type`")
}
return nil
}
// UnmarshalText implements the encoding.TextUnmarshaler interface.
func (mvt *MetricValueType) UnmarshalText(text []byte) error {
switch vtStr := string(text); vtStr {
case "int":
mvt.ValueType = pmetric.NumberDataPointValueTypeInt
case "double":
mvt.ValueType = pmetric.NumberDataPointValueTypeDouble
default:
return fmt.Errorf("invalid value_type: %q", vtStr)
}
return nil
}
// Type returns name of the datapoint type.
func (mvt MetricValueType) String() string {
return mvt.ValueType.String()
}
// BasicType returns name of a golang basic type for the datapoint type.
func (mvt MetricValueType) BasicType() string {
switch mvt.ValueType {
case pmetric.NumberDataPointValueTypeInt:
return "int64"
case pmetric.NumberDataPointValueTypeDouble:
return "float64"
case pmetric.NumberDataPointValueTypeEmpty:
return ""
default:
return ""
}
}
type gauge struct {
MetricValueType `mapstructure:"value_type"`
MetricInputType `mapstructure:",squash"`
Async bool `mapstructure:"async,omitempty"`
}
// Unmarshal is a custom unmarshaler for gauge. Needed mostly to avoid MetricValueType.Unmarshal inheritance.
func (d *gauge) Unmarshal(parser *confmap.Conf) error {
if err := d.MetricValueType.Unmarshal(parser); err != nil {
return err
}
return parser.Unmarshal(d, confmap.WithIgnoreUnused())
}
func (d gauge) Type() string {
return "Gauge"
}
func (d gauge) HasMonotonic() bool {
return false
}
func (d gauge) HasAggregated() bool {
return false
}
func (d gauge) Instrument() string {
instrumentName := cases.Title(language.English).String(d.MetricValueType.BasicType())
if d.Async {
instrumentName += "Observable"
}
instrumentName += "Gauge"
return instrumentName
}
func (d gauge) IsAsync() bool {
return d.Async
}
type sum struct {
AggregationTemporality `mapstructure:"aggregation_temporality"`
Mono `mapstructure:",squash"`
MetricValueType `mapstructure:"value_type"`
MetricInputType `mapstructure:",squash"`
Async bool `mapstructure:"async,omitempty"`
}
// Unmarshal is a custom unmarshaler for sum. Needed mostly to avoid MetricValueType.Unmarshal inheritance.
func (d *sum) Unmarshal(parser *confmap.Conf) error {
if err := d.MetricValueType.Unmarshal(parser); err != nil {
return err
}
return parser.Unmarshal(d, confmap.WithIgnoreUnused())
}
// TODO: Currently, this func will not be called because of https://github.com/open-telemetry/opentelemetry-collector/issues/6671. Uncomment function and
// add a test case to Test_loadMetadata for file no_monotonic.yaml once the issue is solved.
//
// Unmarshal is a custom unmarshaler for Mono.
// func (m *Mono) Unmarshal(parser *confmap.Conf) error {
// if !parser.IsSet("monotonic") {
// return errors.New("missing required field: `monotonic`")
// }
// return parser.Unmarshal(m)
// }
func (d sum) Type() string {
return "Sum"
}
func (d sum) HasMonotonic() bool {
return true
}
func (d sum) HasAggregated() bool {
return true
}
func (d sum) Instrument() string {
instrumentName := cases.Title(language.English).String(d.MetricValueType.BasicType())
if d.Async {
instrumentName += "Observable"
}
if !d.Monotonic {
instrumentName += "UpDown"
}
instrumentName += "Counter"
return instrumentName
}
func (d sum) IsAsync() bool {
return d.Async
}
type histogram struct {
AggregationTemporality `mapstructure:"aggregation_temporality"`
Mono `mapstructure:",squash"`
MetricValueType `mapstructure:"value_type"`
MetricInputType `mapstructure:",squash"`
Async bool `mapstructure:"async,omitempty"`
}
func (d histogram) Type() string {
return "Histogram"
}
func (d histogram) HasMonotonic() bool {
return false
}
func (d histogram) HasAggregated() bool {
return false
}
func (d histogram) Instrument() string {
instrumentName := cases.Title(language.English).String(d.MetricValueType.BasicType())
return instrumentName + d.Type()
}
// Unmarshal is a custom unmarshaler for histogram. Needed mostly to avoid MetricValueType.Unmarshal inheritance.
func (d *histogram) Unmarshal(parser *confmap.Conf) error {
if err := d.MetricValueType.Unmarshal(parser); err != nil {
return err
}
return parser.Unmarshal(d, confmap.WithIgnoreUnused())
}
func (d histogram) IsAsync() bool {
return d.Async
}