fix: remove flags field

Helps open-telemetry/opentelemetry-collector-contrib#29896 The flags field is set as an unsigned integer, which is not compatible with InfluxDB 1.x. Luckily, the field is also not useful, as it stores a value chosen from an enum containing no useful values. In this change, the flags field is removed from conversion. If it needs to be added in the future, we can expect that enough time will have passed that retention policies will have removed the prior `flags` field.
influxdata · May 25, 2024 · cb655fb · cb655fb
1 parent 3e3c07a
commit cb655fb
Show file tree

Hide file tree

Showing 12 changed files with 12 additions and 103 deletions.
diff --git a/docs/logs.md b/docs/logs.md
@@ -39,7 +39,7 @@ timestamp                                           | `time_unix_nano` fixed64
 `otel.log.dropped_attributes_count` field uint      | `dropped_attributes_count` uint32
 `severity_number` tag uint                          | `severity_number` enum SeverityNumber           |                                                           | `level` number                                       | `PRI severity` integer     | `PRI severity` integer
 `severity_text` field string                        | `severity_text` string
-`otel.log.flags` field uint                         | `flags` fixed32
+.                                                   | `flags` fixed32
 .                                                   | `attributes["fluent.tag"]` string               | `tag` string
 .                                                   | `Resource.attributes["net.host.name"]` string   |                                                           | `host` string                                        | `HEADER hostname` string   | `HOSTNAME` string
 .                                                   | `Resource.attributes["net.host.ip"]` string     |                                                           |                                                      | `HEADER IP address` string | `HOSTNAME` string

diff --git a/influx2otel/metrics_telegraf_prometheus_v1.go b/influx2otel/metrics_telegraf_prometheus_v1.go
@@ -94,11 +94,6 @@ func (b *MetricsBatch) convertGaugeV1(measurement string, tags map[string]string
 				}
 			}
 		}
-		if flagsObj, ok := fields[common.AttributeFlags]; ok {
-			if flagsUint64, ok := flagsObj.(uint64); ok {
-				dataPoint.SetFlags(pmetric.DataPointFlags(flagsUint64))
-			}
-		}
 
 		if floatValue != nil {
 			dataPoint.SetDoubleValue(*floatValue)
@@ -114,7 +109,7 @@ func (b *MetricsBatch) convertGaugeV1(measurement string, tags map[string]string
 		var floatValue *float64
 		var intValue *int64
 
-		if k == common.AttributeStartTimeStatsd || k == common.AttributeFlags {
+		if k == common.AttributeStartTimeStatsd {
 			continue
 		}
 		switch typedValue := fieldValue.(type) {
@@ -145,11 +140,6 @@ func (b *MetricsBatch) convertGaugeV1(measurement string, tags map[string]string
 				}
 			}
 		}
-		if flagsObj, ok := fields[common.AttributeFlags]; ok {
-			if flagsUint64, ok := flagsObj.(uint64); ok {
-				dataPoint.SetFlags(pmetric.DataPointFlags(flagsUint64))
-			}
-		}
 
 		if floatValue != nil {
 			dataPoint.SetDoubleValue(*floatValue)
@@ -193,11 +183,6 @@ func (b *MetricsBatch) convertSumV1(measurement string, tags map[string]string,
 				}
 			}
 		}
-		if flagsObj, ok := fields[common.AttributeFlags]; ok {
-			if flagsUint64, ok := flagsObj.(uint64); ok {
-				dataPoint.SetFlags(pmetric.DataPointFlags(flagsUint64))
-			}
-		}
 
 		if floatValue != nil {
 			dataPoint.SetDoubleValue(*floatValue)
@@ -211,7 +196,7 @@ func (b *MetricsBatch) convertSumV1(measurement string, tags map[string]string,
 	}
 
 	for k, fieldValue := range fields {
-		if k == common.AttributeStartTimeStatsd || k == common.AttributeFlags {
+		if k == common.AttributeStartTimeStatsd {
 			continue
 		}
 
@@ -245,11 +230,6 @@ func (b *MetricsBatch) convertSumV1(measurement string, tags map[string]string,
 				}
 			}
 		}
-		if flagsObj, ok := fields[common.AttributeFlags]; ok {
-			if flagsUint64, ok := flagsObj.(uint64); ok {
-				dataPoint.SetFlags(pmetric.DataPointFlags(flagsUint64))
-			}
-		}
 
 		if floatValue != nil {
 			dataPoint.SetDoubleValue(*floatValue)
@@ -295,7 +275,7 @@ func (b *MetricsBatch) convertHistogramV1(measurement string, tags map[string]st
 				bucketCounts = append(bucketCounts, uint64(vBucketCount))
 			}
 
-		} else if k == common.AttributeStartTimeStatsd || k == common.AttributeFlags {
+		} else if k == common.AttributeStartTimeStatsd {
 		} else {
 			b.logger.Debug("skipping unrecognized histogram field", "field", k, "value", vi)
 		}
@@ -337,11 +317,6 @@ func (b *MetricsBatch) convertHistogramV1(measurement string, tags map[string]st
 			}
 		}
 	}
-	if flagsObj, ok := fields[common.AttributeFlags]; ok {
-		if flagsUint64, ok := flagsObj.(uint64); ok {
-			dataPoint.SetFlags(pmetric.DataPointFlags(flagsUint64))
-		}
-	}
 
 	dataPoint.SetCount(count)
 	dataPoint.SetSum(sum)
@@ -382,7 +357,7 @@ func (b *MetricsBatch) convertSummaryV1(measurement string, tags map[string]stri
 				valueAtQuantile.SetValue(value)
 			}
 
-		} else if k == common.AttributeStartTimeStatsd || k == common.AttributeFlags {
+		} else if k == common.AttributeStartTimeStatsd {
 		} else {
 			b.logger.Debug("skipping unrecognized summary field", "field", k, "value", vi)
 		}
@@ -408,11 +383,6 @@ func (b *MetricsBatch) convertSummaryV1(measurement string, tags map[string]stri
 			}
 		}
 	}
-	if flagsObj, ok := fields[common.AttributeFlags]; ok {
-		if flagsUint64, ok := flagsObj.(uint64); ok {
-			dataPoint.SetFlags(pmetric.DataPointFlags(flagsUint64))
-		}
-	}
 
 	dataPoint.SetCount(count)
 	dataPoint.SetSum(sum)

diff --git a/influx2otel/metrics_telegraf_prometheus_v1_test.go b/influx2otel/metrics_telegraf_prometheus_v1_test.go
@@ -27,7 +27,6 @@ func TestAddPoint_v1_gauge(t *testing.T) {
 		},
 		map[string]interface{}{
 			"gauge": float64(23.9),
-			"flags": uint64(1),
 		},
 		time.Unix(0, 1395066363000000123).UTC(),
 		common.InfluxMetricValueTypeGauge)
@@ -60,12 +59,10 @@ func TestAddPoint_v1_gauge(t *testing.T) {
 	dp.Attributes().PutStr("engine_id", "0")
 	dp.SetTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, 1395066363000000123)))
 	dp.SetDoubleValue(23.9)
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(true))
 	dp = m.Gauge().DataPoints().AppendEmpty()
 	dp.Attributes().PutStr("engine_id", "1")
 	dp.SetTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, 1395066363000000123)))
 	dp.SetDoubleValue(11.9)
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(false))
 
 	assertMetricsEqual(t, expect, b.GetMetrics())
 }
@@ -84,7 +81,6 @@ func TestAddPoint_v1_untypedGauge(t *testing.T) {
 		},
 		map[string]interface{}{
 			"gauge": float64(23.9),
-			"flags": uint64(1),
 		},
 		time.Unix(0, 1395066363000000123).UTC(),
 		common.InfluxMetricValueTypeUntyped)
@@ -117,12 +113,10 @@ func TestAddPoint_v1_untypedGauge(t *testing.T) {
 	dp.Attributes().PutStr("engine_id", "0")
 	dp.SetTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, 1395066363000000123)))
 	dp.SetDoubleValue(23.9)
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(true))
 	dp = m.Gauge().DataPoints().AppendEmpty()
 	dp.Attributes().PutStr("engine_id", "1")
 	dp.SetTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, 1395066363000000123)))
 	dp.SetDoubleValue(11.9)
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(false))
 
 	assertMetricsEqual(t, expect, b.GetMetrics())
 }
@@ -142,7 +136,6 @@ func TestAddPoint_v1_sum(t *testing.T) {
 		},
 		map[string]interface{}{
 			"counter": float64(1027),
-			"flags":   uint64(1),
 		},
 		time.Unix(0, 1395066363000000123).UTC(),
 		common.InfluxMetricValueTypeSum)
@@ -179,13 +172,11 @@ func TestAddPoint_v1_sum(t *testing.T) {
 	dp.Attributes().PutStr("method", "post")
 	dp.SetTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, 1395066363000000123)))
 	dp.SetDoubleValue(1027)
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(true))
 	dp = m.Sum().DataPoints().AppendEmpty()
 	dp.Attributes().PutStr("code", "400")
 	dp.Attributes().PutStr("method", "post")
 	dp.SetTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, 1395066363000000123)))
 	dp.SetDoubleValue(3)
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(false))
 
 	assertMetricsEqual(t, expect, b.GetMetrics())
 }
@@ -205,7 +196,6 @@ func TestAddPoint_v1_untypedSum(t *testing.T) {
 		},
 		map[string]interface{}{
 			"counter": float64(1027),
-			"flags":   uint64(0),
 		},
 		time.Unix(0, 1395066363000000123).UTC(),
 		common.InfluxMetricValueTypeUntyped)
@@ -242,13 +232,11 @@ func TestAddPoint_v1_untypedSum(t *testing.T) {
 	dp.Attributes().PutStr("method", "post")
 	dp.SetTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, 1395066363000000123)))
 	dp.SetDoubleValue(1027)
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(false))
 	dp = m.Sum().DataPoints().AppendEmpty()
 	dp.Attributes().PutStr("code", "400")
 	dp.Attributes().PutStr("method", "post")
 	dp.SetTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, 1395066363000000123)))
 	dp.SetDoubleValue(3)
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(false))
 
 	assertMetricsEqual(t, expect, b.GetMetrics())
 }
@@ -275,7 +263,6 @@ func TestAddPoint_v1_histogram(t *testing.T) {
 			"0.5":   float64(129389),
 			"1":     float64(133988),
 			"+Inf":  float64(144320),
-			"flags": uint64(1),
 		},
 		time.Unix(0, 1395066363000000123).UTC(),
 		common.InfluxMetricValueTypeHistogram)
@@ -299,7 +286,6 @@ func TestAddPoint_v1_histogram(t *testing.T) {
 	dp.SetSum(53423)
 	dp.BucketCounts().FromRaw([]uint64{24054, 9390, 66948, 28997, 4599, 10332})
 	dp.ExplicitBounds().FromRaw([]float64{0.05, 0.1, 0.2, 0.5, 1})
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(true))
 
 	assertMetricsEqual(t, expect, b.GetMetrics())
 }
@@ -325,7 +311,6 @@ func TestAddPoint_v1_histogram_missingInfinityBucket(t *testing.T) {
 			"0.2":   float64(100392),
 			"0.5":   float64(129389),
 			"1":     float64(133988),
-			"flags": uint64(0),
 		},
 		time.Unix(0, 1395066363000000123).UTC(),
 		common.InfluxMetricValueTypeHistogram)
@@ -349,7 +334,6 @@ func TestAddPoint_v1_histogram_missingInfinityBucket(t *testing.T) {
 	dp.SetSum(53423)
 	dp.BucketCounts().FromRaw([]uint64{24054, 9390, 66948, 28997, 4599, 10332})
 	dp.ExplicitBounds().FromRaw([]float64{0.05, 0.1, 0.2, 0.5, 1})
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(false))
 
 	assertMetricsEqual(t, expect, b.GetMetrics())
 }
@@ -375,7 +359,6 @@ func TestAddPoint_v1_untypedHistogram(t *testing.T) {
 			"0.2":   float64(100392),
 			"0.5":   float64(129389),
 			"1":     float64(133988),
-			"flags": uint64(1),
 		},
 		time.Unix(0, 1395066363000000123).UTC(),
 		common.InfluxMetricValueTypeUntyped)
@@ -399,7 +382,6 @@ func TestAddPoint_v1_untypedHistogram(t *testing.T) {
 	dp.SetSum(53423)
 	dp.BucketCounts().FromRaw([]uint64{24054, 9390, 66948, 28997, 4599, 10332})
 	dp.ExplicitBounds().FromRaw([]float64{0.05, 0.1, 0.2, 0.5, 1})
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(true))
 
 	assertMetricsEqual(t, expect, b.GetMetrics())
 }
@@ -425,7 +407,6 @@ func TestAddPoint_v1_summary(t *testing.T) {
 			"0.5":   float64(4773),
 			"0.9":   float64(9001),
 			"0.99":  float64(76656),
-			"flags": uint64(1),
 		},
 		time.Unix(0, 1395066363000000123),
 		common.InfluxMetricValueTypeSummary)
@@ -446,7 +427,6 @@ func TestAddPoint_v1_summary(t *testing.T) {
 	dp.SetTimestamp(pcommon.NewTimestampFromTime(time.Unix(0, 1395066363000000123)))
 	dp.SetCount(2693)
 	dp.SetSum(17560473)
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(true))
 	qv := dp.QuantileValues().AppendEmpty()
 	qv.SetQuantile(0.01)
 	qv.SetValue(3102)
@@ -487,7 +467,6 @@ func TestAddPoint_v1_untypedSummary(t *testing.T) {
 			"0.5":   float64(4773),
 			"0.9":   float64(9001),
 			"0.99":  float64(76656),
-			"flags": uint64(0),
 		},
 		time.Unix(0, 1395066363000000123).UTC(),
 		common.InfluxMetricValueTypeUntyped)
@@ -511,7 +490,6 @@ func TestAddPoint_v1_untypedSummary(t *testing.T) {
 	dp.SetSum(17560473)
 	dp.BucketCounts().FromRaw([]uint64{3102, 170, 1501, 4228, 67655, 2693})
 	dp.ExplicitBounds().FromRaw([]float64{0.01, 0.05, 0.5, 0.9, 0.99})
-	dp.SetFlags(pmetric.DefaultDataPointFlags.WithNoRecordedValue(false))
 
 	assertMetricsEqual(t, expect, b.GetMetrics())
 }
diff --git a/otel2influx/README.md b/otel2influx/README.md
@@ -66,8 +66,8 @@ For example:
 - `Metric.unit` is ignored
 - `Metric` values are assigned field keys `gauge`, `counter`, `count`, `sum`, `inf`
   - Metric conversion follows Prometheus conventions for compatibility
-- `LogRecord.flags` is ignored
-  - This is an enum with no values defines yet
+- `flags` fields are ignored
+  - These are enum with no values defines yet
 
 ## Example Line Protocol
 

diff --git a/otel2influx/logs.go b/otel2influx/logs.go
@@ -102,7 +102,6 @@ func (c *OtelLogsToLineProtocol) enqueueLogRecord(ctx context.Context, resource
 	tags := make(map[string]string, len(c.logRecordDimensions)+2)
 	fields := make(map[string]interface{})
 
-	fields[common.AttributeFlags] = uint64(logRecord.Flags())
 	if ots := logRecord.ObservedTimestamp().AsTime(); !ots.IsZero() && !ots.Equal(time.Unix(0, 0)) {
 		fields[common.AttributeObservedTimeUnixNano] = ots.UnixNano()
 	}

diff --git a/otel2influx/metrics.go b/otel2influx/metrics.go
@@ -79,5 +79,4 @@ type basicDataPoint interface {
 	Timestamp() pcommon.Timestamp
 	StartTimestamp() pcommon.Timestamp
 	Attributes() pcommon.Map
-	Flags() pmetric.DataPointFlags
 }
diff --git a/otel2influx/metrics_otel_v1.go b/otel2influx/metrics_otel_v1.go
@@ -85,7 +85,6 @@ func (m *metricWriterOtelV1) enqueueSum(ctx context.Context, measurementName str
 
 	for i := 0; i < pm.Sum().DataPoints().Len(); i++ {
 		// TODO datapoint exemplars
-		// TODO datapoint flags
 		dataPoint := pm.Sum().DataPoints().At(i)
 
 		fields := make(map[string]interface{}, 3)
@@ -116,7 +115,6 @@ func (m *metricWriterOtelV1) enqueueHistogram(ctx context.Context, measurementNa
 
 	for i := 0; i < pm.Histogram().DataPoints().Len(); i++ {
 		// TODO datapoint exemplars
-		// TODO datapoint flags
 		dataPoint := pm.Histogram().DataPoints().At(i)
 
 		bucketCounts, explicitBounds := dataPoint.BucketCounts(), dataPoint.ExplicitBounds()

diff --git a/otel2influx/metrics_telegraf_prometheus_v1.go b/otel2influx/metrics_telegraf_prometheus_v1.go
@@ -49,7 +49,6 @@ func (c *metricWriterTelegrafPrometheusV1) initMetricTagsAndTimestamp(dataPoint
 	if dataPoint.StartTimestamp() != 0 {
 		fields[common.AttributeStartTimeUnixNano] = int64(dataPoint.StartTimestamp())
 	}
-	fields[common.AttributeFlags] = uint64(dataPoint.Flags())
 
 	tags = maps.Clone(tags)
 	dataPoint.Attributes().Range(func(k string, v pcommon.Value) bool {