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.

feat(authz): enable FGA for infra monitoring routes (#13143)

Vikrant Guptaf1bf33630fdb
diff --git a/docs/api/openapi.yml b/docs/api/openapi.yml
index 3f048fe89b..1633350885 100644
--- a/docs/api/openapi.yml
+++ b/docs/api/openapi.yml
@@ -18914,9 +18914,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: Run Infra Monitoring Setup Checks
tags:
- inframonitoring
@@ -18988,9 +18988,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: List Clusters for Infra Monitoring
tags:
- inframonitoring
@@ -19072,9 +19072,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: List DaemonSets for Infra Monitoring
tags:
- inframonitoring
@@ -19150,9 +19150,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: List Deployments for Infra Monitoring
tags:
- inframonitoring
@@ -19218,9 +19218,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: List Hosts for Infra Monitoring
tags:
- inframonitoring
@@ -19300,9 +19300,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: List Jobs for Infra Monitoring
tags:
- inframonitoring
@@ -19381,9 +19381,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: List Kubernetes Containers for Infra Monitoring
tags:
- inframonitoring
@@ -19452,9 +19452,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: List Namespaces for Infra Monitoring
tags:
- inframonitoring
@@ -19527,9 +19527,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: List Nodes for Infra Monitoring
tags:
- inframonitoring
@@ -19603,9 +19603,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: List Pods for Infra Monitoring
tags:
- inframonitoring
@@ -19674,9 +19674,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: List Volumes for Infra Monitoring
tags:
- inframonitoring
@@ -19752,9 +19752,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: List StatefulSets for Infra Monitoring
tags:
- inframonitoring
diff --git a/pkg/apiserver/signozapiserver/inframonitoring.go b/pkg/apiserver/signozapiserver/inframonitoring.go
index a444b524d5..1c18b38ebd 100644
--- a/pkg/apiserver/signozapiserver/inframonitoring.go
+++ b/pkg/apiserver/signozapiserver/inframonitoring.go
@@ -4,14 +4,16 @@ import (
"net/http"
"github.com/SigNoz/signoz/pkg/http/handler"
- "github.com/SigNoz/signoz/pkg/types"
+ "github.com/SigNoz/signoz/pkg/querybuilder"
+ "github.com/SigNoz/signoz/pkg/types/authtypes"
+ "github.com/SigNoz/signoz/pkg/types/coretypes"
"github.com/SigNoz/signoz/pkg/types/inframonitoringtypes"
"github.com/gorilla/mux"
)
func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
if err := router.Handle("/api/v2/infra_monitoring/hosts", handler.New(
- provider.authzMiddleware.ViewAccess(provider.infraMonitoringHandler.ListHosts),
+ provider.authzMiddleware.CheckResources(provider.infraMonitoringHandler.ListHosts, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "ListHosts",
Tags: []string{"inframonitoring"},
@@ -24,13 +26,18 @@ func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceTelemetryResourceMetrics.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.TelemetryResourceDef{
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: querybuilder.TelemetrySelector,
+ Resources: querybuilder.BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceMetrics, "filter.expression"),
+ }))).Methods(http.MethodPost).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/infra_monitoring/pods", handler.New(
- provider.authzMiddleware.ViewAccess(provider.infraMonitoringHandler.ListPods),
+ provider.authzMiddleware.CheckResources(provider.infraMonitoringHandler.ListPods, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "ListPods",
Tags: []string{"inframonitoring"},
@@ -43,13 +50,18 @@ func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceTelemetryResourceMetrics.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.TelemetryResourceDef{
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: querybuilder.TelemetrySelector,
+ Resources: querybuilder.BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceMetrics, "filter.expression"),
+ }))).Methods(http.MethodPost).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/infra_monitoring/kube_containers", handler.New(
- provider.authzMiddleware.ViewAccess(provider.infraMonitoringHandler.ListContainers),
+ provider.authzMiddleware.CheckResources(provider.infraMonitoringHandler.ListContainers, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "ListContainers",
Tags: []string{"inframonitoring"},
@@ -62,13 +74,18 @@ func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceTelemetryResourceMetrics.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.TelemetryResourceDef{
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: querybuilder.TelemetrySelector,
+ Resources: querybuilder.BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceMetrics, "filter.expression"),
+ }))).Methods(http.MethodPost).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/infra_monitoring/nodes", handler.New(
- provider.authzMiddleware.ViewAccess(provider.infraMonitoringHandler.ListNodes),
+ provider.authzMiddleware.CheckResources(provider.infraMonitoringHandler.ListNodes, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "ListNodes",
Tags: []string{"inframonitoring"},
@@ -81,13 +98,18 @@ func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceTelemetryResourceMetrics.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.TelemetryResourceDef{
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: querybuilder.TelemetrySelector,
+ Resources: querybuilder.BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceMetrics, "filter.expression"),
+ }))).Methods(http.MethodPost).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/infra_monitoring/namespaces", handler.New(
- provider.authzMiddleware.ViewAccess(provider.infraMonitoringHandler.ListNamespaces),
+ provider.authzMiddleware.CheckResources(provider.infraMonitoringHandler.ListNamespaces, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "ListNamespaces",
Tags: []string{"inframonitoring"},
@@ -100,13 +122,18 @@ func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceTelemetryResourceMetrics.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.TelemetryResourceDef{
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: querybuilder.TelemetrySelector,
+ Resources: querybuilder.BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceMetrics, "filter.expression"),
+ }))).Methods(http.MethodPost).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/infra_monitoring/clusters", handler.New(
- provider.authzMiddleware.ViewAccess(provider.infraMonitoringHandler.ListClusters),
+ provider.authzMiddleware.CheckResources(provider.infraMonitoringHandler.ListClusters, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "ListClusters",
Tags: []string{"inframonitoring"},
@@ -119,13 +146,18 @@ func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceTelemetryResourceMetrics.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.TelemetryResourceDef{
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: querybuilder.TelemetrySelector,
+ Resources: querybuilder.BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceMetrics, "filter.expression"),
+ }))).Methods(http.MethodPost).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/infra_monitoring/pvcs", handler.New(
- provider.authzMiddleware.ViewAccess(provider.infraMonitoringHandler.ListVolumes),
+ provider.authzMiddleware.CheckResources(provider.infraMonitoringHandler.ListVolumes, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "ListVolumes",
Tags: []string{"inframonitoring"},
@@ -138,13 +170,18 @@ func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceTelemetryResourceMetrics.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.TelemetryResourceDef{
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: querybuilder.TelemetrySelector,
+ Resources: querybuilder.BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceMetrics, "filter.expression"),
+ }))).Methods(http.MethodPost).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/infra_monitoring/deployments", handler.New(
- provider.authzMiddleware.ViewAccess(provider.infraMonitoringHandler.ListDeployments),
+ provider.authzMiddleware.CheckResources(provider.infraMonitoringHandler.ListDeployments, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "ListDeployments",
Tags: []string{"inframonitoring"},
@@ -157,13 +194,18 @@ func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceTelemetryResourceMetrics.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.TelemetryResourceDef{
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: querybuilder.TelemetrySelector,
+ Resources: querybuilder.BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceMetrics, "filter.expression"),
+ }))).Methods(http.MethodPost).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/infra_monitoring/statefulsets", handler.New(
- provider.authzMiddleware.ViewAccess(provider.infraMonitoringHandler.ListStatefulSets),
+ provider.authzMiddleware.CheckResources(provider.infraMonitoringHandler.ListStatefulSets, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "ListStatefulSets",
Tags: []string{"inframonitoring"},
@@ -176,13 +218,18 @@ func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceTelemetryResourceMetrics.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.TelemetryResourceDef{
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: querybuilder.TelemetrySelector,
+ Resources: querybuilder.BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceMetrics, "filter.expression"),
+ }))).Methods(http.MethodPost).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/infra_monitoring/jobs", handler.New(
- provider.authzMiddleware.ViewAccess(provider.infraMonitoringHandler.ListJobs),
+ provider.authzMiddleware.CheckResources(provider.infraMonitoringHandler.ListJobs, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "ListJobs",
Tags: []string{"inframonitoring"},
@@ -195,13 +242,18 @@ func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceTelemetryResourceMetrics.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.TelemetryResourceDef{
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: querybuilder.TelemetrySelector,
+ Resources: querybuilder.BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceMetrics, "filter.expression"),
+ }))).Methods(http.MethodPost).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/infra_monitoring/daemonsets", handler.New(
- provider.authzMiddleware.ViewAccess(provider.infraMonitoringHandler.ListDaemonSets),
+ provider.authzMiddleware.CheckResources(provider.infraMonitoringHandler.ListDaemonSets, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "ListDaemonSets",
Tags: []string{"inframonitoring"},
@@ -214,13 +266,18 @@ func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceTelemetryResourceMetrics.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.TelemetryResourceDef{
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: querybuilder.TelemetrySelector,
+ Resources: querybuilder.BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceMetrics, "filter.expression"),
+ }))).Methods(http.MethodPost).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/infra_monitoring/checks", handler.New(
- provider.authzMiddleware.ViewAccess(provider.infraMonitoringHandler.GetChecks),
+ provider.authzMiddleware.CheckResources(provider.infraMonitoringHandler.GetChecks, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "GetChecks",
Tags: []string{"inframonitoring"},
@@ -232,8 +289,13 @@ func (provider *provider) addInfraMonitoringRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodGet).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceTelemetryResourceMetrics.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.TelemetryResourceDef{
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: querybuilder.TelemetrySelector,
+ Resources: querybuilder.BuilderQueryWildcardResources(coretypes.ResourceTelemetryResourceMetrics),
+ }))).Methods(http.MethodGet).GetError(); err != nil {
return err
}
diff --git a/pkg/querybuilder/query_range_resources.go b/pkg/querybuilder/query_range_resources.go
index 447047c256..e3601540ea 100644
--- a/pkg/querybuilder/query_range_resources.go
+++ b/pkg/querybuilder/query_range_resources.go
@@ -85,6 +85,18 @@ func PromQLResources(coretypes.ExtractorContext) ([]coretypes.ResourceWithID, er
}}, nil
}
+func BuilderQueryWithFilterExpressionResources(resource coretypes.Resource, bodyPath string) coretypes.ResourceExtractor {
+ return func(ec coretypes.ExtractorContext) ([]coretypes.ResourceWithID, error) {
+ return builderResources(qbtypes.QueryTypeBuilder.StringValue(), resource, gjson.GetBytes(ec.RequestBody, bodyPath).String(), nil)
+ }
+}
+
+func BuilderQueryWildcardResources(resource coretypes.Resource) coretypes.ResourceExtractor {
+ return func(coretypes.ExtractorContext) ([]coretypes.ResourceWithID, error) {
+ return builderResources(qbtypes.QueryTypeBuilder.StringValue(), resource, "", nil)
+ }
+}
+
func resourcesForQuery(query gjson.Result, variables map[string]qbtypes.VariableItem) ([]coretypes.ResourceWithID, error) {
queryType := query.Get("type").String()
typeWildcard := queryType + "/" + coretypes.WildCardSelectorString
@@ -120,7 +132,11 @@ func resourcesForBuilderQuery(queryType string, spec gjson.Result, variables map
}
func builderQueryResourceRefs(queryType string, resource coretypes.Resource, spec gjson.Result, variables map[string]qbtypes.VariableItem) ([]coretypes.ResourceWithID, error) {
- ids, err := builderQuerySelectors(queryType, spec.Get("filter.expression").String(), variables)
+ return builderResources(queryType, resource, spec.Get("filter.expression").String(), variables)
+}
+
+func builderResources(queryType string, resource coretypes.Resource, expression string, variables map[string]qbtypes.VariableItem) ([]coretypes.ResourceWithID, error) {
+ ids, err := builderQuerySelectors(queryType, expression, variables)
if err != nil {
return nil, err
}
diff --git a/pkg/querybuilder/query_range_resources_test.go b/pkg/querybuilder/query_range_resources_test.go
index abd3e05ecf..a6f5ccc360 100644
--- a/pkg/querybuilder/query_range_resources_test.go
+++ b/pkg/querybuilder/query_range_resources_test.go
@@ -195,3 +195,46 @@ func TestTelemetrySelector(t *testing.T) {
// a value containing "/" stays one logical segment (SplitN 3).
assert.Equal(t, []string{"builder_query/signoz.workspace.key.id/a/b", "builder_query/signoz.workspace.key.id/*", "builder_query/*", "*"}, selectorValues("builder_query/signoz.workspace.key.id/a/b"))
}
+
+func TestBuilderQueryWithFilterExpressionResources(t *testing.T) {
+ testCases := []struct {
+ name string
+ body string
+ expected []coretypes.ResourceWithID
+ }{
+ {
+ name: "FilterPresent_ScopedID",
+ body: `{"start":1,"end":2,"filter":{"expression":"signoz.workspace.key.id = 'key-a'"}}`,
+ expected: []coretypes.ResourceWithID{{Resource: coretypes.ResourceTelemetryResourceTraces, ID: "builder_query/signoz.workspace.key.id/key-a"}},
+ },
+ {
+ name: "FilterAbsent_Wildcard",
+ body: `{"start":1,"end":2}`,
+ expected: []coretypes.ResourceWithID{{Resource: coretypes.ResourceTelemetryResourceTraces, ID: "builder_query/*"}},
+ },
+ {
+ name: "EmptyBody_Wildcard",
+ body: ``,
+ expected: []coretypes.ResourceWithID{{Resource: coretypes.ResourceTelemetryResourceTraces, ID: "builder_query/*"}},
+ },
+ }
+
+ for _, testCase := range testCases {
+ t.Run(testCase.name, func(t *testing.T) {
+ refs, err := BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceTraces, "filter.expression")(coretypes.ExtractorContext{RequestBody: []byte(testCase.body)})
+ require.NoError(t, err)
+ assert.Equal(t, testCase.expected, refs)
+ })
+ }
+
+ t.Run("InvalidExpression_Error", func(t *testing.T) {
+ _, err := BuilderQueryWithFilterExpressionResources(coretypes.ResourceTelemetryResourceTraces, "filter.expression")(coretypes.ExtractorContext{RequestBody: []byte(`{"filter":{"expression":"signoz.workspace.key.id = "}}`)})
+ require.Error(t, err)
+ })
+}
+
+func TestBuilderQueryWildcardResources(t *testing.T) {
+ refs, err := BuilderQueryWildcardResources(coretypes.ResourceTelemetryResourceTraces)(coretypes.ExtractorContext{})
+ require.NoError(t, err)
+ assert.Equal(t, []coretypes.ResourceWithID{{Resource: coretypes.ResourceTelemetryResourceTraces, ID: "builder_query/*"}}, refs)
+}
diff --git a/tests/integration/tests/inframonitoring/13_authz.py b/tests/integration/tests/inframonitoring/13_authz.py
new file mode 100644
index 0000000000..736ccb8a0b
--- /dev/null
+++ b/tests/integration/tests/inframonitoring/13_authz.py
@@ -0,0 +1,154 @@
+from collections.abc import Callable
+from datetime import UTC, datetime, timedelta
+from http import HTTPStatus
+
+import pytest
+import requests
+from wiremock.resources.mappings import Mapping
+
+from fixtures import types
+from fixtures.auth import (
+ USER_ADMIN_EMAIL,
+ USER_ADMIN_PASSWORD,
+ add_license,
+ change_user_role,
+ create_active_user,
+)
+from fixtures.fs import get_testdata_file_path
+from fixtures.metrics import Metrics
+from fixtures.role import transaction_group
+
+user_password = "password123Z$"
+scoped_role = "infra-scope-key-a"
+scoped_email = "[email protected]"
+wildcard_role = "infra-wildcard"
+wildcard_email = "[email protected]"
+
+list_paths = [
+ "/api/v2/infra_monitoring/hosts",
+ "/api/v2/infra_monitoring/pods",
+ "/api/v2/infra_monitoring/kube_containers",
+ "/api/v2/infra_monitoring/nodes",
+ "/api/v2/infra_monitoring/namespaces",
+ "/api/v2/infra_monitoring/clusters",
+ "/api/v2/infra_monitoring/pvcs",
+ "/api/v2/infra_monitoring/deployments",
+ "/api/v2/infra_monitoring/statefulsets",
+ "/api/v2/infra_monitoring/jobs",
+ "/api/v2/infra_monitoring/daemonsets",
+]
+
+
+def test_setup(
+ signoz: types.SigNoz,
+ create_user_admin: types.Operation, # pylint: disable=unused-argument
+ make_http_mocks: Callable[[types.TestContainerDocker, list[Mapping]], None],
+ get_token: Callable[[str, str], str],
+ create_role: Callable[..., str],
+) -> None:
+ add_license(signoz, make_http_mocks, get_token)
+
+ admin_token = get_token(USER_ADMIN_EMAIL, USER_ADMIN_PASSWORD)
+ create_role(admin_token, scoped_role, [transaction_group("read", "telemetryresource", "metrics", ["builder_query/signoz.workspace.key.id/key-a"])])
+ scoped_user = create_active_user(signoz, admin_token, email=scoped_email, role="signoz-viewer", password=user_password)
+ change_user_role(signoz, admin_token, scoped_user, "signoz-viewer", scoped_role)
+
+ create_role(admin_token, wildcard_role, [transaction_group("read", "telemetryresource", "metrics", ["builder_query/*"])])
+ wildcard_user = create_active_user(signoz, admin_token, email=wildcard_email, role="signoz-viewer", password=user_password)
+ change_user_role(signoz, admin_token, wildcard_user, "signoz-viewer", wildcard_role)
+
+
[email protected]("path", list_paths)
+ ("email", "expected"),
+ [(scoped_email, HTTPStatus.FORBIDDEN), (wildcard_email, HTTPStatus.OK), (USER_ADMIN_EMAIL, HTTPStatus.OK)],
+)
+def test_list_routes(
+ signoz: types.SigNoz,
+ get_token: Callable[[str, str], str],
+ path: str,
+ email: str,
+ expected: HTTPStatus,
+) -> None:
+ now = datetime.now(tz=UTC)
+ token = get_token(email, USER_ADMIN_PASSWORD if email == USER_ADMIN_EMAIL else user_password)
+ response = requests.post(
+ signoz.self.host_configs["8080"].get(path),
+ json={"start": int((now - timedelta(minutes=10)).timestamp() * 1000), "end": int(now.timestamp() * 1000), "limit": 10},
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=10,
+ )
+ assert response.status_code == expected, response.text
+
+
+def test_list_denied_message_names_metrics_wildcard(
+ signoz: types.SigNoz,
+ get_token: Callable[[str, str], str],
+) -> None:
+ now = datetime.now(tz=UTC)
+ response = requests.post(
+ signoz.self.host_configs["8080"].get("/api/v2/infra_monitoring/hosts"),
+ json={"start": int((now - timedelta(minutes=10)).timestamp() * 1000), "end": int(now.timestamp() * 1000), "limit": 10, "filter": {"expression": "host.name = 'web-1'"}},
+ headers={"Authorization": f"Bearer {get_token(scoped_email, user_password)}"},
+ timeout=10,
+ )
+ assert response.status_code == HTTPStatus.FORBIDDEN, response.text
+ assert "builder_query/*" in response.text
+
+
+ ("email", "expression", "expected", "expected_hosts"),
+ [
+ (scoped_email, "signoz.workspace.key.id = 'key-a'", HTTPStatus.OK, {"acc-h1"}),
+ (scoped_email, "signoz.workspace.key.id = 'key-b'", HTTPStatus.FORBIDDEN, set()),
+ (scoped_email, "signoz.workspace.key.id IN ('key-a', 'key-b')", HTTPStatus.FORBIDDEN, set()),
+ (wildcard_email, None, HTTPStatus.OK, {"acc-h1", "acc-h2"}),
+ ],
+ ids=["scoped_granted_key", "scoped_other_key", "scoped_both_keys", "wildcard_unfiltered"],
+)
+def test_hosts_scoped_read(
+ signoz: types.SigNoz,
+ get_token: Callable[[str, str], str],
+ insert_metrics: Callable[[list[Metrics]], None],
+ email: str,
+ expression: str | None,
+ expected: HTTPStatus,
+ expected_hosts: set[str],
+) -> None:
+ now = datetime.now(tz=UTC).replace(microsecond=0)
+ insert_metrics(
+ [Metrics.from_dict({**metric.to_dict(), "labels": {**metric.labels, "signoz.workspace.key.id": "key-a" if metric.labels["host.name"] == "acc-h1" else "key-b"}}) for metric in Metrics.load_from_file(get_testdata_file_path("inframonitoring/hosts_value_accuracy.jsonl"), base_time=now - timedelta(minutes=4))]
+ )
+
+ body: dict = {"start": int((now - timedelta(minutes=5)).timestamp() * 1000), "end": int(now.timestamp() * 1000), "limit": 50}
+ if expression:
+ body["filter"] = {"expression": expression}
+ response = requests.post(
+ signoz.self.host_configs["8080"].get("/api/v2/infra_monitoring/hosts"),
+ json=body,
+ headers={"Authorization": f"Bearer {get_token(email, user_password)}"},
+ timeout=10,
+ )
+ assert response.status_code == expected, response.text
+ if expected == HTTPStatus.OK:
+ assert {record["hostName"] for record in response.json()["data"]["records"]} == expected_hosts
+
+
+ ("email", "expected"),
+ [(scoped_email, HTTPStatus.FORBIDDEN), (wildcard_email, HTTPStatus.OK), (USER_ADMIN_EMAIL, HTTPStatus.OK)],
+)
+def test_checks(
+ signoz: types.SigNoz,
+ get_token: Callable[[str, str], str],
+ email: str,
+ expected: HTTPStatus,
+) -> None:
+ token = get_token(email, USER_ADMIN_PASSWORD if email == USER_ADMIN_EMAIL else user_password)
+ response = requests.get(
+ signoz.self.host_configs["8080"].get("/api/v2/infra_monitoring/checks"),
+ params={"type": "hosts"},
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=10,
+ )
+ assert response.status_code == expected, response.text