feat: added routing engine label in logs and telemetry

Author: Pratham-Mishra04

core/schemas/bifrost.go

@@ -184,6 +184,7 @@ const (
 	BifrostContextKeyIsCustomProvider                    BifrostContextKey = "bifrost-is-custom-provider"                       // bool (set by bifrost - DO NOT SET THIS MANUALLY))
 	BifrostContextKeyHTTPRequestType                     BifrostContextKey = "bifrost-http-request-type"                        // RequestType (set by bifrost - DO NOT SET THIS MANUALLY))
 	BifrostContextKeyPassthroughExtraParams              BifrostContextKey = "bifrost-passthrough-extra-params"                 // bool
+	BifrostContextKeyRoutingEngineUsed                   BifrostContextKey = "bifrost-routing-engine-used"                      // string (set by bifrost - DO NOT SET THIS MANUALLY) - either "routing-rule", "governance" or "loadbalancing"
 )
 
 // NOTE: for custom plugin implementation dealing with streaming short circuit,

docs/features/telemetry.mdx

@@ -62,6 +62,7 @@ Base Labels:
 - `method`: Request type (`chat`, `text`, `embedding`, `speech`, `transcription`)
 - `virtual_key_id`: Virtual key ID
 - `virtual_key_name`: Virtual key name
+- `routing_engine_used`: Routing engine used ("routing-rule", "governance", "loadbalancing")
 - `routing_rule_id`: Routing rule ID that matched the request
 - `routing_rule_name`: Routing rule name that matched the request
 - `selected_key_id`: Selected key ID

docs/openapi/paths/management/logging.yaml

@@ -42,6 +42,11 @@ logs:
         description: Comma-separated list of routing rule IDs to filter by
         schema:
           type: string
+      - name: routing_engine_used
+        in: query
+        description: Comma-separated list of routing engines to filter by (routing-rule, governance, or loadbalancing)
+        schema:
+          type: string
       - name: start_time
         in: query
         description: Start time filter (RFC3339 format)
@@ -200,6 +205,11 @@ logs-stats:
         description: Comma-separated list of routing rule IDs to filter by
         schema:
           type: string
+      - name: routing_engine_used
+        in: query
+        description: Comma-separated list of routing engines to filter by (routing-rule, governance, or loadbalancing)
+        schema:
+          type: string
       - name: start_time
         in: query
         description: Start time filter (RFC3339 format)

docs/openapi/schemas/management/logging.yaml

@@ -37,6 +37,16 @@ LogEntry:
     virtual_key_name:
       type: string
       nullable: true
+    routing_engine_used:
+      type: string
+      description: The routing engine used for this request (routing-rule, governance, or loadbalancing)
+      nullable: true
+    routing_rule_id:
+      type: string
+      nullable: true
+    routing_rule_name:
+      type: string
+      nullable: true
     stream:
       type: boolean
     raw_request:
@@ -320,6 +330,15 @@ SearchFilters:
       type: array
       items:
         type: string
+    routing_rule_ids:
+      type: array
+      items:
+        type: string
+    routing_engine_used:
+      type: array
+      items:
+        type: string
+      description: Filter by routing engine (routing-rule, governance, or loadbalancing)
     start_time:
       type: string
       format: date-time
@@ -397,6 +416,16 @@ FilterDataResponse:
       type: array
       items:
         $ref: '../../schemas/management/governance.yaml#/VirtualKey'
+    routing_rules:
+      type: array
+      items:
+        $ref: '../../schemas/management/governance.yaml#/RoutingRule'
+      description: Available routing rules for filtering
+    routing_engines:
+      type: array
+      items:
+        type: string
+      description: Available routing engine types (routing-rule, governance, loadbalancing)
 
 DeleteLogsRequest:
   type: object

framework/changelog.md

@@ -1,3 +1,4 @@
 - feat: add base_model support to model catalog for cross-provider model matching
 - feat: add GetBaseModelName, IsSameModel, and GetDistinctBaseModelNames methods to ModelCatalog for resolving model aliases and checking model equivalence
 - feat: add database migration for base_model column on model pricing table
+- feat: add database migration for routing_engine_used column on logs table

framework/logstore/migrations.go

@@ -61,6 +61,9 @@ func triggerMigrations(ctx context.Context, db *gorm.DB) error {
 	if err := migrationAddVirtualKeyColumnsToMCPToolLogs(ctx, db); err != nil {
 		return err
 	}
+	if err := migrationAddRoutingEngineUsedColumn(ctx, db); err != nil {
+		return err
+	}
 	return nil
 }
 
@@ -985,3 +988,36 @@ func migrationAddVirtualKeyColumnsToMCPToolLogs(ctx context.Context, db *gorm.DB
 	}
 	return nil
 }
+
+func migrationAddRoutingEngineUsedColumn(ctx context.Context, db *gorm.DB) error {
+	opts := *migrator.DefaultOptions
+	opts.UseTransaction = true
+	m := migrator.New(db, &opts, []*migrator.Migration{{
+		ID: "logs_add_routing_engine_used_column",
+		Migrate: func(tx *gorm.DB) error {
+			tx = tx.WithContext(ctx)
+			migrator := tx.Migrator()
+			if !migrator.HasColumn(&Log{}, "routing_engine_used") {
+				if err := migrator.AddColumn(&Log{}, "routing_engine_used"); err != nil {
+					return err
+				}
+			}
+			return nil
+		},
+		Rollback: func(tx *gorm.DB) error {
+			tx = tx.WithContext(ctx)
+			migrator := tx.Migrator()
+			if migrator.HasColumn(&Log{}, "routing_engine_used") {
+				if err := migrator.DropColumn(&Log{}, "routing_engine_used"); err != nil {
+					return err
+				}
+			}
+			return nil
+		},
+	}})
+	err := m.Migrate()
+	if err != nil {
+		return fmt.Errorf("error while adding routing engine used column: %s", err.Error())
+	}
+	return nil
+}

framework/logstore/rdb.go

@@ -64,6 +64,9 @@ func (s *RDBLogStore) applyFilters(baseQuery *gorm.DB, filters SearchFilters) *g
 	if len(filters.RoutingRuleIDs) > 0 {
 		baseQuery = baseQuery.Where("routing_rule_id IN ?", filters.RoutingRuleIDs)
 	}
+	if len(filters.RoutingEngineUsed) > 0 {
+		baseQuery = baseQuery.Where("routing_engine_used IN ?", filters.RoutingEngineUsed)
+	}
 	if filters.StartTime != nil {
 		baseQuery = baseQuery.Where("timestamp >= ?", *filters.StartTime)
 	}

framework/logstore/tables.go

@@ -30,23 +30,24 @@ const (
 
 // SearchFilters represents the available filters for log searches
 type SearchFilters struct {
-	Providers       []string   `json:"providers,omitempty"`
-	Models          []string   `json:"models,omitempty"`
-	Status          []string   `json:"status,omitempty"`
-	Objects         []string   `json:"objects,omitempty"` // For filtering by request type (chat.completion, text.completion, embedding)
-	SelectedKeyIDs  []string   `json:"selected_key_ids,omitempty"`
-	VirtualKeyIDs   []string   `json:"virtual_key_ids,omitempty"`
-	RoutingRuleIDs  []string   `json:"routing_rule_ids,omitempty"`
-	StartTime       *time.Time `json:"start_time,omitempty"`
-	EndTime         *time.Time `json:"end_time,omitempty"`
-	MinLatency      *float64   `json:"min_latency,omitempty"`
-	MaxLatency      *float64   `json:"max_latency,omitempty"`
-	MinTokens       *int       `json:"min_tokens,omitempty"`
-	MaxTokens       *int       `json:"max_tokens,omitempty"`
-	MinCost         *float64   `json:"min_cost,omitempty"`
-	MaxCost         *float64   `json:"max_cost,omitempty"`
-	MissingCostOnly bool       `json:"missing_cost_only,omitempty"`
-	ContentSearch   string     `json:"content_search,omitempty"`
+	Providers         []string   `json:"providers,omitempty"`
+	Models            []string   `json:"models,omitempty"`
+	Status            []string   `json:"status,omitempty"`
+	Objects           []string   `json:"objects,omitempty"` // For filtering by request type (chat.completion, text.completion, embedding)
+	SelectedKeyIDs    []string   `json:"selected_key_ids,omitempty"`
+	VirtualKeyIDs     []string   `json:"virtual_key_ids,omitempty"`
+	RoutingRuleIDs    []string   `json:"routing_rule_ids,omitempty"`
+	RoutingEngineUsed []string   `json:"routing_engine_used,omitempty"` // For filtering by routing engine (routing-rule, governance, loadbalancing)
+	StartTime         *time.Time `json:"start_time,omitempty"`
+	EndTime           *time.Time `json:"end_time,omitempty"`
+	MinLatency        *float64   `json:"min_latency,omitempty"`
+	MaxLatency        *float64   `json:"max_latency,omitempty"`
+	MinTokens         *int       `json:"min_tokens,omitempty"`
+	MaxTokens         *int       `json:"max_tokens,omitempty"`
+	MinCost           *float64   `json:"min_cost,omitempty"`
+	MaxCost           *float64   `json:"max_cost,omitempty"`
+	MissingCostOnly   bool       `json:"missing_cost_only,omitempty"`
+	ContentSearch     string     `json:"content_search,omitempty"`
 }
 
 // PaginationOptions represents pagination parameters
@@ -89,6 +90,7 @@ type Log struct {
 	SelectedKeyName       string    `gorm:"type:varchar(255)" json:"selected_key_name"`
 	VirtualKeyID          *string   `gorm:"type:varchar(255);index:idx_logs_virtual_key_id" json:"virtual_key_id"`
 	VirtualKeyName        *string   `gorm:"type:varchar(255)" json:"virtual_key_name"`
+	RoutingEngineUsed     *string   `gorm:"type:varchar(255);index:idx_logs_routing_engine_used" json:"routing_engine_used"`
 	RoutingRuleID         *string   `gorm:"type:varchar(255);index:idx_logs_routing_rule_id" json:"routing_rule_id"`
 	RoutingRuleName       *string   `gorm:"type:varchar(255)" json:"routing_rule_name"`
 	InputHistory          string    `gorm:"type:text" json:"-"` // JSON serialized []schemas.ChatMessage

plugins/governance/main.go

@@ -529,6 +529,7 @@ func (p *GovernancePlugin) loadBalanceProvider(ctx *schemas.BifrostContext, req
 		// Update the model field in the request body
 		body["model"] = string(selectedProvider) + "/" + refinedModel
 	}
+	ctx.SetValue(schemas.BifrostContextKeyRoutingEngineUsed, "governance")
 
 	// Check if fallbacks field is already present
 	_, hasFallbacks := body["fallbacks"]
@@ -650,6 +651,7 @@ func (p *GovernancePlugin) applyRoutingRules(ctx *schemas.BifrostContext, req *s
 			// For regular requests, update in body
 			body["model"] = decision.Provider + "/" + decision.Model
 		}
+		ctx.SetValue(schemas.BifrostContextKeyRoutingEngineUsed, "routing-rule")
 
 		// Add fallbacks if present
 		if len(decision.Fallbacks) > 0 {

plugins/logging/changelog.md

@@ -0,0 +1 @@
+- feat: add routing engine used to log entries