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.

fix(dashboards-v2): round-trip zero-valued threshold + query fields (#12158)

Pandey22e55340d7db
diff --git a/docs/api/openapi.yml b/docs/api/openapi.yml
index adfe29615a..a3328c260c 100644
--- a/docs/api/openapi.yml
+++ b/docs/api/openapi.yml
@@ -3039,6 +3039,7 @@ components:
selectFields:
items:
$ref: '#/components/schemas/TelemetrytypesTelemetryFieldKey'
+ nullable: true
type: array
type: object
DashboardtypesListSort:
@@ -6552,6 +6553,7 @@ components:
args:
items:
$ref: '#/components/schemas/Querybuildertypesv5FunctionArg'
+ nullable: true
type: array
name:
$ref: '#/components/schemas/Querybuildertypesv5FunctionName'
@@ -6722,6 +6724,7 @@ components:
functions:
items:
$ref: '#/components/schemas/Querybuildertypesv5Function'
+ nullable: true
type: array
having:
$ref: '#/components/schemas/Querybuildertypesv5Having'
@@ -6734,6 +6737,7 @@ components:
order:
items:
$ref: '#/components/schemas/Querybuildertypesv5OrderBy'
+ nullable: true
type: array
type: object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation:
@@ -6741,6 +6745,7 @@ components:
aggregations:
items:
$ref: '#/components/schemas/Querybuildertypesv5LogAggregation'
+ nullable: true
type: array
cursor:
type: string
@@ -6751,10 +6756,12 @@ components:
functions:
items:
$ref: '#/components/schemas/Querybuildertypesv5Function'
+ nullable: true
type: array
groupBy:
items:
$ref: '#/components/schemas/Querybuildertypesv5GroupByKey'
+ nullable: true
type: array
having:
$ref: '#/components/schemas/Querybuildertypesv5Having'
@@ -6771,14 +6778,17 @@ components:
order:
items:
$ref: '#/components/schemas/Querybuildertypesv5OrderBy'
+ nullable: true
type: array
secondaryAggregations:
items:
$ref: '#/components/schemas/Querybuildertypesv5SecondaryAggregation'
+ nullable: true
type: array
selectFields:
items:
$ref: '#/components/schemas/TelemetrytypesTelemetryFieldKey'
+ nullable: true
type: array
signal:
enum:
@@ -6796,6 +6806,7 @@ components:
aggregations:
items:
$ref: '#/components/schemas/Querybuildertypesv5MetricAggregation'
+ nullable: true
type: array
cursor:
type: string
@@ -6806,10 +6817,12 @@ components:
functions:
items:
$ref: '#/components/schemas/Querybuildertypesv5Function'
+ nullable: true
type: array
groupBy:
items:
$ref: '#/components/schemas/Querybuildertypesv5GroupByKey'
+ nullable: true
type: array
having:
$ref: '#/components/schemas/Querybuildertypesv5Having'
@@ -6826,14 +6839,17 @@ components:
order:
items:
$ref: '#/components/schemas/Querybuildertypesv5OrderBy'
+ nullable: true
type: array
secondaryAggregations:
items:
$ref: '#/components/schemas/Querybuildertypesv5SecondaryAggregation'
+ nullable: true
type: array
selectFields:
items:
$ref: '#/components/schemas/TelemetrytypesTelemetryFieldKey'
+ nullable: true
type: array
signal:
enum:
@@ -6851,6 +6867,7 @@ components:
aggregations:
items:
$ref: '#/components/schemas/Querybuildertypesv5TraceAggregation'
+ nullable: true
type: array
cursor:
type: string
@@ -6861,10 +6878,12 @@ components:
functions:
items:
$ref: '#/components/schemas/Querybuildertypesv5Function'
+ nullable: true
type: array
groupBy:
items:
$ref: '#/components/schemas/Querybuildertypesv5GroupByKey'
+ nullable: true
type: array
having:
$ref: '#/components/schemas/Querybuildertypesv5Having'
@@ -6881,14 +6900,17 @@ components:
order:
items:
$ref: '#/components/schemas/Querybuildertypesv5OrderBy'
+ nullable: true
type: array
secondaryAggregations:
items:
$ref: '#/components/schemas/Querybuildertypesv5SecondaryAggregation'
+ nullable: true
type: array
selectFields:
items:
$ref: '#/components/schemas/TelemetrytypesTelemetryFieldKey'
+ nullable: true
type: array
signal:
enum:
@@ -6906,6 +6928,7 @@ components:
aggregations:
items:
$ref: '#/components/schemas/Querybuildertypesv5TraceAggregation'
+ nullable: true
type: array
cursor:
type: string
@@ -6918,10 +6941,12 @@ components:
functions:
items:
$ref: '#/components/schemas/Querybuildertypesv5Function'
+ nullable: true
type: array
groupBy:
items:
$ref: '#/components/schemas/Querybuildertypesv5GroupByKey'
+ nullable: true
type: array
having:
$ref: '#/components/schemas/Querybuildertypesv5Having'
@@ -6936,12 +6961,14 @@ components:
order:
items:
$ref: '#/components/schemas/Querybuildertypesv5OrderBy'
+ nullable: true
type: array
returnSpansFrom:
type: string
selectFields:
items:
$ref: '#/components/schemas/TelemetrytypesTelemetryFieldKey'
+ nullable: true
type: array
stepInterval:
$ref: '#/components/schemas/Querybuildertypesv5Step'
@@ -7181,6 +7208,7 @@ components:
groupBy:
items:
$ref: '#/components/schemas/Querybuildertypesv5GroupByKey'
+ nullable: true
type: array
limit:
type: integer
@@ -7189,6 +7217,7 @@ components:
order:
items:
$ref: '#/components/schemas/Querybuildertypesv5OrderBy'
+ nullable: true
type: array
stepInterval:
$ref: '#/components/schemas/Querybuildertypesv5Step'
diff --git a/frontend/src/api/generated/services/sigNoz.schemas.ts b/frontend/src/api/generated/services/sigNoz.schemas.ts
index 45225fccc4..6bc5b790ec 100644
--- a/frontend/src/api/generated/services/sigNoz.schemas.ts
+++ b/frontend/src/api/generated/services/sigNoz.schemas.ts
@@ -3489,9 +3489,9 @@ export enum Querybuildertypesv5FunctionNameDTO {
}
export interface Querybuildertypesv5FunctionDTO {
/**
- * @type array
+ * @type array,null
*/
- args?: Querybuildertypesv5FunctionArgDTO[];
+ args?: Querybuildertypesv5FunctionArgDTO[] | null;
name?: Querybuildertypesv5FunctionNameDTO;
}
@@ -3593,18 +3593,18 @@ export interface Querybuildertypesv5SecondaryAggregationDTO {
*/
expression?: string;
/**
- * @type array
+ * @type array,null
*/
- groupBy?: Querybuildertypesv5GroupByKeyDTO[];
+ groupBy?: Querybuildertypesv5GroupByKeyDTO[] | null;
/**
* @type integer
*/
limit?: number;
limitBy?: Querybuildertypesv5LimitByDTO;
/**
- * @type array
+ * @type array,null
*/
- order?: Querybuildertypesv5OrderByDTO[];
+ order?: Querybuildertypesv5OrderByDTO[] | null;
stepInterval?: Querybuildertypesv5StepDTO;
}
@@ -3634,9 +3634,9 @@ export enum TelemetrytypesSourceDTO {
}
export interface Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregationDTO {
/**
- * @type array
+ * @type array,null
*/
- aggregations?: Querybuildertypesv5LogAggregationDTO[];
+ aggregations?: Querybuildertypesv5LogAggregationDTO[] | null;
/**
* @type string
*/
@@ -3647,13 +3647,13 @@ export interface Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTyp
disabled?: boolean;
filter?: Querybuildertypesv5FilterDTO;
/**
- * @type array
+ * @type array,null
*/
- functions?: Querybuildertypesv5FunctionDTO[];
+ functions?: Querybuildertypesv5FunctionDTO[] | null;
/**
- * @type array
+ * @type array,null
*/
- groupBy?: Querybuildertypesv5GroupByKeyDTO[];
+ groupBy?: Querybuildertypesv5GroupByKeyDTO[] | null;
having?: Querybuildertypesv5HavingDTO;
/**
* @type string
@@ -3673,17 +3673,17 @@ export interface Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTyp
*/
offset?: number;
/**
- * @type array
+ * @type array,null
*/
- order?: Querybuildertypesv5OrderByDTO[];
+ order?: Querybuildertypesv5OrderByDTO[] | null;
/**
- * @type array
+ * @type array,null
*/
- secondaryAggregations?: Querybuildertypesv5SecondaryAggregationDTO[];
+ secondaryAggregations?: Querybuildertypesv5SecondaryAggregationDTO[] | null;
/**
- * @type array
+ * @type array,null
*/
- selectFields?: TelemetrytypesTelemetryFieldKeyDTO[];
+ selectFields?: TelemetrytypesTelemetryFieldKeyDTO[] | null;
/**
* @enum logs
* @type string
@@ -3759,9 +3759,9 @@ export enum Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQue
}
export interface Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregationDTO {
/**
- * @type array
+ * @type array,null
*/
- aggregations?: Querybuildertypesv5MetricAggregationDTO[];
+ aggregations?: Querybuildertypesv5MetricAggregationDTO[] | null;
/**
* @type string
*/
@@ -3772,13 +3772,13 @@ export interface Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTyp
disabled?: boolean;
filter?: Querybuildertypesv5FilterDTO;
/**
- * @type array
+ * @type array,null
*/
- functions?: Querybuildertypesv5FunctionDTO[];
+ functions?: Querybuildertypesv5FunctionDTO[] | null;
/**
- * @type array
+ * @type array,null
*/
- groupBy?: Querybuildertypesv5GroupByKeyDTO[];
+ groupBy?: Querybuildertypesv5GroupByKeyDTO[] | null;
having?: Querybuildertypesv5HavingDTO;
/**
* @type string
@@ -3798,17 +3798,17 @@ export interface Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTyp
*/
offset?: number;
/**
- * @type array
+ * @type array,null
*/
- order?: Querybuildertypesv5OrderByDTO[];
+ order?: Querybuildertypesv5OrderByDTO[] | null;
/**
- * @type array
+ * @type array,null
*/
- secondaryAggregations?: Querybuildertypesv5SecondaryAggregationDTO[];
+ secondaryAggregations?: Querybuildertypesv5SecondaryAggregationDTO[] | null;
/**
- * @type array
+ * @type array,null
*/
- selectFields?: TelemetrytypesTelemetryFieldKeyDTO[];
+ selectFields?: TelemetrytypesTelemetryFieldKeyDTO[] | null;
/**
* @enum metrics
* @type string
@@ -3834,9 +3834,9 @@ export enum Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQue
}
export interface Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregationDTO {
/**
- * @type array
+ * @type array,null
*/
- aggregations?: Querybuildertypesv5TraceAggregationDTO[];
+ aggregations?: Querybuildertypesv5TraceAggregationDTO[] | null;
/**
* @type string
*/
@@ -3847,13 +3847,13 @@ export interface Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTyp
disabled?: boolean;
filter?: Querybuildertypesv5FilterDTO;
/**
- * @type array
+ * @type array,null
*/
- functions?: Querybuildertypesv5FunctionDTO[];
+ functions?: Querybuildertypesv5FunctionDTO[] | null;
/**
- * @type array
+ * @type array,null
*/
- groupBy?: Querybuildertypesv5GroupByKeyDTO[];
+ groupBy?: Querybuildertypesv5GroupByKeyDTO[] | null;
having?: Querybuildertypesv5HavingDTO;
/**
* @type string
@@ -3873,17 +3873,17 @@ export interface Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTyp
*/
offset?: number;
/**
- * @type array
+ * @type array,null
*/
- order?: Querybuildertypesv5OrderByDTO[];
+ order?: Querybuildertypesv5OrderByDTO[] | null;
/**
- * @type array
+ * @type array,null
*/
- secondaryAggregations?: Querybuildertypesv5SecondaryAggregationDTO[];
+ secondaryAggregations?: Querybuildertypesv5SecondaryAggregationDTO[] | null;
/**
- * @type array
+ * @type array,null
*/
- selectFields?: TelemetrytypesTelemetryFieldKeyDTO[];
+ selectFields?: TelemetrytypesTelemetryFieldKeyDTO[] | null;
/**
* @enum traces
* @type string
@@ -4272,9 +4272,9 @@ export enum DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboa
}
export interface DashboardtypesListPanelSpecDTO {
/**
- * @type array
+ * @type array,null
*/
- selectFields?: TelemetrytypesTelemetryFieldKeyDTO[];
+ selectFields?: TelemetrytypesTelemetryFieldKeyDTO[] | null;
}
export interface DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesListPanelSpecDTO {
@@ -4344,9 +4344,9 @@ export interface Querybuildertypesv5QueryBuilderFormulaDTO {
*/
expression?: string;
/**
- * @type array
+ * @type array,null
*/
- functions?: Querybuildertypesv5FunctionDTO[];
+ functions?: Querybuildertypesv5FunctionDTO[] | null;
having?: Querybuildertypesv5HavingDTO;
/**
* @type string
@@ -4361,9 +4361,9 @@ export interface Querybuildertypesv5QueryBuilderFormulaDTO {
*/
name?: string;
/**
- * @type array
+ * @type array,null
*/
- order?: Querybuildertypesv5OrderByDTO[];
+ order?: Querybuildertypesv5OrderByDTO[] | null;
}
export enum Querybuildertypesv5QueryEnvelopeFormulaDTOType {
@@ -4380,9 +4380,9 @@ export interface Querybuildertypesv5QueryEnvelopeFormulaDTO {
export interface Querybuildertypesv5QueryBuilderTraceOperatorDTO {
/**
- * @type array
+ * @type array,null
*/
- aggregations?: Querybuildertypesv5TraceAggregationDTO[];
+ aggregations?: Querybuildertypesv5TraceAggregationDTO[] | null;
/**
* @type string
*/
@@ -4397,13 +4397,13 @@ export interface Querybuildertypesv5QueryBuilderTraceOperatorDTO {
expression?: string;
filter?: Querybuildertypesv5FilterDTO;
/**
- * @type array
+ * @type array,null
*/
- functions?: Querybuildertypesv5FunctionDTO[];
+ functions?: Querybuildertypesv5FunctionDTO[] | null;
/**
- * @type array
+ * @type array,null
*/
- groupBy?: Querybuildertypesv5GroupByKeyDTO[];
+ groupBy?: Querybuildertypesv5GroupByKeyDTO[] | null;
having?: Querybuildertypesv5HavingDTO;
/**
* @type string
@@ -4422,17 +4422,17 @@ export interface Querybuildertypesv5QueryBuilderTraceOperatorDTO {
*/
offset?: number;
/**
- * @type array
+ * @type array,null
*/
- order?: Querybuildertypesv5OrderByDTO[];
+ order?: Querybuildertypesv5OrderByDTO[] | null;
/**
* @type string
*/
returnSpansFrom?: string;
/**
- * @type array
+ * @type array,null
*/
- selectFields?: TelemetrytypesTelemetryFieldKeyDTO[];
+ selectFields?: TelemetrytypesTelemetryFieldKeyDTO[] | null;
stepInterval?: Querybuildertypesv5StepDTO;
}
diff --git a/pkg/types/dashboardtypes/perses_dashboard_test.go b/pkg/types/dashboardtypes/perses_dashboard_test.go
index e86e40cea1..5599f7e1b0 100644
--- a/pkg/types/dashboardtypes/perses_dashboard_test.go
+++ b/pkg/types/dashboardtypes/perses_dashboard_test.go
@@ -1018,21 +1018,14 @@ func TestValidateRequiredFields(t *testing.T) {
data: wrapVariable("signoz/CustomVariable", `{}`),
wantContain: "CustomValue",
},
- {
- name: "ThresholdWithLabel missing value",
- data: wrapPanel("signoz/TimeSeriesPanel", `{"thresholds": [{"color": "Red", "label": "high"}]}`),
- wantContain: "Value",
- },
+ // Value is intentionally not validate:"required" — 0 is a legitimate threshold
+ // (go-playground's required rejects a zero float), so a missing/zero value is
+ // accepted and only Color remains required on these threshold structs.
{
name: "ThresholdWithLabel missing color",
data: wrapPanel("signoz/TimeSeriesPanel", `{"thresholds": [{"value": 100, "label": "high", "color": ""}]}`),
wantContain: "Color",
},
- {
- name: "ComparisonThreshold missing value",
- data: wrapPanel("signoz/NumberPanel", `{"thresholds": [{"operator": "above", "format": "text", "color": "Red"}]}`),
- wantContain: "Value",
- },
{
name: "ComparisonThreshold missing color",
data: wrapPanel("signoz/NumberPanel", `{"thresholds": [{"value": 100, "operator": "above", "format": "text", "color": ""}]}`),
diff --git a/pkg/types/dashboardtypes/perses_signoz_plugins.go b/pkg/types/dashboardtypes/perses_signoz_plugins.go
index 20b7903d8f..bd456c9884 100644
--- a/pkg/types/dashboardtypes/perses_signoz_plugins.go
+++ b/pkg/types/dashboardtypes/perses_signoz_plugins.go
@@ -207,7 +207,7 @@ type HistogramBuckets struct {
}
type ListPanelSpec struct {
- SelectFields []telemetrytypes.TelemetryFieldKey `json:"selectFields,omitempty" validate:"dive"`
+ SelectFields []telemetrytypes.TelemetryFieldKey `json:"selectFields,omitzero" validate:"dive"`
}
// ══════════════════════════════════════════════
@@ -252,14 +252,20 @@ type Legend struct {
}
type ThresholdWithLabel struct {
- Value float64 `json:"value" validate:"required" required:"true"`
+ // Value is always present in the schema (required:"true"), but 0 is a legitimate
+ // threshold, so it drops validate:"required" — go-playground's required treats a
+ // zero float as unset and would wrongly reject value: 0.
+ Value float64 `json:"value" required:"true"`
Unit string `json:"unit"`
Color string `json:"color" validate:"required" required:"true"`
Label string `json:"label"`
}
type ComparisonThreshold struct {
- Value float64 `json:"value" validate:"required" required:"true"`
+ // Value is always present in the schema (required:"true"), but 0 is a legitimate
+ // threshold, so it drops validate:"required" — go-playground's required treats a
+ // zero float as unset and would wrongly reject value: 0.
+ Value float64 `json:"value" required:"true"`
Operator ComparisonOperator `json:"operator"`
Unit string `json:"unit"`
Color string `json:"color" validate:"required" required:"true"`
diff --git a/pkg/types/querybuildertypes/querybuildertypesv5/builder_elements.go b/pkg/types/querybuildertypes/querybuildertypesv5/builder_elements.go
index 1fb8a70588..bac993d8fa 100644
--- a/pkg/types/querybuildertypes/querybuildertypesv5/builder_elements.go
+++ b/pkg/types/querybuildertypes/querybuildertypesv5/builder_elements.go
@@ -619,9 +619,9 @@ type SecondaryAggregation struct {
// if any, it will be used as the alias of the aggregation in the result
Alias string `json:"alias,omitempty"`
// groupBy fields to group by
- GroupBy []GroupByKey `json:"groupBy,omitempty"`
+ GroupBy []GroupByKey `json:"groupBy,omitzero"`
// order by keys and directions
- Order []OrderBy `json:"order,omitempty"`
+ Order []OrderBy `json:"order,omitzero"`
// limit the maximum number of rows to return
Limit int `json:"limit,omitempty"`
// limitBy fields to limit by
@@ -691,7 +691,7 @@ type Function struct {
Name FunctionName `json:"name"`
// args is the arguments to the function
- Args []FunctionArg `json:"args,omitempty"`
+ Args []FunctionArg `json:"args,omitzero"`
}
// Copy creates a deep copy of Function.
diff --git a/pkg/types/querybuildertypes/querybuildertypesv5/builder_query.go b/pkg/types/querybuildertypes/querybuildertypesv5/builder_query.go
index e6e4a94e26..c49e91c10e 100644
--- a/pkg/types/querybuildertypes/querybuildertypesv5/builder_query.go
+++ b/pkg/types/querybuildertypes/querybuildertypesv5/builder_query.go
@@ -26,22 +26,22 @@ type QueryBuilderQuery[T any] struct {
// we want to support multiple aggregations
// currently supported: []Aggregation, []MetricAggregation
- Aggregations []T `json:"aggregations,omitempty"`
+ Aggregations []T `json:"aggregations,omitzero"`
// disabled if true, the query will not be executed
- Disabled bool `json:"disabled,omitempty"`
+ Disabled bool `json:"disabled"`
// search query is simple string
Filter *Filter `json:"filter,omitempty"`
// group by keys to group by
- GroupBy []GroupByKey `json:"groupBy,omitempty"`
+ GroupBy []GroupByKey `json:"groupBy,omitzero"`
// order by keys and directions
- Order []OrderBy `json:"order,omitempty"`
+ Order []OrderBy `json:"order,omitzero"`
// select columns to select
- SelectFields []telemetrytypes.TelemetryFieldKey `json:"selectFields,omitempty"`
+ SelectFields []telemetrytypes.TelemetryFieldKey `json:"selectFields,omitzero"`
// limit the maximum number of rows to return
Limit int `json:"limit,omitempty"`
@@ -61,12 +61,12 @@ type QueryBuilderQuery[T any] struct {
// secondary aggregation to apply to the query
// on top of the primary aggregation
- SecondaryAggregations []SecondaryAggregation `json:"secondaryAggregations,omitempty"`
+ SecondaryAggregations []SecondaryAggregation `json:"secondaryAggregations,omitzero"`
// functions to apply to the query
- Functions []Function `json:"functions,omitempty"`
+ Functions []Function `json:"functions,omitzero"`
- Legend string `json:"legend,omitempty"`
+ Legend string `json:"legend"`
// ShiftBy is extracted from timeShift function for internal use
// This field is not serialized to JSON
diff --git a/pkg/types/querybuildertypes/querybuildertypesv5/clickhouse_query.go b/pkg/types/querybuildertypes/querybuildertypesv5/clickhouse_query.go
index 523a3b168b..4bc3704dc1 100644
--- a/pkg/types/querybuildertypes/querybuildertypesv5/clickhouse_query.go
+++ b/pkg/types/querybuildertypes/querybuildertypesv5/clickhouse_query.go
@@ -8,7 +8,7 @@ type ClickHouseQuery struct {
// disabled if true, the query will not be executed
Disabled bool `json:"disabled"`
- Legend string `json:"legend,omitempty"`
+ Legend string `json:"legend"`
}
// Copy creates a deep copy of the ClickHouseQuery.
diff --git a/pkg/types/querybuildertypes/querybuildertypesv5/formula.go b/pkg/types/querybuildertypes/querybuildertypesv5/formula.go
index 7c9846541e..df1c51cfaa 100644
--- a/pkg/types/querybuildertypes/querybuildertypesv5/formula.go
+++ b/pkg/types/querybuildertypes/querybuildertypesv5/formula.go
@@ -22,10 +22,10 @@ type QueryBuilderFormula struct {
// expression to apply to the query
Expression string `json:"expression"`
- Disabled bool `json:"disabled,omitempty"`
+ Disabled bool `json:"disabled"`
// order by keys and directions
- Order []OrderBy `json:"order,omitempty"`
+ Order []OrderBy `json:"order,omitzero"`
// limit the maximum number of rows to return
Limit int `json:"limit,omitempty"`
@@ -34,9 +34,9 @@ type QueryBuilderFormula struct {
Having *Having `json:"having,omitempty"`
// functions to apply to the formula result
- Functions []Function `json:"functions,omitempty"`
+ Functions []Function `json:"functions,omitzero"`
- Legend string `json:"legend,omitempty"`
+ Legend string `json:"legend"`
}
// Copy creates a deep copy of the QueryBuilderFormula.
diff --git a/pkg/types/querybuildertypes/querybuildertypesv5/join.go b/pkg/types/querybuildertypes/querybuildertypesv5/join.go
index 31fab0e887..e757ad05c9 100644
--- a/pkg/types/querybuildertypes/querybuildertypesv5/join.go
+++ b/pkg/types/querybuildertypes/querybuildertypesv5/join.go
@@ -38,7 +38,7 @@ func (q QueryRef) Copy() QueryRef {
type QueryBuilderJoin struct {
Name string `json:"name"`
- Disabled bool `json:"disabled,omitempty"`
+ Disabled bool `json:"disabled"`
// references into flat registry of queries
Left QueryRef `json:"left"`
@@ -50,18 +50,18 @@ type QueryBuilderJoin struct {
// primary aggregations: if empty ⇒ raw columns. Untyped — joins are deferred
// (see the commented JoinAggregation below).
- Aggregations []any `json:"aggregations,omitempty"`
+ Aggregations []any `json:"aggregations,omitzero"`
// select columns to select
- SelectFields []telemetrytypes.TelemetryFieldKey `json:"selectFields,omitempty"`
+ SelectFields []telemetrytypes.TelemetryFieldKey `json:"selectFields,omitzero"`
// post-join clauses (also used for aggregated joins)
Filter *Filter `json:"filter,omitempty"`
- GroupBy []GroupByKey `json:"groupBy,omitempty"`
+ GroupBy []GroupByKey `json:"groupBy,omitzero"`
Having *Having `json:"having,omitempty"`
- Order []OrderBy `json:"order,omitempty"`
+ Order []OrderBy `json:"order,omitzero"`
Limit int `json:"limit,omitempty"`
- SecondaryAggregations []SecondaryAggregation `json:"secondaryAggregations,omitempty"`
- Functions []Function `json:"functions,omitempty"`
+ SecondaryAggregations []SecondaryAggregation `json:"secondaryAggregations,omitzero"`
+ Functions []Function `json:"functions,omitzero"`
}
// JoinAggregation modelled a join aggregation as a trace/log/metric oneOf. Deferred:
diff --git a/pkg/types/querybuildertypes/querybuildertypesv5/prom_query.go b/pkg/types/querybuildertypes/querybuildertypesv5/prom_query.go
index b5b17181f7..3644427fe0 100644
--- a/pkg/types/querybuildertypes/querybuildertypesv5/prom_query.go
+++ b/pkg/types/querybuildertypes/querybuildertypesv5/prom_query.go
@@ -12,7 +12,7 @@ type PromQuery struct {
// stats if true, the query will return stats
Stats bool `json:"stats"`
- Legend string `json:"legend,omitempty"`
+ Legend string `json:"legend"`
}
// Copy creates a deep copy of the PromQuery.
diff --git a/pkg/types/querybuildertypes/querybuildertypesv5/trace_operator.go b/pkg/types/querybuildertypes/querybuildertypesv5/trace_operator.go
index 57155ef991..c9080b9617 100644
--- a/pkg/types/querybuildertypes/querybuildertypesv5/trace_operator.go
+++ b/pkg/types/querybuildertypes/querybuildertypesv5/trace_operator.go
@@ -38,7 +38,7 @@ const (
type QueryBuilderTraceOperator struct {
Name string `json:"name"`
- Disabled bool `json:"disabled,omitempty"`
+ Disabled bool `json:"disabled"`
Expression string `json:"expression"`
@@ -48,11 +48,11 @@ type QueryBuilderTraceOperator struct {
ReturnSpansFrom string `json:"returnSpansFrom,omitempty"`
// Trace-specific ordering (only span_count and trace_duration allowed)
- Order []OrderBy `json:"order,omitempty"`
+ Order []OrderBy `json:"order,omitzero"`
- Aggregations []TraceAggregation `json:"aggregations,omitempty"`
+ Aggregations []TraceAggregation `json:"aggregations,omitzero"`
StepInterval Step `json:"stepInterval,omitempty"`
- GroupBy []GroupByKey `json:"groupBy,omitempty"`
+ GroupBy []GroupByKey `json:"groupBy,omitzero"`
// having clause to apply to the aggregated query results
Having *Having `json:"having,omitempty"`
@@ -61,11 +61,11 @@ type QueryBuilderTraceOperator struct {
Offset int `json:"offset,omitempty"`
Cursor string `json:"cursor,omitempty"`
- Legend string `json:"legend,omitempty"`
+ Legend string `json:"legend"`
// Other post-processing options
- SelectFields []telemetrytypes.TelemetryFieldKey `json:"selectFields,omitempty"`
- Functions []Function `json:"functions,omitempty"`
+ SelectFields []telemetrytypes.TelemetryFieldKey `json:"selectFields,omitzero"`
+ Functions []Function `json:"functions,omitzero"`
// Internal parsed representation (not exposed in JSON)
ParsedExpression *TraceOperand `json:"-"`
diff --git a/tests/integration/tests/dashboard/03_v2_dashboard.py b/tests/integration/tests/dashboard/03_v2_dashboard.py
index 4a515a64b7..1bd94f161d 100644
--- a/tests/integration/tests/dashboard/03_v2_dashboard.py
+++ b/tests/integration/tests/dashboard/03_v2_dashboard.py
@@ -1561,3 +1561,192 @@ def test_dashboard_v2_rejects_comma_separated_aggregation(
headers={"Authorization": f"Bearer {token}"},
timeout=5,
)
+
+
+# ─── round-trip serialization of zero-valued fields ──────────────────────────
+# A minimal dashboard stripped from SigNoz/dashboards (cicd-perses.json), whose
+# NumberPanel carries a real `threshold value: 0`. It packs every field whose zero
+# value the create -> GET round-trip must preserve: thresholds with value 0 (which
+# the required-tag validation used to reject on create), builder slices set to an
+# explicit [] that must echo back as [] (yet stay absent, never null, when unset),
+# and scalars disabled/legend that must always echo false/"".
+
+
+def test_dashboard_v2_roundtrip_preserves_zero_values(
+ signoz: SigNoz,
+ create_user_admin: Operation, # pylint: disable=unused-argument
+ get_token: Callable[[str, str], str],
+):
+ token = get_token(USER_ADMIN_EMAIL, USER_ADMIN_PASSWORD)
+ headers = {"Authorization": f"Bearer {token}"}
+
+ dashboard = {
+ "schemaVersion": "v6",
+ "name": "roundtrip-zero-values",
+ "tags": [],
+ "spec": {
+ "display": {"name": "Roundtrip Zero Values"},
+ "panels": {
+ # NumberPanel: ComparisonThreshold value 0 + a builder query whose
+ # zero-valued slices/scalars are all set explicitly.
+ "number": {
+ "kind": "Panel",
+ "spec": {
+ "display": {"name": "number"},
+ "plugin": {
+ "kind": "signoz/NumberPanel",
+ "spec": {"thresholds": [{"value": 0, "operator": "above_or_equal", "color": "#c2780b", "format": "background"}]},
+ },
+ "queries": [
+ {
+ "kind": "scalar",
+ "spec": {
+ "plugin": {
+ "kind": "signoz/BuilderQuery",
+ "spec": {
+ "name": "A",
+ "signal": "logs",
+ "aggregations": [{"expression": "count()"}],
+ "disabled": False,
+ "legend": "",
+ "groupBy": [],
+ "order": [],
+ "selectFields": [],
+ "functions": [],
+ },
+ }
+ },
+ }
+ ],
+ },
+ },
+ # TimeSeriesPanel: ThresholdWithLabel value 0 + a bare builder query
+ # whose unset slices must be omitted (not null) on read-back.
+ "timeseries": {
+ "kind": "Panel",
+ "spec": {
+ "display": {"name": "timeseries"},
+ "plugin": {
+ "kind": "signoz/TimeSeriesPanel",
+ "spec": {"thresholds": [{"value": 0, "color": "#c2780b"}]},
+ },
+ "queries": [
+ {
+ "kind": "time_series",
+ "spec": {
+ "plugin": {
+ "kind": "signoz/BuilderQuery",
+ "spec": {"name": "A", "signal": "logs", "aggregations": [{"expression": "count()"}]},
+ }
+ },
+ }
+ ],
+ },
+ },
+ # PromQL query: legend/disabled must echo "" / false.
+ "promql": {
+ "kind": "Panel",
+ "spec": {
+ "display": {"name": "promql"},
+ "plugin": {"kind": "signoz/TimeSeriesPanel", "spec": {}},
+ "queries": [
+ {
+ "kind": "time_series",
+ "spec": {
+ "plugin": {
+ "kind": "signoz/PromQLQuery",
+ "spec": {"name": "A", "query": "up", "disabled": False, "legend": ""},
+ }
+ },
+ }
+ ],
+ },
+ },
+ # ClickHouse query: legend/disabled must echo "" / false.
+ "clickhouse": {
+ "kind": "Panel",
+ "spec": {
+ "display": {"name": "clickhouse"},
+ "plugin": {"kind": "signoz/TimeSeriesPanel", "spec": {}},
+ "queries": [
+ {
+ "kind": "time_series",
+ "spec": {
+ "plugin": {
+ "kind": "signoz/ClickHouseSQL",
+ "spec": {"name": "A", "query": "SELECT 1", "disabled": False, "legend": ""},
+ }
+ },
+ }
+ ],
+ },
+ },
+ },
+ },
+ }
+
+ # Create also asserts Bug 1: a threshold with value 0 is no longer rejected.
+ response = requests.post(
+ signoz.self.host_configs["8080"].get(BASE_URL),
+ json=dashboard,
+ headers=headers,
+ timeout=5,
+ )
+ assert response.status_code == HTTPStatus.CREATED, response.text
+ dashboard_id = response.json()["data"]["id"]
+
+ try:
+ response = requests.get(
+ signoz.self.host_configs["8080"].get(f"{BASE_URL}/{dashboard_id}"),
+ headers=headers,
+ timeout=5,
+ )
+ assert response.status_code == HTTPStatus.OK, response.text
+ panels = response.json()["data"]["spec"]["panels"]
+
+ def query_spec(panel_id: str) -> dict:
+ return panels[panel_id]["spec"]["queries"][0]["spec"]["plugin"]["spec"]
+
+ def threshold(panel_id: str) -> dict:
+ return panels[panel_id]["spec"]["plugin"]["spec"]["thresholds"][0]
+
+ number = query_spec("number")
+ timeseries = query_spec("timeseries")
+ promql = query_spec("promql")
+ clickhouse = query_spec("clickhouse")
+
+ # A value the create round-trips back verbatim: (description, actual, expected).
+ roundtrip_cases = [
+ ("comparison threshold value 0", threshold("number")["value"], 0),
+ ("threshold-with-label value 0", threshold("timeseries")["value"], 0),
+ ("builder disabled false", number["disabled"], False),
+ ("builder legend empty", number["legend"], ""),
+ ("builder empty groupBy", number["groupBy"], []),
+ ("builder empty order", number["order"], []),
+ ("builder empty selectFields", number["selectFields"], []),
+ ("builder empty functions", number["functions"], []),
+ ("bare builder disabled false", timeseries["disabled"], False),
+ ("bare builder legend empty", timeseries["legend"], ""),
+ ("promql disabled false", promql["disabled"], False),
+ ("promql legend empty", promql["legend"], ""),
+ ("clickhouse disabled false", clickhouse["disabled"], False),
+ ("clickhouse legend empty", clickhouse["legend"], ""),
+ ]
+ for description, actual, expected in roundtrip_cases:
+ assert actual == expected, description
+
+ # An unset slice is omitted, never serialized as null: (description, spec, key).
+ absent_cases = [
+ ("bare builder omits groupBy", timeseries, "groupBy"),
+ ("bare builder omits order", timeseries, "order"),
+ ("bare builder omits selectFields", timeseries, "selectFields"),
+ ("bare builder omits functions", timeseries, "functions"),
+ ]
+ for description, spec, key in absent_cases:
+ assert key not in spec, description
+ finally:
+ requests.delete(
+ signoz.self.host_configs["8080"].get(f"{BASE_URL}/{dashboard_id}"),
+ headers=headers,
+ timeout=5,
+ )