Minor modifications to the existing analytics flow

Author: O-sura

gateway/gateway-controller/pkg/xds/translator.go

@@ -401,7 +401,7 @@ func (t *Translator) translateAPIConfig(cfg *models.StoredConfig) ([]*route.Rout
 	for _, op := range apiData.Operations {
 		// Use mainClusterName by default; path rewrite based on main upstream path
 		r := t.createRoute(cfg.ID, apiData.DisplayName, apiData.Version, apiData.Context, string(op.Method), op.Path,
-			mainClusterName, parsedMainURL.Path, effectiveMainVHost)
+			mainClusterName, parsedMainURL.Path, effectiveMainVHost, cfg.Kind)
 		mainRoutesList = append(mainRoutesList, r)
 	}
 	routesList = append(routesList, mainRoutesList...)
@@ -420,7 +420,7 @@ func (t *Translator) translateAPIConfig(cfg *models.StoredConfig) ([]*route.Rout
 		for _, op := range apiData.Operations {
 			// Use sbClusterName for sandbox upstream path
 			r := t.createRoute(cfg.ID, apiData.DisplayName, apiData.Version, apiData.Context, string(op.Method), op.Path,
-				sbClusterName, parsedSbURL.Path, effectiveSandboxVHost)
+				sbClusterName, parsedSbURL.Path, effectiveSandboxVHost, cfg.Kind)
 			sbRoutesList = append(sbRoutesList, r)
 		}
 		routesList = append(routesList, sbRoutesList...)
@@ -786,7 +786,7 @@ func (t *Translator) createRouteConfiguration(virtualHosts []*route.VirtualHost)
 
 // createRoute creates a route for an operation
 func (t *Translator) createRoute(apiId, apiName, apiVersion, context, method, path, clusterName,
-	upstreamPath string, vhost string) *route.Route {
+	upstreamPath string, vhost string, apiKind string) *route.Route {
 	// Resolve version placeholder in context
 	context = strings.ReplaceAll(context, "$version", apiVersion)
 
@@ -878,6 +878,7 @@ func (t *Translator) createRoute(apiId, apiName, apiVersion, context, method, pa
 		"path":        path,
 		"method":      method,
 		"vhost":       vhost,
+		"api_kind":    apiKind,
 	}
 	if metaStruct, err := structpb.NewStruct(metaMap); err == nil {
 		r.Metadata = &core.Metadata{FilterMetadata: map[string]*structpb.Struct{

gateway/policy-engine/internal/analytics/analytics.go

@@ -148,7 +148,19 @@ func (c *Analytics) prepareAnalyticEvent(logEntry *v3.HTTPAccessLogEntry) *dto.E
 				slog.Debug(fmt.Sprintf("Filter metadata: %+v", sv))
 				for key, value := range sv.Fields {
 					if value != nil {
-						keyValuePairsFromMetadata[key] = value.GetStringValue()
+						if key == "analytics_data" {
+							// Handle the analytics_data struct
+							if analyticsStruct := value.GetStructValue(); analyticsStruct != nil {
+								for analyticsKey, analyticsValue := range analyticsStruct.Fields {
+									if analyticsValue != nil {
+										keyValuePairsFromMetadata[analyticsKey] = analyticsValue.GetStringValue()
+									}
+								}
+							}
+						} else {
+							// Handle regular string values
+							keyValuePairsFromMetadata[key] = value.GetStringValue()
+						}
 					}
 				}
 			}

gateway/policy-engine/internal/analytics/constants.go

@@ -98,7 +98,7 @@ const (
 	// APIVersionKey is the key for the API version.
 	APIVersionKey = Wso2MetadataPrefix + "api-version"
 	// APITypeKey is the key for the API type.
-	APITypeKey = Wso2MetadataPrefix + "api-type"
+	APITypeKey = Wso2MetadataPrefix + "api-kind"
 	// APIUserNameKey is the key for the API user name.
 	APIUserNameKey = Wso2MetadataPrefix + "username"
 	// APIContextKey is the key for the API context.
@@ -141,8 +141,6 @@ const (
 
 	// ErrorCodeKey is the key for the error code.
 	ErrorCodeKey = "ErrorCode"
-	// ApkEnforcerReply is the key for the APK enforcer reply.
-	ApkEnforcerReply = "apk-enforcer-reply"
 	// RatelimitWso2OrgPrefix is the prefix for WSO2 organization rate limit.
 	RatelimitWso2OrgPrefix = "customorg"
 	// APIEnvironmentKey is the key for the API environment.

gateway/policy-engine/internal/analytics/publishers/moesif.go

@@ -108,7 +108,7 @@ func (m *Moesif) Publish(event *dto.Event) {
 		Verb:       event.Operation.APIMethod,
 		ApiVersion: &event.API.APIVersion,
 		IpAddress:  &event.UserIP,
-		Headers: map[string]interface{}{ // TODO: Need to populate them dynamically
+		Headers: map[string]interface{}{ // TODO (osura): Need to populate them dynamically
 			"User-Agent":   event.UserAgentHeader,
 			"Content-Type": "application/json",
 		},
@@ -119,7 +119,7 @@ func (m *Moesif) Publish(event *dto.Event) {
 		respTime = event.RequestTimestamp.Add(time.Duration(event.Latencies.ResponseLatency) * time.Millisecond)
 	}
 
-	rspHeaders := map[string]string{ //TODO: Need to populate them dynamically
+	rspHeaders := map[string]string{ //TODO (osura): Need to populate them dynamically
 		"Vary":          "Accept-Encoding",
 		"Pragma":        "no-cache",
 		"Expires":       "-1",
@@ -133,7 +133,12 @@ func (m *Moesif) Publish(event *dto.Event) {
 		Headers: rspHeaders,
 	}
 
-	metadataMap := m.prepareMetadataMap(event.Properties)
+	// Medatadata Map for the event
+	metadataMap := make(map[string]interface{})
+	m.addToMetadata("apiContext", event.API.APIContext, metadataMap)
+	m.addToMetadata("apiName", event.API.APIName, metadataMap)
+	m.addToMetadata("apiVersion", event.API.APIVersion, metadataMap)
+	m.addToMetadata("apiType", event.API.APIType, metadataMap)
 
 	userID := anonymous
 	eventModel := &models.EventModel{
@@ -148,13 +153,6 @@ func (m *Moesif) Publish(event *dto.Event) {
 }
 
 // Map any additional metadata related to the event provided under properties
-func (m *Moesif) prepareMetadataMap(eventProps map[string]interface{}) map[string]interface{} {
-	metadataMap := make(map[string]interface{})
-	if aiMetadata, ok := eventProps["aiMetadata"]; ok {
-		metadataMap["aiMetadata"] = aiMetadata
-	}
-	if aiTokenUsage, ok := eventProps["aiTokenUsage"]; ok {
-		metadataMap["aiTokenUsage"] = aiTokenUsage
-	}
-	return metadataMap
+func (m *Moesif) addToMetadata(key, val string, metadataMap map[string]interface{}) {
+	metadataMap[key] = val
 }

gateway/policy-engine/internal/kernel/analytics.go

@@ -26,6 +26,18 @@ import (
 	"github.com/policy-engine/policy-engine/internal/constants"
 )
 
+// Constants for analytics metadata
+const (
+		Wso2MetadataPrefix = "x-wso2-"
+		APIIDKey = Wso2MetadataPrefix + "api-id"
+		APINameKey = Wso2MetadataPrefix + "api-name"
+		APIVersionKey = Wso2MetadataPrefix + "api-version"
+		APITypeKey = Wso2MetadataPrefix + "api-type"
+		APIContextKey = Wso2MetadataPrefix + "api-context"
+		OperationPathKey = Wso2MetadataPrefix + "operation-path"
+		APIKindKey = Wso2MetadataPrefix + "api-kind"
+)
+
 // buildAnalyticsStruct converts analytics metadata map to structpb.Struct
 // If execCtx is provided, adds system-level metadata (API name, version, etc.) to analytics_data.metadata
 func buildAnalyticsStruct(analyticsData map[string]any, execCtx *PolicyExecutionContext) (*structpb.Struct, error) {
@@ -43,31 +55,25 @@ func buildAnalyticsStruct(analyticsData map[string]any, execCtx *PolicyExecution
 
 	// Add system-level metadata if context is provided
 	if execCtx != nil && execCtx.requestContext != nil && execCtx.requestContext.SharedContext != nil {
-		metadata := make(map[string]interface{})
 
 		sharedCtx := execCtx.requestContext.SharedContext
 		if sharedCtx.APIId != "" {
-			metadata["api_id"] = sharedCtx.APIId
+			fields[APIIDKey] = structpb.NewStringValue(sharedCtx.APIId)
 		}
 		if sharedCtx.APIName != "" {
-			metadata["api_name"] = sharedCtx.APIName
+			fields[APINameKey] = structpb.NewStringValue(sharedCtx.APIName)
 		}
 		if sharedCtx.APIVersion != "" {
-			metadata["api_version"] = sharedCtx.APIVersion
+			fields[APIVersionKey] = structpb.NewStringValue(sharedCtx.APIVersion)
 		}
 		if sharedCtx.APIContext != "" {
-			metadata["api_context"] = sharedCtx.APIContext
+			fields[APIContextKey] = structpb.NewStringValue(sharedCtx.APIContext)
 		}
 		if sharedCtx.OperationPath != "" {
-			metadata["operation_path"] = sharedCtx.OperationPath
+			fields[OperationPathKey] = structpb.NewStringValue(sharedCtx.OperationPath)
 		}
-
-		if len(metadata) > 0 {
-			metadataVal, err := structpb.NewValue(metadata)
-			if err != nil {
-				return nil, fmt.Errorf("failed to convert system metadata: %w", err)
-			}
-			fields["metadata"] = metadataVal
+		if sharedCtx.APIKind != "" {
+			fields[APIKindKey] = structpb.NewStringValue(sharedCtx.APIKind)
 		}
 	}
 
@@ -99,16 +105,19 @@ func buildDynamicMetadata(analyticsStruct *structpb.Struct) *structpb.Struct {
 func extractMetadataFromRouteMetadata(routeMeta RouteMetadata) map[string]interface{} {
 	metadata := make(map[string]interface{})
 	if routeMeta.APIName != "" {
-		metadata["api_name"] = routeMeta.APIName
+		metadata[APINameKey] = routeMeta.APIName
 	}
 	if routeMeta.APIVersion != "" {
-		metadata["api_version"] = routeMeta.APIVersion
+		metadata[APIVersionKey] = routeMeta.APIVersion
 	}
 	if routeMeta.Context != "" {
-		metadata["api_context"] = routeMeta.Context
+		metadata[APIContextKey] = routeMeta.Context
 	}
 	if routeMeta.OperationPath != "" {
-		metadata["operation_path"] = routeMeta.OperationPath
+		metadata[OperationPathKey] = routeMeta.OperationPath
+	}
+	if routeMeta.APIKind != "" {
+		metadata[APIKindKey] = routeMeta.APIKind
 	}
 	return metadata
 }

gateway/policy-engine/internal/kernel/execution_context.go

@@ -332,6 +332,7 @@ func (ec *PolicyExecutionContext) buildRequestContext(headers *extprocv3.HttpHea
 		APIId:         routeMetadata.APIId,
 		APIName:       routeMetadata.APIName,
 		APIVersion:    routeMetadata.APIVersion,
+		APIKind:       routeMetadata.APIKind,
 		APIContext:    routeMetadata.Context,
 		OperationPath: routeMetadata.OperationPath,
 		Metadata:      make(map[string]interface{}),

gateway/policy-engine/internal/kernel/extproc.go

@@ -324,6 +324,7 @@ type RouteMetadata struct {
 	Context       string
 	OperationPath string
 	Vhost         string
+	APIKind       string
 }
 
 // extractRouteMetadata extracts the route metadata from Envoy metadata
@@ -374,6 +375,9 @@ func (s *ExternalProcessorServer) extractRouteMetadata(req *extprocv3.Processing
 					if vhostValue, ok := routeStruct.Fields["vhost"]; ok {
 						metadata.Vhost = vhostValue.GetStringValue()
 					}
+					if originalAPIKindValue, ok := routeStruct.Fields["api_kind"]; ok {
+						metadata.APIKind = originalAPIKindValue.GetStringValue()
+					}
 				}
 			}
 		}

sdk/gateway/policy/v1alpha/context.go

@@ -38,6 +38,9 @@ type SharedContext struct {
 	// APIVersion is the version of the API (e.g., "v1.0.0")
 	APIVersion string
 
+	// APIKind is the type of the API
+	APIKind string
+
 	// APIContext is the base context path of the API (e.g., "/petstore")
 	// This is the base path without the version
 	APIContext string