fix(otelbench): add query type to report

go-faster · Dec 6, 2024 · 365247d · 365247d
1 parent 1acf68d
commit 365247d
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 0 deletions.
diff --git a/cmd/otelbench/logql_analyze.go b/cmd/otelbench/logql_analyze.go
@@ -89,6 +89,7 @@ func (a LogQLAnalyze) renderBenchstat(report logqlbench.LogQLReport, w io.Writer
 			Name: bytes.Join(
 				[][]byte{
 					[]byte(`LogQL`),
+					[]byte(q.Type),
 					name,
 				},
 				[]byte{'/'},

diff --git a/cmd/otelbench/logqlbench/logqlbench.go b/cmd/otelbench/logqlbench/logqlbench.go
@@ -136,6 +136,7 @@ func (p *LogQLBenchmark) Run(ctx context.Context) error {
 			header := tq.Meta.Header()
 			reports = append(reports, LogQLReportQuery{
 				ID:            header.ID,
+				Type:          string(tq.Meta.Type()),
 				Title:         header.Title,
 				Description:   header.Description,
 				Query:         tq.Meta.Query(),

diff --git a/cmd/otelbench/logqlbench/queries.go b/cmd/otelbench/logqlbench/queries.go
@@ -14,12 +14,24 @@ import (
 
 // Query is a benchmarked query.
 type Query interface {
+	Type() QueryType
 	Header() QueryHeader
 	Query() string
 	Matchers() []string
 	Execute(ctx context.Context, client *lokiapi.Client, p *LogQLBenchmark) error
 }
 
+// QueryType is a type of query.
+type QueryType string
+
+const (
+	InstantQueryType     QueryType = "instant"
+	RangeQueryType       QueryType = "range"
+	SeriesQueryType      QueryType = "series"
+	LabelsQueryType      QueryType = "labels"
+	LabelValuesQueryType QueryType = "label_values"
+)
+
 var _ = []Query{
 	&InstantQuery{},
 	&RangeQuery{},
@@ -44,6 +56,11 @@ type InstantQuery struct {
 	LogQL string `yaml:"query,omitempty"`
 }
 
+// Type returns the query type.
+func (q *InstantQuery) Type() QueryType {
+	return InstantQueryType
+}
+
 // Header returns the query header.
 func (q *InstantQuery) Header() QueryHeader {
 	return q.QueryHeader
@@ -91,6 +108,11 @@ type RangeQuery struct {
 	LogQL string        `yaml:"query,omitempty"`
 }
 
+// Type returns the query type.
+func (q *RangeQuery) Type() QueryType {
+	return RangeQueryType
+}
+
 // Header returns the query header.
 func (q *RangeQuery) Header() QueryHeader {
 	return q.QueryHeader
@@ -161,6 +183,11 @@ type SeriesQuery struct {
 	Match []string `yaml:"match,omitempty"`
 }
 
+// Type returns the query type.
+func (q *SeriesQuery) Type() QueryType {
+	return SeriesQueryType
+}
+
 // Header returns the query header.
 func (q *SeriesQuery) Header() QueryHeader {
 	return q.QueryHeader
@@ -210,6 +237,11 @@ type LabelsQuery struct {
 	End   string `yaml:"end,omitempty"`
 }
 
+// Type returns the query type.
+func (q *LabelsQuery) Type() QueryType {
+	return LabelsQueryType
+}
+
 // Header returns the query header.
 func (q *LabelsQuery) Header() QueryHeader {
 	return q.QueryHeader
@@ -260,6 +292,11 @@ type LabelValuesQuery struct {
 	Match string `yaml:"match,omitempty"`
 }
 
+// Type returns the query type.
+func (q *LabelValuesQuery) Type() QueryType {
+	return LabelValuesQueryType
+}
+
 // Header returns the query header.
 func (q *LabelValuesQuery) Header() QueryHeader {
 	return q.QueryHeader

diff --git a/cmd/otelbench/logqlbench/result.go b/cmd/otelbench/logqlbench/result.go
@@ -8,6 +8,7 @@ type LogQLReport struct {
 
 type LogQLReportQuery struct {
 	ID            int                     `yaml:"id,omitempty"`
+	Type          string                  `yaml:"type,omitempty"`
 	Query         string                  `yaml:"query,omitempty"`
 	Title         string                  `yaml:"title,omitempty"`
 	Description   string                  `yaml:"description,omitempty"`