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 metrics explorer routes (#13150)

Vikrant Guptae3488c159202
diff --git a/.github/workflows/integrationci.yaml b/.github/workflows/integrationci.yaml
index 68bfa72c50..7c6885d61e 100644
--- a/.github/workflows/integrationci.yaml
+++ b/.github/workflows/integrationci.yaml
@@ -75,6 +75,7 @@ jobs:
- ttl
- clickhousecluster
- metricreduction
+ - metricsexplorer
sqlstore-provider:
- postgres
- sqlite
diff --git a/docs/api/openapi.yml b/docs/api/openapi.yml
index ef10773d87..eaa5bde0d1 100644
--- a/docs/api/openapi.yml
+++ b/docs/api/openapi.yml
@@ -3581,6 +3581,7 @@ components:
- meter-metrics
- logs-field
- traces-field
+ - metrics-field
type: string
CoretypesObject:
properties:
@@ -20637,9 +20638,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics-field:list
- tokenizer:
- - VIEWER
+ - metrics-field:list
summary: List metric names
tags:
- metrics
@@ -20706,9 +20707,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - rule:list
- tokenizer:
- - VIEWER
+ - rule:list
summary: Get metric alerts
tags:
- metrics
@@ -20790,9 +20791,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics-field:read
- tokenizer:
- - VIEWER
+ - metrics-field:read
summary: Get metric attributes
tags:
- metrics
@@ -20860,9 +20861,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: Get metric highlights
tags:
- metrics
@@ -20919,9 +20920,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: Inspect raw metric data points
tags:
- metrics
@@ -20989,9 +20990,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics-field:read
- tokenizer:
- - VIEWER
+ - metrics-field:read
summary: Get metric metadata
tags:
- metrics
@@ -21035,9 +21036,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - EDITOR
+ - metrics-field:update
- tokenizer:
- - EDITOR
+ - metrics-field:update
summary: Update metric metadata
tags:
- metrics
@@ -21083,9 +21084,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: Check if non-SigNoz metrics have been received
tags:
- metrics
@@ -21142,9 +21143,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: Get metrics statistics
tags:
- metrics
@@ -21201,9 +21202,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - metrics:read
- tokenizer:
- - VIEWER
+ - metrics:read
summary: Get metrics treemap
tags:
- metrics
@@ -28342,9 +28343,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - dashboard:list
- tokenizer:
- - VIEWER
+ - dashboard:list
summary: Get metric dashboards (v2)
tags:
- metrics
diff --git a/frontend/src/api/generated/services/sigNoz.schemas.ts b/frontend/src/api/generated/services/sigNoz.schemas.ts
index 6655612d1f..12a61232aa 100644
--- a/frontend/src/api/generated/services/sigNoz.schemas.ts
+++ b/frontend/src/api/generated/services/sigNoz.schemas.ts
@@ -3291,6 +3291,7 @@ export enum CoretypesKindDTO {
'meter-metrics' = 'meter-metrics',
'logs-field' = 'logs-field',
'traces-field' = 'traces-field',
+ 'metrics-field' = 'metrics-field',
}
export enum CoretypesTypeDTO {
user = 'user',
diff --git a/frontend/src/components/LogsFormatOptionsMenu/LogsFormatOptionsMenu.tsx b/frontend/src/components/LogsFormatOptionsMenu/LogsFormatOptionsMenu.tsx
index e8bb3678fc..8fc85d14ed 100644
--- a/frontend/src/components/LogsFormatOptionsMenu/LogsFormatOptionsMenu.tsx
+++ b/frontend/src/components/LogsFormatOptionsMenu/LogsFormatOptionsMenu.tsx
@@ -2,8 +2,11 @@ import { useCallback, useEffect, useState } from 'react';
import { Button, InputNumber, Popover, Tooltip } from 'antd';
import { Typography } from '@signozhq/ui/typography';
import cx from 'classnames';
-import { LogViewMode } from 'container/OptionsMenu/types';
-import { FontSize, OptionsMenuConfig } from 'container/OptionsMenu/types';
+import {
+ LogViewMode,
+ FontSize,
+ OptionsMenuConfig,
+} from 'container/OptionsMenu/types';
import {
Check,
ChevronLeft,
diff --git a/frontend/src/schemas/generated/transactionGroups.schema.json b/frontend/src/schemas/generated/transactionGroups.schema.json
index 7b2333aa5c..409cc8d2a5 100644
--- a/frontend/src/schemas/generated/transactionGroups.schema.json
+++ b/frontend/src/schemas/generated/transactionGroups.schema.json
@@ -73,7 +73,8 @@
"audit-logs",
"meter-metrics",
"logs-field",
- "traces-field"
+ "traces-field",
+ "metrics-field"
],
"type": "string"
},
diff --git a/pkg/apiserver/signozapiserver/metricsexplorer.go b/pkg/apiserver/signozapiserver/metricsexplorer.go
index cacc2aad26..7204d33510 100644
--- a/pkg/apiserver/signozapiserver/metricsexplorer.go
+++ b/pkg/apiserver/signozapiserver/metricsexplorer.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/metricsexplorertypes"
"github.com/gorilla/mux"
)
func (provider *provider) addMetricsExplorerRoutes(router *mux.Router) error {
if err := router.Handle("/api/v2/metrics", handler.New(
- provider.authzMiddleware.ViewAccess(provider.metricsExplorerHandler.ListMetrics),
+ provider.authzMiddleware.CheckResources(provider.metricsExplorerHandler.ListMetrics, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "ListMetrics",
Tags: []string{"metrics"},
@@ -25,13 +27,18 @@ func (provider *provider) addMetricsExplorerRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized, http.StatusInternalServerError},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodGet).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceMetaResourceMetricsField.Scope(coretypes.VerbList)}),
+ }, handler.WithResourceDefs(handler.BasicResourceDef{
+ Resource: coretypes.ResourceMetaResourceMetricsField,
+ Verb: coretypes.VerbList,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: coretypes.WildcardSelector,
+ }))).Methods(http.MethodGet).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/metrics/stats", handler.New(
- provider.authzMiddleware.ViewAccess(provider.metricsExplorerHandler.GetStats),
+ provider.authzMiddleware.CheckResources(provider.metricsExplorerHandler.GetStats, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "GetMetricsStats",
Tags: []string{"metrics"},
@@ -44,13 +51,18 @@ func (provider *provider) addMetricsExplorerRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized, http.StatusInternalServerError},
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/metrics/treemap", handler.New(
- provider.authzMiddleware.ViewAccess(provider.metricsExplorerHandler.GetTreemap),
+ provider.authzMiddleware.CheckResources(provider.metricsExplorerHandler.GetTreemap, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "GetMetricsTreemap",
Tags: []string{"metrics"},
@@ -63,13 +75,18 @@ func (provider *provider) addMetricsExplorerRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized, http.StatusInternalServerError},
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/metrics/attributes", handler.New(
- provider.authzMiddleware.ViewAccess(provider.metricsExplorerHandler.GetMetricAttributes),
+ provider.authzMiddleware.CheckResources(provider.metricsExplorerHandler.GetMetricAttributes, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "GetMetricAttributes",
Tags: []string{"metrics"},
@@ -83,13 +100,18 @@ func (provider *provider) addMetricsExplorerRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized, http.StatusNotFound, http.StatusInternalServerError},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodGet).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceMetaResourceMetricsField.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.BasicResourceDef{
+ Resource: coretypes.ResourceMetaResourceMetricsField,
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: coretypes.WildcardSelector,
+ }))).Methods(http.MethodGet).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/metrics/metadata", handler.New(
- provider.authzMiddleware.ViewAccess(provider.metricsExplorerHandler.GetMetricMetadata),
+ provider.authzMiddleware.CheckResources(provider.metricsExplorerHandler.GetMetricMetadata, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "GetMetricMetadata",
Tags: []string{"metrics"},
@@ -103,13 +125,18 @@ func (provider *provider) addMetricsExplorerRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized, http.StatusNotFound, http.StatusInternalServerError},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodGet).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceMetaResourceMetricsField.Scope(coretypes.VerbRead)}),
+ }, handler.WithResourceDefs(handler.BasicResourceDef{
+ Resource: coretypes.ResourceMetaResourceMetricsField,
+ Verb: coretypes.VerbRead,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: coretypes.WildcardSelector,
+ }))).Methods(http.MethodGet).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/metrics/metadata", handler.New(
- provider.authzMiddleware.EditAccess(provider.metricsExplorerHandler.UpdateMetricMetadata),
+ provider.authzMiddleware.CheckResources(provider.metricsExplorerHandler.UpdateMetricMetadata, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName),
handler.OpenAPIDef{
ID: "UpdateMetricMetadata",
Tags: []string{"metrics"},
@@ -122,13 +149,18 @@ func (provider *provider) addMetricsExplorerRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized, http.StatusInternalServerError},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleEditor),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceMetaResourceMetricsField.Scope(coretypes.VerbUpdate)}),
+ }, handler.WithResourceDefs(handler.BasicResourceDef{
+ Resource: coretypes.ResourceMetaResourceMetricsField,
+ Verb: coretypes.VerbUpdate,
+ Category: coretypes.ActionCategoryConfigurationChange,
+ Selector: coretypes.WildcardSelector,
+ }))).Methods(http.MethodPost).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/metrics/highlights", handler.New(
- provider.authzMiddleware.ViewAccess(provider.metricsExplorerHandler.GetMetricHighlights),
+ provider.authzMiddleware.CheckResources(provider.metricsExplorerHandler.GetMetricHighlights, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "GetMetricHighlights",
Tags: []string{"metrics"},
@@ -142,13 +174,18 @@ func (provider *provider) addMetricsExplorerRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized, http.StatusNotFound, http.StatusInternalServerError},
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
}
if err := router.Handle("/api/v2/metrics/alerts", handler.New(
- provider.authzMiddleware.ViewAccess(provider.metricsExplorerHandler.GetMetricAlerts),
+ provider.authzMiddleware.CheckResources(provider.metricsExplorerHandler.GetMetricAlerts, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "GetMetricAlerts",
Tags: []string{"metrics"},
@@ -162,13 +199,18 @@ func (provider *provider) addMetricsExplorerRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized, http.StatusNotFound, http.StatusInternalServerError},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodGet).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceMetaResourceRule.Scope(coretypes.VerbList)}),
+ }, handler.WithResourceDefs(handler.BasicResourceDef{
+ Resource: coretypes.ResourceMetaResourceRule,
+ Verb: coretypes.VerbList,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: coretypes.WildcardSelector,
+ }))).Methods(http.MethodGet).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v3/metrics/dashboards", handler.New(
- provider.authzMiddleware.ViewAccess(provider.metricsExplorerHandler.GetMetricDashboardsV2),
+ provider.authzMiddleware.CheckResources(provider.metricsExplorerHandler.GetMetricDashboardsV2, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "GetMetricDashboardsV2",
Tags: []string{"metrics"},
@@ -182,13 +224,18 @@ func (provider *provider) addMetricsExplorerRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized, http.StatusNotFound, http.StatusInternalServerError},
Deprecated: false,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodGet).GetError(); err != nil {
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceMetaResourceDashboard.Scope(coretypes.VerbList)}),
+ }, handler.WithResourceDefs(handler.BasicResourceDef{
+ Resource: coretypes.ResourceMetaResourceDashboard,
+ Verb: coretypes.VerbList,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: coretypes.WildcardSelector,
+ }))).Methods(http.MethodGet).GetError(); err != nil {
return err
}
if err := router.Handle("/api/v2/metrics/inspect", handler.New(
- provider.authzMiddleware.ViewAccess(provider.metricsExplorerHandler.InspectMetrics),
+ provider.authzMiddleware.CheckResources(provider.metricsExplorerHandler.InspectMetrics, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "InspectMetrics",
Tags: []string{"metrics"},
@@ -201,13 +248,18 @@ func (provider *provider) addMetricsExplorerRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusUnauthorized, http.StatusInternalServerError},
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/metrics/onboarding", handler.New(
- provider.authzMiddleware.ViewAccess(provider.metricsExplorerHandler.GetOnboardingStatus),
+ provider.authzMiddleware.CheckResources(provider.metricsExplorerHandler.GetOnboardingStatus, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
handler.OpenAPIDef{
ID: "GetMetricsOnboardingStatus",
Tags: []string{"metrics"},
@@ -220,8 +272,13 @@ func (provider *provider) addMetricsExplorerRoutes(router *mux.Router) error {
SuccessStatusCode: http.StatusOK,
ErrorStatusCodes: []int{http.StatusUnauthorized, http.StatusInternalServerError},
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/signoz/provider.go b/pkg/signoz/provider.go
index 8ac4d4f543..c1bb628036 100644
--- a/pkg/signoz/provider.go
+++ b/pkg/signoz/provider.go
@@ -263,6 +263,7 @@ func NewSQLMigrationProviderFactories(
sqlmigration.NewAddFieldTuplesFactory(sqlstore),
sqlmigration.NewKeepRelevantLLMPricingRulesFactory(),
sqlmigration.NewBackfillTelegramChannelSpecFactory(),
+ sqlmigration.NewAddMetricsFieldTuplesFactory(sqlstore),
)
}
diff --git a/pkg/sqlmigration/137_add_metrics_field_tuples.go b/pkg/sqlmigration/137_add_metrics_field_tuples.go
new file mode 100644
index 0000000000..1299f5645a
--- /dev/null
+++ b/pkg/sqlmigration/137_add_metrics_field_tuples.go
@@ -0,0 +1,162 @@
+package sqlmigration
+
+import (
+ "context"
+ "database/sql"
+ "encoding/json"
+ "time"
+
+ "github.com/SigNoz/signoz/pkg/factory"
+ "github.com/SigNoz/signoz/pkg/sqlstore"
+ "github.com/SigNoz/signoz/pkg/types/authtypes"
+ "github.com/SigNoz/signoz/pkg/types/coretypes"
+ "github.com/oklog/ulid/v2"
+ "github.com/uptrace/bun"
+ "github.com/uptrace/bun/dialect"
+ "github.com/uptrace/bun/migrate"
+)
+
+type addMetricsFieldTuples struct {
+ sqlstore sqlstore.SQLStore
+}
+
+func NewAddMetricsFieldTuplesFactory(sqlstore sqlstore.SQLStore) factory.ProviderFactory[SQLMigration, Config] {
+ return factory.NewProviderFactory(factory.MustNewName("add_metrics_field_tuples"), func(ctx context.Context, ps factory.ProviderSettings, c Config) (SQLMigration, error) {
+ return &addMetricsFieldTuples{sqlstore: sqlstore}, nil
+ })
+}
+
+func (migration *addMetricsFieldTuples) Register(migrations *migrate.Migrations) error {
+ return migrations.Register(migration.Up, migration.Down)
+}
+
+func (migration *addMetricsFieldTuples) Up(ctx context.Context, db *bun.DB) error {
+ tx, err := db.BeginTx(ctx, nil)
+ if err != nil {
+ return err
+ }
+ defer func() { _ = tx.Rollback() }()
+
+ var storeID string
+ err = tx.QueryRowContext(ctx, `SELECT id FROM store WHERE name = ? LIMIT 1`, "signoz").Scan(&storeID)
+ if err != nil {
+ return err
+ }
+
+ var orgIDs []string
+ err = tx.NewSelect().
+ Table("organizations").
+ Column("id").
+ Scan(ctx, &orgIDs)
+ if err != nil && err != sql.ErrNoRows {
+ return err
+ }
+
+ isPG := migration.sqlstore.BunDB().Dialect().Name() == dialect.PG
+
+ tuples := []migrationTuple{
+ {authtypes.SigNozAdminRoleName, "metaresource", "metrics-field", "read"},
+ {authtypes.SigNozAdminRoleName, "metaresource", "metrics-field", "update"},
+ {authtypes.SigNozAdminRoleName, "metaresource", "metrics-field", "list"},
+ {authtypes.SigNozEditorRoleName, "metaresource", "metrics-field", "read"},
+ {authtypes.SigNozEditorRoleName, "metaresource", "metrics-field", "update"},
+ {authtypes.SigNozEditorRoleName, "metaresource", "metrics-field", "list"},
+ {authtypes.SigNozViewerRoleName, "metaresource", "metrics-field", "read"},
+ {authtypes.SigNozViewerRoleName, "metaresource", "metrics-field", "list"},
+ }
+
+ for _, orgID := range orgIDs {
+ for _, tuple := range tuples {
+ entropy := ulid.DefaultEntropy()
+ now := time.Now().UTC()
+ tupleID := ulid.MustNew(ulid.Timestamp(now), entropy).String()
+
+ objectID := "organization/" + orgID + "/" + tuple.objectName + "/*"
+ roleSubject := "organization/" + orgID + "/role/" + tuple.roleName
+
+ if isPG {
+ user := "role:" + roleSubject + "#assignee"
+ result, err := tx.ExecContext(ctx, `
+ INSERT INTO tuple (store, object_type, object_id, relation, _user, user_type, ulid, inserted_at)
+ VALUES (?, ?, ?, ?, ?, ?, ?, ?)
+ ON CONFLICT (store, object_type, object_id, relation, _user) DO NOTHING`,
+ storeID, tuple.objectType, objectID, tuple.relation, user, "userset", tupleID, now,
+ )
+ if err != nil {
+ return err
+ }
+ rowsAffected, err := result.RowsAffected()
+ if err != nil {
+ return err
+ }
+ if rowsAffected == 0 {
+ continue
+ }
+ _, err = tx.ExecContext(ctx, `
+ INSERT INTO changelog (store, object_type, object_id, relation, _user, operation, ulid, inserted_at)
+ VALUES (?, ?, ?, ?, ?, ?, ?, ?)
+ ON CONFLICT (store, ulid, object_type) DO NOTHING`,
+ storeID, tuple.objectType, objectID, tuple.relation, user, 0, tupleID, now,
+ )
+ if err != nil {
+ return err
+ }
+ } else {
+ result, err := tx.ExecContext(ctx, `
+ INSERT INTO tuple (store, object_type, object_id, relation, user_object_type, user_object_id, user_relation, user_type, ulid, inserted_at)
+ VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
+ ON CONFLICT (store, object_type, object_id, relation, user_object_type, user_object_id, user_relation) DO NOTHING`,
+ storeID, tuple.objectType, objectID, tuple.relation, "role", roleSubject, "assignee", "userset", tupleID, now,
+ )
+ if err != nil {
+ return err
+ }
+ rowsAffected, err := result.RowsAffected()
+ if err != nil {
+ return err
+ }
+ if rowsAffected == 0 {
+ continue
+ }
+ _, err = tx.ExecContext(ctx, `
+ INSERT INTO changelog (store, object_type, object_id, relation, user_object_type, user_object_id, user_relation, operation, ulid, inserted_at)
+ VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
+ ON CONFLICT (store, ulid, object_type) DO NOTHING`,
+ storeID, tuple.objectType, objectID, tuple.relation, "role", roleSubject, "assignee", 0, tupleID, now,
+ )
+ if err != nil {
+ return err
+ }
+ }
+ }
+ }
+
+ managedRoleGroups := make(map[string]string, len(coretypes.ManagedRoleToTransactions))
+ for roleName, transactions := range coretypes.ManagedRoleToTransactions {
+ data, err := json.Marshal(authtypes.NewTransactionGroupsFromTransactions(transactions))
+ if err != nil {
+ return err
+ }
+ managedRoleGroups[roleName] = string(data)
+ }
+
+ for _, orgID := range orgIDs {
+ for roleName, data := range managedRoleGroups {
+ if _, err := tx.NewUpdate().
+ Model(new(roles)).
+ Set("transaction_groups = ?", data).
+ Where("org_id = ?", orgID).
+ Where("type = ?", authtypes.RoleTypeManaged.StringValue()).
+ Where("name = ?", roleName).
+ Exec(ctx); err != nil {
+ return err
+ }
+ }
+ }
+
+ return tx.Commit()
+}
+
+func (migration *addMetricsFieldTuples) Down(context.Context, *bun.DB) error {
+ return nil
+}
diff --git a/pkg/types/coretypes/kind.go b/pkg/types/coretypes/kind.go
index 7cca0a874a..613abd4878 100644
--- a/pkg/types/coretypes/kind.go
+++ b/pkg/types/coretypes/kind.go
@@ -79,6 +79,7 @@ func (name Kind) Enum() []any {
KindMeterMetrics,
KindLogsField,
KindTracesField,
+ KindMetricsField,
}
}
diff --git a/pkg/types/coretypes/registry_kind.go b/pkg/types/coretypes/registry_kind.go
index e9de2c1e81..27c3fc1c85 100644
--- a/pkg/types/coretypes/registry_kind.go
+++ b/pkg/types/coretypes/registry_kind.go
@@ -39,6 +39,7 @@ var Kinds = []Kind{
KindMeterMetrics,
KindLogsField,
KindTracesField,
+ KindMetricsField,
}
var (
@@ -80,4 +81,5 @@ var (
KindMeterMetrics = MustNewKind("meter-metrics")
KindLogsField = MustNewKind("logs-field")
KindTracesField = MustNewKind("traces-field")
+ KindMetricsField = MustNewKind("metrics-field")
)
diff --git a/pkg/types/coretypes/registry_managed_role.go b/pkg/types/coretypes/registry_managed_role.go
index 235e78fc30..04508010e3 100644
--- a/pkg/types/coretypes/registry_managed_role.go
+++ b/pkg/types/coretypes/registry_managed_role.go
@@ -214,6 +214,10 @@ var ManagedRoleToTransactions = map[string][]Transaction{
{Verb: VerbRead, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindTracesField}, WildCardSelectorString)},
{Verb: VerbUpdate, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindTracesField}, WildCardSelectorString)},
{Verb: VerbList, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindTracesField}, WildCardSelectorString)},
+ // metrics-field — editor+admin update, viewer reads
+ {Verb: VerbRead, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindMetricsField}, WildCardSelectorString)},
+ {Verb: VerbUpdate, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindMetricsField}, WildCardSelectorString)},
+ {Verb: VerbList, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindMetricsField}, WildCardSelectorString)},
},
SigNozEditorRoleName: {
// cloud-integration — editor can read accounts
@@ -309,6 +313,10 @@ var ManagedRoleToTransactions = map[string][]Transaction{
{Verb: VerbRead, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindTracesField}, WildCardSelectorString)},
{Verb: VerbUpdate, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindTracesField}, WildCardSelectorString)},
{Verb: VerbList, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindTracesField}, WildCardSelectorString)},
+ // metrics-field — editor reads+updates
+ {Verb: VerbRead, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindMetricsField}, WildCardSelectorString)},
+ {Verb: VerbUpdate, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindMetricsField}, WildCardSelectorString)},
+ {Verb: VerbList, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindMetricsField}, WildCardSelectorString)},
},
SigNozViewerRoleName: {
// cloud-integration — viewer can read accounts
@@ -370,6 +378,9 @@ var ManagedRoleToTransactions = map[string][]Transaction{
// traces-field — viewer reads
{Verb: VerbRead, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindTracesField}, WildCardSelectorString)},
{Verb: VerbList, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindTracesField}, WildCardSelectorString)},
+ // metrics-field — viewer reads
+ {Verb: VerbRead, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindMetricsField}, WildCardSelectorString)},
+ {Verb: VerbList, Object: *MustNewObject(ResourceRef{Type: TypeMetaResource, Kind: KindMetricsField}, WildCardSelectorString)},
},
SigNozAnonymousRoleName: {
// public-dashboard — anonymous read
diff --git a/pkg/types/coretypes/registry_resource.go b/pkg/types/coretypes/registry_resource.go
index cac972a772..088d568098 100644
--- a/pkg/types/coretypes/registry_resource.go
+++ b/pkg/types/coretypes/registry_resource.go
@@ -39,6 +39,7 @@ var Resources = []Resource{
ResourceTelemetryResourceMeterMetrics,
ResourceMetaResourceLogsField,
ResourceMetaResourceTracesField,
+ ResourceMetaResourceMetricsField,
}
var (
@@ -80,4 +81,5 @@ var (
ResourceTelemetryResourceMeterMetrics = NewResourceTelemetryResource(KindMeterMetrics)
ResourceMetaResourceLogsField = NewResourceMetaResource(KindLogsField)
ResourceMetaResourceTracesField = NewResourceMetaResource(KindTracesField)
+ ResourceMetaResourceMetricsField = NewResourceMetaResource(KindMetricsField, VerbList, VerbRead, VerbUpdate)
)
diff --git a/tests/integration/testdata/role/managed_role_transactions.json b/tests/integration/testdata/role/managed_role_transactions.json
index 3e42e606a4..473ee9651c 100644
--- a/tests/integration/testdata/role/managed_role_transactions.json
+++ b/tests/integration/testdata/role/managed_role_transactions.json
@@ -288,6 +288,15 @@
"list"
]
},
+ {
+ "type": "metaresource",
+ "kind": "metrics-field",
+ "verbs": [
+ "read",
+ "update",
+ "list"
+ ]
+ },
{
"type": "metaresource",
"kind": "ttl-setting",
@@ -510,6 +519,15 @@
"list"
]
},
+ {
+ "type": "metaresource",
+ "kind": "metrics-field",
+ "verbs": [
+ "read",
+ "update",
+ "list"
+ ]
+ },
{
"type": "metaresource",
"kind": "ttl-setting",
@@ -681,6 +699,14 @@
"list"
]
},
+ {
+ "type": "metaresource",
+ "kind": "metrics-field",
+ "verbs": [
+ "read",
+ "list"
+ ]
+ },
{
"type": "metaresource",
"kind": "ttl-setting",
diff --git a/tests/integration/tests/metricsexplorer/01_authz.py b/tests/integration/tests/metricsexplorer/01_authz.py
new file mode 100644
index 0000000000..5e91dd47af
--- /dev/null
+++ b/tests/integration/tests/metricsexplorer/01_authz.py
@@ -0,0 +1,286 @@
+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.metrics import Metrics
+from fixtures.role import transaction_group
+
+user_password = "password123Z$"
+scoped_role = "metrics-explorer-scope-key-a"
+scoped_email = "[email protected]"
+wildcard_role = "metrics-explorer-wildcard"
+wildcard_email = "[email protected]"
+metadata_role = "metrics-explorer-metadata-reader"
+metadata_email = "[email protected]"
+viewer_email = "[email protected]"
+editor_email = "[email protected]"
+
+
+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)
+
+ create_role(
+ admin_token,
+ metadata_role,
+ [transaction_group("read", "metaresource", "metrics-field", ["*"]), transaction_group("list", "metaresource", "metrics-field", ["*"])],
+ )
+ metadata_user = create_active_user(signoz, admin_token, email=metadata_email, role="signoz-viewer", password=user_password)
+ change_user_role(signoz, admin_token, metadata_user, "signoz-viewer", metadata_role)
+
+ create_active_user(signoz, admin_token, email=viewer_email, role="signoz-viewer", password=user_password)
+ create_active_user(signoz, admin_token, email=editor_email, role="signoz-editor", password=user_password)
+
+
+ ("method", "path", "query", "body"),
+ [
+ ("POST", "/api/v2/metrics/stats", None, {"limit": 10}),
+ ("POST", "/api/v2/metrics/treemap", None, {"limit": 10, "mode": "samples"}),
+ ("GET", "/api/v2/metrics/highlights", {"metricName": "explorer.requests"}, None),
+ ("POST", "/api/v2/metrics/inspect", None, {"metricName": "explorer.requests"}),
+ ("GET", "/api/v2/metrics/onboarding", {}, None),
+ ],
+ ids=["stats", "treemap", "highlights", "inspect", "onboarding"],
+)
+ ("email", "expected"),
+ [(scoped_email, HTTPStatus.FORBIDDEN), (metadata_email, HTTPStatus.FORBIDDEN), (wildcard_email, HTTPStatus.OK), (USER_ADMIN_EMAIL, HTTPStatus.OK)],
+ ids=["scoped", "metadata_reader", "wildcard", "admin"],
+)
+def test_telemetry_routes_without_filter(
+ signoz: types.SigNoz,
+ get_token: Callable[[str, str], str],
+ insert_metrics: Callable[[list[Metrics]], None],
+ method: str,
+ path: str,
+ query: dict | None,
+ body: dict | None,
+ email: str,
+ expected: HTTPStatus,
+) -> None:
+ now = datetime.now(tz=UTC).replace(microsecond=0)
+ insert_metrics([Metrics(metric_name="explorer.requests", labels={"signoz.workspace.key.id": "key-a"}, timestamp=now - timedelta(minutes=i + 1), value=float(i)) for i in range(3)])
+ start, end = int((now - timedelta(minutes=10)).timestamp() * 1000), int(now.timestamp() * 1000)
+ token = get_token(email, USER_ADMIN_PASSWORD if email == USER_ADMIN_EMAIL else user_password)
+
+ response = requests.request(
+ method,
+ signoz.self.host_configs["8080"].get(path),
+ params={"start": start, "end": end, **query} if query is not None else None,
+ json={"start": start, "end": end, **body} if body is not None else None,
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=10,
+ )
+ assert response.status_code == expected, response.text
+
+
+ ("path", "query"),
+ [
+ ("/api/v2/metrics", {"limit": 10}),
+ ("/api/v2/metrics/attributes", {"metricName": "explorer.requests"}),
+ ("/api/v2/metrics/metadata", {"metricName": "explorer.requests"}),
+ ],
+ ids=["list", "attributes", "metadata"],
+)
+ ("email", "expected"),
+ [
+ (scoped_email, HTTPStatus.FORBIDDEN),
+ (wildcard_email, HTTPStatus.FORBIDDEN),
+ (metadata_email, HTTPStatus.OK),
+ (viewer_email, HTTPStatus.OK),
+ (USER_ADMIN_EMAIL, HTTPStatus.OK),
+ ],
+ ids=["metrics_scoped", "metrics_wildcard", "metadata_reader", "viewer", "admin"],
+)
+def test_metadata_reads_need_metadata_grant(
+ signoz: types.SigNoz,
+ get_token: Callable[[str, str], str],
+ insert_metrics: Callable[[list[Metrics]], None],
+ path: str,
+ query: dict,
+ email: str,
+ expected: HTTPStatus,
+) -> None:
+ now = datetime.now(tz=UTC).replace(microsecond=0)
+ insert_metrics([Metrics(metric_name="explorer.requests", labels={"signoz.workspace.key.id": "key-a"}, timestamp=now - timedelta(minutes=i + 1), value=float(i)) for i in range(3)])
+ token = get_token(email, USER_ADMIN_PASSWORD if email == USER_ADMIN_EMAIL else user_password)
+
+ response = requests.get(
+ signoz.self.host_configs["8080"].get(path),
+ params={"start": int((now - timedelta(minutes=10)).timestamp() * 1000), "end": int(now.timestamp() * 1000), **query},
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=10,
+ )
+ assert response.status_code == expected, response.text
+ if expected == HTTPStatus.FORBIDDEN:
+ assert "metrics-field" in response.text
+
+
+ ("email", "expected"),
+ [
+ (scoped_email, HTTPStatus.FORBIDDEN),
+ (metadata_email, HTTPStatus.FORBIDDEN),
+ (viewer_email, HTTPStatus.FORBIDDEN),
+ (editor_email, HTTPStatus.OK),
+ (USER_ADMIN_EMAIL, HTTPStatus.OK),
+ ],
+ ids=["metrics_scoped", "metadata_reader", "viewer", "editor", "admin"],
+)
+def test_metadata_update_needs_update_grant(
+ signoz: types.SigNoz,
+ get_token: Callable[[str, str], str],
+ insert_metrics: Callable[[list[Metrics]], None],
+ email: str,
+ expected: HTTPStatus,
+) -> None:
+ now = datetime.now(tz=UTC).replace(microsecond=0)
+ insert_metrics([Metrics(metric_name="explorer.requests", labels={"signoz.workspace.key.id": "key-a"}, timestamp=now - timedelta(minutes=i + 1), value=float(i)) for i in range(3)])
+ token = get_token(email, USER_ADMIN_PASSWORD if email == USER_ADMIN_EMAIL else user_password)
+
+ response = requests.post(
+ signoz.self.host_configs["8080"].get("/api/v2/metrics/metadata"),
+ json={"metricName": "explorer.requests", "type": "sum", "description": "request count", "unit": "1", "temporality": "cumulative", "isMonotonic": True},
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=10,
+ )
+ assert response.status_code == expected, response.text
+
+
+ ("email", "expression", "expected", "expected_metrics"),
+ [
+ (scoped_email, "signoz.workspace.key.id = 'key-a'", HTTPStatus.OK, {"explorer.key.a"}),
+ (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, {"explorer.key.a", "explorer.key.b"}),
+ ],
+ ids=["scoped_granted_key", "scoped_other_key", "scoped_both_keys", "wildcard_unfiltered"],
+)
+def test_stats_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_metrics: set[str],
+) -> None:
+ now = datetime.now(tz=UTC).replace(microsecond=0)
+ insert_metrics(
+ [Metrics(metric_name="explorer.key.a", labels={"signoz.workspace.key.id": "key-a"}, timestamp=now - timedelta(minutes=i + 1), value=float(i)) for i in range(3)]
+ + [Metrics(metric_name="explorer.key.b", labels={"signoz.workspace.key.id": "key-b"}, timestamp=now - timedelta(minutes=i + 1), value=float(i)) for i in range(3)]
+ )
+
+ body: dict = {"start": int((now - timedelta(minutes=10)).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/metrics/stats"),
+ 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 {stat["metricName"] for stat in response.json()["data"]["metrics"]} == expected_metrics
+
+
+ ("path", "body"),
+ [
+ ("/api/v2/metrics/treemap", {"limit": 10, "mode": "samples"}),
+ ("/api/v2/metrics/inspect", {"metricName": "explorer.key.a"}),
+ ],
+ ids=["treemap", "inspect"],
+)
+def test_filtered_routes_allow_granted_key(
+ signoz: types.SigNoz,
+ get_token: Callable[[str, str], str],
+ insert_metrics: Callable[[list[Metrics]], None],
+ path: str,
+ body: dict,
+) -> None:
+ now = datetime.now(tz=UTC).replace(microsecond=0)
+ insert_metrics([Metrics(metric_name="explorer.key.a", labels={"signoz.workspace.key.id": "key-a"}, timestamp=now - timedelta(minutes=i + 1), value=float(i)) for i in range(3)])
+ start, end = int((now - timedelta(minutes=10)).timestamp() * 1000), int(now.timestamp() * 1000)
+ token = get_token(scoped_email, user_password)
+
+ allowed = requests.post(
+ signoz.self.host_configs["8080"].get(path),
+ json={"start": start, "end": end, "filter": {"expression": "signoz.workspace.key.id = 'key-a'"}, **body},
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=10,
+ )
+ assert allowed.status_code == HTTPStatus.OK, allowed.text
+
+ denied = requests.post(
+ signoz.self.host_configs["8080"].get(path),
+ json={"start": start, "end": end, "filter": {"expression": "signoz.workspace.key.id = 'key-b'"}, **body},
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=10,
+ )
+ assert denied.status_code == HTTPStatus.FORBIDDEN, denied.text
+ assert "builder_query/signoz.workspace.key.id/key-b" in denied.text
+
+
+ ("path", "scope"),
+ [("/api/v2/metrics/alerts", "rule:list"), ("/api/v3/metrics/dashboards", "dashboard:list")],
+ ids=["alerts", "dashboards"],
+)
+ ("email", "expected"),
+ [(scoped_email, HTTPStatus.FORBIDDEN), (wildcard_email, HTTPStatus.FORBIDDEN), (USER_ADMIN_EMAIL, HTTPStatus.OK)],
+ ids=["metrics_scoped", "metrics_wildcard", "admin"],
+)
+def test_metaresource_lookups_need_list_grant(
+ signoz: types.SigNoz,
+ get_token: Callable[[str, str], str],
+ insert_metrics: Callable[[list[Metrics]], None],
+ path: str,
+ scope: str,
+ email: str,
+ expected: HTTPStatus,
+) -> None:
+ now = datetime.now(tz=UTC).replace(microsecond=0)
+ insert_metrics([Metrics(metric_name="explorer.requests", labels={"signoz.workspace.key.id": "key-a"}, timestamp=now - timedelta(minutes=i + 1), value=float(i)) for i in range(3)])
+ token = get_token(email, USER_ADMIN_PASSWORD if email == USER_ADMIN_EMAIL else user_password)
+ response = requests.get(
+ signoz.self.host_configs["8080"].get(path),
+ params={"metricName": "explorer.requests"},
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=10,
+ )
+ assert response.status_code == expected, response.text
+ if expected == HTTPStatus.FORBIDDEN:
+ assert scope.split(":", maxsplit=1)[0] in response.text