📋 Description
Analytics and Business Intelligence provides insights into the content production. By visualizing trends, identifying bottlenecks, and highlighting opportunities for improvement.
💎 Business Value
Enables data-driven decision-making—helping organizations optimize their content strategy, governance, and resource allocation.
✓ Merged to main
🕐 Development time: 0d-22h-12m⏱ Time to deployment: 0d-00h-01m
📋 Development Summary
Summary: This work delivered a business intelligence metrics capability spanning event emission, external metrics ingestion, and improved event persistence behavior. The implementation also strengthened observability through structured logging, added safeguards such as zero-overhead checks and rate limiting, and included supporting documentation and quality guidance. A final fix corrected a metadata field reference in `ObjectMetadataOperations` to align with the updated schema.
Key Changes:
- Implemented business intelligence event emission with zero-overhead checks and structured logging for more efficient, observable metric collection.
- Added an external metrics ingestion service with rate limiting and event emission support to enable controlled intake of BI data.
- Refactored event persistence to prioritize user operations and ensure customer ID is included in all emitted events.
- Added specification quality checklist content and Azure resource management prompts/best-practices documentation to support implementation quality and operational consistency.
- Fixed `ObjectMetadataOperations` to reference `ClassificationMetadata` instead of `Classifications`, resolving a schema/field naming issue.
Impact: These changes improve the platform’s ability to capture, process, and govern business intelligence metrics reliably at scale while maintaining performance and traceability. The result is better analytics readiness, stronger operational controls, and reduced risk of data quality or integration issues.
🔧 API Changes (43 files)
-
A
src/Aleido.Platform.API/Configuration/MetricsOptions.cs
-
M
src/Aleido.Platform.API/Endpoints/AccessControlEndpoints.cs
-
M
src/Aleido.Platform.API/Endpoints/FolderEndpoints.cs
-
A
src/Aleido.Platform.API/Endpoints/InternalMetricsEndpoints.cs
-
M
src/Aleido.Platform.API/Endpoints/LockEndpoints.cs
-
M
src/Aleido.Platform.API/Endpoints/ObjectEndpoints.cs
-
M
src/Aleido.Platform.API/Endpoints/ObjectTypeEndpoints.cs
-
M
src/Aleido.Platform.API/Endpoints/RoleEndpoints.cs
-
M
src/Aleido.Platform.API/Extensions/ServiceRegistrationExtensions.cs
-
M
src/Aleido.Platform.API/Extensions/WebApplicationExtensions.cs
-
A
src/Aleido.Platform.API/Features/CustomerTargetingContextAccessor.cs
-
A
src/Aleido.Platform.API/Features/FeatureFlags.cs
-
A
src/Aleido.Platform.API/Middleware/AuthenticationMetricsMiddleware.cs
-
M
src/Aleido.Platform.API/Middleware/InternalAccessGuardMiddleware.cs
-
A
src/Aleido.Platform.API/Models/EventTypes.cs
-
A
src/Aleido.Platform.API/Models/ExternalMetricRequest.cs
-
A
src/Aleido.Platform.API/Models/RawEvent.cs
-
M
src/Aleido.Platform.API/Models/Requests/FolderRequests.cs
-
M
src/Aleido.Platform.API/Models/Responses/ObjectMetadataResponse.cs
-
M
src/Aleido.Platform.API/OpenApi/InternalTagDocumentTransformer.cs
-
M
src/Aleido.Platform.API/Program.cs
-
M
src/Aleido.Platform.API/README.md
-
M
src/Aleido.Platform.API/Services/ApprovalService.cs
-
A
src/Aleido.Platform.API/Services/BiEventHelper.cs
-
M
src/Aleido.Platform.API/Services/BinaryObjectService.cs
-
M
src/Aleido.Platform.API/Services/CollaborationService.cs
-
A
src/Aleido.Platform.API/Services/EventEmitter.cs
-
A
src/Aleido.Platform.API/Services/ExternalMetricsIngestionService.cs
-
A
src/Aleido.Platform.API/Services/ExternalMetricsRateLimiter.cs
-
M
src/Aleido.Platform.API/Services/FolderService.cs
-
A
src/Aleido.Platform.API/Services/IEventEmitter.cs
-
A
src/Aleido.Platform.API/Services/IExternalMetricsIngestionService.cs
-
A
src/Aleido.Platform.API/Services/IGeoMetadataResolver.cs
-
M
src/Aleido.Platform.API/Services/Locking/CheckoutService.cs
-
M
src/Aleido.Platform.API/Services/Media/MediaTokenFactory.cs
-
M
src/Aleido.Platform.API/Services/Metadata/IMetadataAdminService.cs
-
M
src/Aleido.Platform.API/Services/ObjectService.Operations.cs
-
M
src/Aleido.Platform.API/Services/ObjectService.cs
-
M
src/Aleido.Platform.API/Services/PreviewService.cs
-
M
src/Aleido.Platform.API/Services/Publishing/PublishingService.cs
-
M
src/Aleido.Platform.API/Services/UserRoleService.cs
-
M
src/Aleido.Platform.API/Services/WorkspaceService.cs
-
M
src/Aleido.Platform.API/appsettings.json
📝 Commit Log
25d2f3dcb fix: update field reference from 'Classifications' to 'ClassificationMetadata' in ObjectMetadataOperations
a8bab000f Merge branch 'main' into 021-business-intelligence-metrics
7dc6b436a style: Refactor code for consistency and readability by standardizing whitespace and formatting across multiple files
cae5e4cd7 Merge branch 'main' into 021-business-intelligence-metrics
9aa6baa09 feat: Enhance BI event emission with zero overhead checks and structured logging
b1fca43f8 feat: Implement external metrics ingestion service with rate limiting and event emission
b8e11ebb0 feat: add comprehensive Azure resource management prompts and best practices documentation
9d881a86d Merge branch 'main' into 021-business-intelligence-metrics
d332caf00 refactor: update event persistence strategy to prioritize user operations and include customer ID in all events
dcd37d884 feat: add specification quality checklist for business intelligence metrics
Documentation & External Components
Produce developer documentation for emitters, event schemas, examples for each event type, architecture, telemetry, feature flags, and integration points with the external BI Function.
Extended Event Types
Support additional BI-relevant event categories such as collaboration, content/metadata changes, authentication, external tool metrics, access, search, workspace, and user management.
Event Emission Infrastructure
Implement the core infrastructure for emitting and persisting BI events, including configuration, SDK dependencies, feature flags, interfaces, factories, dependency injection, queue integration, and health checks.
Core Business Event Capture
Integrate event emission with document lifecycle, user activity, and related domain workflows according to high-priority user stories.
Cross-Cutting: Validation, Telemetry & Audit
Provide consistent validation patterns, structured error logging, telemetry metrics, performance/security reviews, and audit logging across all event types.