Skip to content

SigNoz is an open-source, OpenTelemetry-native observability platform for your team and their AI agents. Get logs, metrics, and traces in one tool with features like APM, distributed tracing, log management, infra monitoring, etc. Combined with SigNoz MCP and a native AI teammate (in SigNoz Cloud) it helps you build more resilient apps.

9.2 KB
Raw Blame
package querier

import (
	"context"
	"testing"

	"github.com/SigNoz/signoz/pkg/instrumentation/instrumentationtest"
	qbtypes "github.com/SigNoz/signoz/pkg/types/querybuildertypes/querybuildertypesv5"
	"github.com/SigNoz/signoz/pkg/types/telemetrytypes"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

// scalarInputResult builds a ScalarData result with one group column ("service")
// and one aggregation column ("__result"), holding the provided (service, value) rows.
func scalarInputResult(queryName string, rows []struct {
	service string
	value   float64
}) *qbtypes.Result {
	serviceKey := telemetrytypes.TelemetryFieldKey{
		Name:          "service",
		FieldDataType: telemetrytypes.FieldDataTypeString,
	}
	resultKey := telemetrytypes.TelemetryFieldKey{
		Name:          "__result",
		FieldDataType: telemetrytypes.FieldDataTypeFloat64,
	}

	data := make([][]any, 0, len(rows))
	for _, r := range rows {
		data = append(data, []any{r.service, r.value})
	}

	return &qbtypes.Result{
		Value: &qbtypes.ScalarData{
			QueryName: queryName,
			Columns: []*qbtypes.ColumnDescriptor{
				{
					TelemetryFieldKey: serviceKey,
					QueryName:         queryName,
					Type:              qbtypes.ColumnTypeGroup,
				},
				{
					TelemetryFieldKey: resultKey,
					QueryName:         queryName,
					AggregationIndex:  0,
					Type:              qbtypes.ColumnTypeAggregation,
				},
			},
			Data: data,
		},
	}
}

func TestProcessScalarFormula_AppliesOrderAndLimit(t *testing.T) {
	q := &querier{
		logger: instrumentationtest.New().Logger(),
	}

	// Mimic what a dashboard emits: orderBy keyed by the formula name ("F1"),
	// which applyFormulas rewrites to __result before sorting.
	orderByFormula := func(name string, dir qbtypes.OrderDirection) []qbtypes.OrderBy {
		return []qbtypes.OrderBy{
			{
				Key: qbtypes.OrderByKey{
					TelemetryFieldKey: telemetrytypes.TelemetryFieldKey{
						Name: name,
					},
				},
				Direction: dir,
			},
		}
	}

	// A+B per service: a=101, b=11, c=2
	makeInputs := func() map[string]*qbtypes.Result {
		return map[string]*qbtypes.Result{
			"A": scalarInputResult("A", []struct {
				service string
				value   float64
			}{
				{"a", 100},
				{"b", 10},
				{"c", 1},
			}),
			"B": scalarInputResult("B", []struct {
				service string
				value   float64
			}{
				{"a", 1},
				{"b", 0},
				{"c", 1},
			}),
		}
	}

	makeReq := func(formula qbtypes.QueryBuilderFormula) *qbtypes.QueryRangeRequest {
		return &qbtypes.QueryRangeRequest{
			RequestType: qbtypes.RequestTypeScalar,
			CompositeQuery: qbtypes.CompositeQuery{
				Queries: []qbtypes.QueryEnvelope{
					{Type: qbtypes.QueryTypeBuilder, Spec: qbtypes.QueryBuilderQuery[qbtypes.MetricAggregation]{Name: "A"}},
					{Type: qbtypes.QueryTypeBuilder, Spec: qbtypes.QueryBuilderQuery[qbtypes.MetricAggregation]{Name: "B"}},
					{Type: qbtypes.QueryTypeFormula, Spec: formula},
				},
			},
		}
	}

	t.Run("F1 desc with limit truncates and sorts", func(t *testing.T) {
		formula := qbtypes.QueryBuilderFormula{
			Name:       "F1",
			Expression: "A + B",
			Order:      orderByFormula("F1", qbtypes.OrderDirectionDesc),
			Limit:      2,
		}

		out := q.applyFormulas(context.Background(), makeInputs(), makeReq(formula))
		got, ok := out["F1"]
		require.True(t, ok, "formula result missing")
		scalar, ok := got.Value.(*qbtypes.ScalarData)
		require.True(t, ok, "expected *ScalarData, got %T", got.Value)

		// Limit=2 + F1 desc: the two largest __result rows in descending order.
		require.Len(t, scalar.Data, 2, "limit=2 was ignored before the fix")
		require.Equal(t, "a", scalar.Data[0][0])
		require.InDelta(t, 101.0, scalar.Data[0][1].(float64), 1e-9)
		require.Equal(t, "b", scalar.Data[1][0])
		require.InDelta(t, 10.0, scalar.Data[1][1].(float64), 1e-9)
	})

	t.Run("F1 desc without limit sorts all rows", func(t *testing.T) {
		formula := qbtypes.QueryBuilderFormula{
			Name:       "F1",
			Expression: "A / B",
			Order:      orderByFormula("F1", qbtypes.OrderDirectionAsc),
		}

		out := q.applyFormulas(context.Background(), makeInputs(), makeReq(formula))
		got, ok := out["F1"]
		require.True(t, ok)
		scalar, ok := got.Value.(*qbtypes.ScalarData)
		require.True(t, ok)

		require.Len(t, scalar.Data, 2)
		require.Equal(t, "c", scalar.Data[0][0])
		require.InDelta(t, 1.0, scalar.Data[0][1].(float64), 1e-9)
		require.Equal(t, "a", scalar.Data[1][0])
		require.InDelta(t, 100.0, scalar.Data[1][1].(float64), 1e-9)
	})
}

func TestPostProcessMetricQuery_LimitRanksByReducedValue(t *testing.T) {
	q := &querier{
		logger: instrumentationtest.New().Logger(),
	}

	serviceKey := telemetrytypes.TelemetryFieldKey{Name: "service.name", FieldDataType: telemetrytypes.FieldDataTypeString}
	series := func(service string, points ...float64) *qbtypes.TimeSeries {
		values := make([]*qbtypes.TimeSeriesValue, 0, len(points))
		for i, point := range points {
			values = append(values, &qbtypes.TimeSeriesValue{Timestamp: int64(i) * 60000, Value: point})
		}
		return &qbtypes.TimeSeries{Labels: []*qbtypes.Label{{Key: serviceKey, Value: service}}, Values: values}
	}
	// avg: checkout 10, payment 8.8, auth 6, search 2
	makeResult := func() *qbtypes.Result {
		return &qbtypes.Result{Value: &qbtypes.TimeSeriesData{
			QueryName: "A",
			Aggregations: []*qbtypes.AggregationBucket{{Series: []*qbtypes.TimeSeries{
				series("checkout", 10, 10, 10, 10, 10),
				series("payment", 1, 1, 1, 1, 40),
				series("auth", 0, 0, 0, 0, 30),
				series("search", 2, 2, 2, 2, 2),
			}}},
		}}
	}
	orderByValue := func(direction qbtypes.OrderDirection) []qbtypes.OrderBy {
		return []qbtypes.OrderBy{{
			Key:       qbtypes.OrderByKey{TelemetryFieldKey: telemetrytypes.TelemetryFieldKey{Name: qbtypes.DefaultOrderByKey}},
			Direction: direction,
		}}
	}

	testCases := []struct {
		name     string
		reduceTo qbtypes.ReduceTo
		order    []qbtypes.OrderBy
		expected [][]any
	}{
		{
			name:     "Max_Desc_KeepsHighestPeaks",
			reduceTo: qbtypes.ReduceToMax,
			order:    orderByValue(qbtypes.OrderDirectionDesc),
			expected: [][]any{{"payment", 40.0}, {"auth", 30.0}},
		},
		{
			name:     "Last_Desc_KeepsHighestLastPoints",
			reduceTo: qbtypes.ReduceToLast,
			order:    orderByValue(qbtypes.OrderDirectionDesc),
			expected: [][]any{{"payment", 40.0}, {"auth", 30.0}},
		},
		{
			name:     "Min_Asc_KeepsLowestMinimums",
			reduceTo: qbtypes.ReduceToMin,
			order:    orderByValue(qbtypes.OrderDirectionAsc),
			expected: [][]any{{"auth", 0.0}, {"payment", 1.0}},
		},
		{
			name:     "Max_NoOrder_DefaultsToDesc",
			reduceTo: qbtypes.ReduceToMax,
			expected: [][]any{{"payment", 40.0}, {"auth", 30.0}},
		},
	}

	for _, testCase := range testCases {
		t.Run(testCase.name, func(t *testing.T) {
			query := qbtypes.QueryBuilderQuery[qbtypes.MetricAggregation]{
				Name:         "A",
				Aggregations: []qbtypes.MetricAggregation{{MetricName: "http_requests_total", ReduceTo: testCase.reduceTo}},
				Order:        testCase.order,
				Limit:        2,
			}
			req := &qbtypes.QueryRangeRequest{RequestType: qbtypes.RequestTypeScalar}

			out := postProcessMetricQuery(q, makeResult(), query, req)
			scalar, ok := out.Value.(*qbtypes.ScalarData)
			require.True(t, ok, "expected *ScalarData, got %T", out.Value)

			assert.Equal(t, testCase.expected, scalar.Data)
		})
	}

	t.Run("TimeSeries_RanksByAverage", func(t *testing.T) {
		query := qbtypes.QueryBuilderQuery[qbtypes.MetricAggregation]{
			Name:         "A",
			Aggregations: []qbtypes.MetricAggregation{{MetricName: "http_requests_total"}},
			Order:        orderByValue(qbtypes.OrderDirectionDesc),
			Limit:        2,
		}
		req := &qbtypes.QueryRangeRequest{RequestType: qbtypes.RequestTypeTimeSeries}

		out := postProcessMetricQuery(q, makeResult(), query, req)
		tsData, ok := out.Value.(*qbtypes.TimeSeriesData)
		require.True(t, ok, "expected *TimeSeriesData, got %T", out.Value)
		require.Len(t, tsData.Aggregations, 1)
		require.Len(t, tsData.Aggregations[0].Series, 2)

		assert.Equal(t, "checkout", tsData.Aggregations[0].Series[0].Labels[0].Value)
		assert.Equal(t, "payment", tsData.Aggregations[0].Series[1].Labels[0].Value)
	})
}

// Multiple series with different number of labels, shouldn't panic and should align labels correctly.
func TestConvertTimeSeriesDataToScalar_RaggedLabels(t *testing.T) {
	label := func(name string, value any) *qbtypes.Label {
		return &qbtypes.Label{
			Key:   telemetrytypes.TelemetryFieldKey{Name: name},
			Value: value,
		}
	}
	series := func(labels []*qbtypes.Label, value float64) *qbtypes.TimeSeries {
		return &qbtypes.TimeSeries{
			Labels: labels,
			Values: []*qbtypes.TimeSeriesValue{{Timestamp: 1, Value: value}},
		}
	}

	tsData := &qbtypes.TimeSeriesData{
		QueryName: "A",
		Aggregations: []*qbtypes.AggregationBucket{{
			Index: 0,
			Series: []*qbtypes.TimeSeries{
				series([]*qbtypes.Label{label("label_1", "orphan-0")}, 20),
				series([]*qbtypes.Label{label("label_1", "box-0"), label("label_2", "rpc-0")}, 10),
			},
		}},
	}

	var sd *qbtypes.ScalarData
	require.NotPanics(t, func() {
		sd = convertTimeSeriesDataToScalar(tsData, "A")
	})

	require.NotNil(t, sd)
	require.Len(t, sd.Columns, 3)
	assert.Equal(t, "label_1", sd.Columns[0].Name)
	assert.Equal(t, "label_2", sd.Columns[1].Name)
	assert.Equal(t, "__result_0", sd.Columns[2].Name)

	require.Len(t, sd.Data, 2)
	assert.Equal(t, []any{"orphan-0", nil, 20.0}, sd.Data[0])
	assert.Equal(t, []any{"box-0", "rpc-0", 10.0}, sd.Data[1])
}