Add descriptions to test cases

open-telemetry · Sep 12, 2022 · 38f428c · 38f428c
1 parent b05f8f5
commit 38f428c
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/exporters/prometheus/exporter_test.go b/exporters/prometheus/exporter_test.go
@@ -26,6 +26,7 @@ import (
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/stretchr/testify/require"
 
+	"go.opentelemetry.io/otel/metric/instrument"
 	"go.opentelemetry.io/otel/sdk/metric"
 
 	"go.opentelemetry.io/otel/attribute"
@@ -46,7 +47,7 @@ func TestPrometheusExporter(t *testing.T) {
 					attribute.Key("A").String("B"),
 					attribute.Key("C").String("D"),
 				}
-				counter, err := meter.SyncFloat64().Counter("foo")
+				counter, err := meter.SyncFloat64().Counter("foo", instrument.WithDescription("a simple counter"))
 				require.NoError(t, err)
 				counter.Add(ctx, 5, labels...)
 				counter.Add(ctx, 10.3, labels...)
@@ -61,7 +62,7 @@ func TestPrometheusExporter(t *testing.T) {
 					attribute.Key("A").String("B"),
 					attribute.Key("C").String("D"),
 				}
-				gauge, err := meter.SyncFloat64().UpDownCounter("bar")
+				gauge, err := meter.SyncFloat64().UpDownCounter("bar", instrument.WithDescription("a fun little gauge"))
 				require.NoError(t, err)
 				gauge.Add(ctx, 100, labels...)
 				gauge.Add(ctx, -25, labels...)
@@ -75,7 +76,7 @@ func TestPrometheusExporter(t *testing.T) {
 					attribute.Key("A").String("B"),
 					attribute.Key("C").String("D"),
 				}
-				histogram, err := meter.SyncFloat64().Histogram("baz")
+				histogram, err := meter.SyncFloat64().Histogram("baz", instrument.WithDescription("a very nice histogram"))
 				require.NoError(t, err)
 				histogram.Record(ctx, 23, labels...)
 				histogram.Record(ctx, 7, labels...)
@@ -106,6 +107,9 @@ func TestPrometheusExporter(t *testing.T) {
 
 			err = testutil.GatherAndCompare(registry, file)
 			require.NoError(t, err)
+
+			err = file.Close()
+			require.NoError(t, err)
 		})
 	}
 }
diff --git a/exporters/prometheus/testdata/counter.txt b/exporters/prometheus/testdata/counter.txt
@@ -1,3 +1,3 @@
-# HELP foo
+# HELP foo a simple counter
 # TYPE foo counter
 foo{A="B",C="D"} 24.3
diff --git a/exporters/prometheus/testdata/gauge.txt b/exporters/prometheus/testdata/gauge.txt
@@ -1,3 +1,3 @@
-# HELP bar
+# HELP bar a fun little gauge
 # TYPE bar counter
 bar{A="B",C="D"} 75
diff --git a/exporters/prometheus/testdata/histogram.txt b/exporters/prometheus/testdata/histogram.txt
@@ -1,4 +1,4 @@
-# HELP baz
+# HELP baz a very nice histogram
 # TYPE baz histogram
 baz_bucket{A="B",C="D",le="0"} 0
 baz_bucket{A="B",C="D",le="5"} 0