@umacloud/knowledge 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/00-governance/governance-capabilities.md +557 -0
- package/00-governance/knowledge-map.md +39 -0
- package/00-governance/maintenance-policy.md +76 -0
- package/00-governance/review-checklist.md +81 -0
- package/README.md +13 -0
- package/ai/01-standards/agent-development-complete.md +691 -0
- package/ai/01-standards/llm-application-complete.md +488 -0
- package/ai/01-standards/mlops-complete.md +798 -0
- package/ai/01-standards/prompt-engineering-complete.md +646 -0
- package/ai/01-standards/rag-architecture-complete.md +649 -0
- package/ai/02-playbooks/llm-evaluation-playbook.md +847 -0
- package/ai/03-checklists/ai-project-checklist.md +215 -0
- package/ai/04-antipatterns/ai-antipatterns.md +661 -0
- package/ai/05-cases/case-rag-production.md +147 -0
- package/ai/06-glossary/ai-glossary.md +162 -0
- package/ai/agent-evaluation-benchmark.md +53 -0
- package/ai/ai-agent-memory-context-management.md +41 -0
- package/ai/ai-cost-capacity-optimization-playbook.md +42 -0
- package/ai/ai-data-security-and-compliance-playbook.md +37 -0
- package/ai/ai-domain-index-and-checklist.md +40 -0
- package/ai/ai-governance-maturity-model.md +50 -0
- package/ai/ai-model-selection-and-routing-strategy.md +47 -0
- package/ai/ai-observability-and-oncall-runbook.md +52 -0
- package/ai/ai-rag-engineering-playbook.md +42 -0
- package/ai/ai-red-team-and-safety-evaluation.md +42 -0
- package/ai/ai-release-readiness-and-rollback-gate.md +42 -0
- package/ai/llm-agent-engineering-deep-dive.md +57 -0
- package/ai/prompt-and-tool-guardrails.md +52 -0
- package/api/01-standards/enterprise-api-standards.md +198 -0
- package/api/01-standards/rest-api-design-guide.md +63 -0
- package/api/02-playbooks/api-pagination-playbook.md +93 -0
- package/api/02-playbooks/graphql-production-playbook.md +176 -0
- package/api/03-checklists/api-review-checklist.md +55 -0
- package/api/04-antipatterns/api-antipatterns.md +112 -0
- package/architecture/01-standards/api-gateway-patterns.md +496 -0
- package/architecture/01-standards/cloud-native-patterns.md +644 -0
- package/architecture/01-standards/distributed-systems-patterns.md +591 -0
- package/architecture/01-standards/event-driven-architecture.md +595 -0
- package/architecture/01-standards/microservices-patterns-complete.md +968 -0
- package/architecture/01-standards/microservices-patterns.md +495 -0
- package/architecture/01-standards/system-design-interview.md +664 -0
- package/architecture/02-playbooks/microservices-patterns-playbook.md +137 -0
- package/architecture/02-playbooks/migration-playbook.md +780 -0
- package/architecture/02-playbooks/system-design-playbook.md +779 -0
- package/architecture/03-checklists/architecture-decision-checklist.md +297 -0
- package/architecture/04-antipatterns/architecture-antipatterns.md +417 -0
- package/architecture/05-cases/case-netflix-microservices.md +413 -0
- package/architecture/06-glossary/architecture-glossary.md +164 -0
- package/architecture/adr-template-and-examples.md +38 -0
- package/architecture/api-gateway-deep-dive.md +1291 -0
- package/architecture/configuration-management.md +1162 -0
- package/architecture/distributed-transactions.md +1220 -0
- package/architecture/microservices-complete.md +735 -0
- package/architecture/resilience-and-disaster-patterns.md +37 -0
- package/architecture/service-governance.md +1198 -0
- package/architecture/system-architecture-deep-dive.md +37 -0
- package/backend/01-standards/analytics-and-growth.md +65 -0
- package/backend/01-standards/api-and-error-conventions.md +120 -0
- package/backend/01-standards/application-layering-and-packaging.md +160 -0
- package/backend/01-standards/auth-implementation.md +104 -0
- package/backend/01-standards/backend-framework-idioms.md +74 -0
- package/backend/01-standards/background-jobs-and-async.md +66 -0
- package/backend/01-standards/caching-strategies-complete.md +390 -0
- package/backend/01-standards/config-and-observability.md +77 -0
- package/backend/01-standards/data-modeling-and-persistence.md +94 -0
- package/backend/01-standards/django-complete.md +1765 -0
- package/backend/01-standards/email-and-notifications.md +64 -0
- package/backend/01-standards/fastapi-complete.md +925 -0
- package/backend/01-standards/file-upload-and-storage.md +66 -0
- package/backend/01-standards/graphql-api-complete.md +416 -0
- package/backend/01-standards/llm-application-standard.md +78 -0
- package/backend/01-standards/message-queue-patterns.md +379 -0
- package/backend/01-standards/microservices-and-distributed.md +78 -0
- package/backend/01-standards/nestjs-complete.md +2167 -0
- package/backend/01-standards/payment-integration.md +80 -0
- package/backend/01-standards/rate-limiting-complete.md +451 -0
- package/backend/01-standards/realtime-and-websocket.md +65 -0
- package/backend/01-standards/search-and-filtering.md +64 -0
- package/backend/01-standards/spring-boot-complete.md +445 -0
- package/backend/02-playbooks/api-design-playbook.md +718 -0
- package/backend/02-playbooks/email-send-playbook.md +130 -0
- package/backend/02-playbooks/file-upload-s3-playbook.md +153 -0
- package/backend/02-playbooks/typescript-enterprise-playbook.md +133 -0
- package/backend/02-playbooks/websocket-realtime-playbook.md +154 -0
- package/backend/03-checklists/api-launch-checklist.md +189 -0
- package/backend/04-antipatterns/backend-antipatterns.md +1051 -0
- package/blockchain/01-standards/blockchain-basics.md +557 -0
- package/blockchain/01-standards/smart-contract-development.md +1315 -0
- package/cicd/01-standards/deployment-and-delivery-standard.md +96 -0
- package/cicd/01-standards/github-actions-complete.md +473 -0
- package/cicd/01-standards/release-and-store-submission.md +75 -0
- package/cicd/02-playbooks/cicd-pipeline-playbook.md +144 -0
- package/cicd/02-playbooks/release-management-playbook.md +605 -0
- package/cicd/03-checklists/pipeline-security-checklist.md +168 -0
- package/cicd/04-antipatterns/cicd-antipatterns.md +589 -0
- package/cicd/05-cases/case-deployment-automation.md +221 -0
- package/cicd/05-cases/case-gitops-transformation.md +212 -0
- package/cicd/06-glossary/cicd-glossary.md +114 -0
- package/cicd/cicd-blueprint-deep-dive.md +38 -0
- package/cicd/release-readiness-gate.md +37 -0
- package/cloud-native/01-standards/container-security.md +741 -0
- package/cloud-native/01-standards/kubernetes-complete.md +812 -0
- package/cloud-native/02-playbooks/api-gateway-playbook.md +155 -0
- package/cloud-native/02-playbooks/gitops-with-argocd.md +760 -0
- package/cloud-native/02-playbooks/k8s-troubleshooting-playbook.md +1942 -0
- package/cloud-native/02-playbooks/message-queue-playbook.md +129 -0
- package/cloud-native/02-playbooks/multicloud-governance.md +726 -0
- package/cloud-native/02-playbooks/serverless-patterns.md +788 -0
- package/cloud-native/02-playbooks/service-mesh-playbook.md +612 -0
- package/cloud-native/02-playbooks/terraform-iac-playbook.md +143 -0
- package/cloud-native/03-checklists/container-security-checklist.md +431 -0
- package/cloud-native/03-checklists/k8s-production-readiness-checklist.md +460 -0
- package/cloud-native/04-antipatterns/container-antipatterns.md +660 -0
- package/cloud-native/04-antipatterns/k8s-antipatterns.md +743 -0
- package/cloud-native/05-cases/case-k8s-migration.md +478 -0
- package/cloud-native/05-cases/case-k8s-scaling.md +642 -0
- package/cloud-native/05-cases/case-k8s-security-incident.md +397 -0
- package/cloud-native/06-glossary/cloud-native-glossary.md +337 -0
- package/cross-platform/01-standards/cross-platform-frameworks.md +83 -0
- package/cross-platform/01-standards/platform-selection-and-architecture.md +77 -0
- package/data/01-standards/elasticsearch-complete.md +2098 -0
- package/data/01-standards/postgresql-complete.md +1613 -0
- package/data/01-standards/redis-complete.md +1527 -0
- package/data/02-playbooks/database-optimization-playbook.md +403 -0
- package/data/02-playbooks/elasticsearch-production-playbook.md +132 -0
- package/data/03-checklists/database-launch-checklist.md +187 -0
- package/data/04-antipatterns/database-antipatterns.md +873 -0
- package/data/05-cases/case-database-migration.md +310 -0
- package/data/06-glossary/database-glossary.md +440 -0
- package/data/data-governance-and-modeling-deep-dive.md +39 -0
- package/data-engineering/01-standards/airflow-complete.md +523 -0
- package/data-engineering/01-standards/kafka-complete.md +1521 -0
- package/data-engineering/02-playbooks/spark-etl-playbook.md +496 -0
- package/data-engineering/03-checklists/pipeline-launch-checklist.md +194 -0
- package/data-engineering/04-antipatterns/data-pipeline-antipatterns.md +684 -0
- package/data-engineering/05-cases/case-real-time-pipeline.md +355 -0
- package/data-engineering/06-glossary/data-engineering-glossary.md +429 -0
- package/database/01-standards/database-schema-standards.md +147 -0
- package/database/02-playbooks/postgresql-optimization-quick.md +52 -0
- package/database/02-playbooks/postgresql-performance-optimization.md +58 -0
- package/database/02-playbooks/postgresql-production-playbook.md +146 -0
- package/database/02-playbooks/redis-caching-playbook.md +117 -0
- package/database/03-checklists/database-review-checklist.md +50 -0
- package/database/04-antipatterns/database-antipatterns.md +112 -0
- package/design/01-standards/ui-design-system-complete.md +423 -0
- package/design/02-playbooks/design-handoff-playbook.md +254 -0
- package/design/02-playbooks/design-review-playbook.md +388 -0
- package/design/03-checklists/design-review-checklist.md +246 -0
- package/design/04-antipatterns/design-antipatterns.md +378 -0
- package/design/05-cases/case-design-system-adoption.md +328 -0
- package/design/06-glossary/design-glossary.md +329 -0
- package/design/ui-full-lifecycle-cross-platform-playbook.md +571 -0
- package/design/ux-system-deep-dive.md +38 -0
- package/design-systems/00-craft-rules.md +71 -0
- package/design-systems/aesthetic-families.md +43 -0
- package/design-systems/anti-ai-slop.md +162 -0
- package/design-systems/bold-geometric.md +120 -0
- package/design-systems/brutalist-bold.md +103 -0
- package/design-systems/editorial-clean.md +109 -0
- package/design-systems/glass-aurora.md +108 -0
- package/design-systems/modern-minimal.md +145 -0
- package/design-systems/premium-luxury.md +106 -0
- package/design-systems/product-type-design-map.md +48 -0
- package/design-systems/soft-warm.md +123 -0
- package/design-systems/tech-utility.md +113 -0
- package/desktop/01-standards/desktop-app-standard.md +72 -0
- package/desktop/01-standards/desktop-design.md +71 -0
- package/development/00-governance/document-template.md +41 -0
- package/development/01-standards/api-versioning-strategies.md +432 -0
- package/development/01-standards/authentication-patterns-complete.md +479 -0
- package/development/01-standards/css-architecture-complete.md +550 -0
- package/development/01-standards/database-migration-strategies.md +484 -0
- package/development/01-standards/elasticsearch-complete.md +347 -0
- package/development/01-standards/git-complete.md +371 -0
- package/development/01-standards/golang-complete.md +1565 -0
- package/development/01-standards/graphql-complete.md +298 -0
- package/development/01-standards/javascript-bundlers-complete.md +469 -0
- package/development/01-standards/javascript-typescript-complete.md +528 -0
- package/development/01-standards/jest-complete.md +275 -0
- package/development/01-standards/linux-complete.md +234 -0
- package/development/01-standards/logging-observability-complete.md +526 -0
- package/development/01-standards/microservices-communication.md +502 -0
- package/development/01-standards/mongodb-complete.md +406 -0
- package/development/01-standards/oauth2-complete.md +285 -0
- package/development/01-standards/performance-optimization-complete.md +289 -0
- package/development/01-standards/playwright-complete.md +247 -0
- package/development/01-standards/postgresql-complete.md +456 -0
- package/development/01-standards/pytest-complete.md +340 -0
- package/development/01-standards/python-async-programming.md +902 -0
- package/development/01-standards/python-complete.md +956 -0
- package/development/01-standards/python-decorators-complete.md +799 -0
- package/development/01-standards/python-design-patterns.md +2854 -0
- package/development/01-standards/python-packaging-distribution.md +420 -0
- package/development/01-standards/python-testing-strategies.md +607 -0
- package/development/01-standards/python-web-frameworks-comparison.md +471 -0
- package/development/01-standards/redis-complete.md +317 -0
- package/development/01-standards/rest-api-complete.md +316 -0
- package/development/01-standards/rust-complete.md +578 -0
- package/development/01-standards/typescript-advanced-types.md +1513 -0
- package/development/01-standards/web-security-complete.md +292 -0
- package/development/02-playbooks/api-design-playbook.md +810 -0
- package/development/02-playbooks/database-migration-playbook.md +580 -0
- package/development/02-playbooks/debugging-playbook.md +692 -0
- package/development/02-playbooks/feature-delivery-playbook.md +430 -0
- package/development/02-playbooks/incident-hotfix-playbook.md +387 -0
- package/development/02-playbooks/performance-optimization-playbook.md +531 -0
- package/development/02-playbooks/performance-tuning-playbook.md +652 -0
- package/development/02-playbooks/refactor-playbook.md +403 -0
- package/development/02-playbooks/release-playbook.md +469 -0
- package/development/03-checklists/architecture-review-checklist.md +168 -0
- package/development/03-checklists/data-migration-checklist.md +157 -0
- package/development/03-checklists/oncall-handover-checklist.md +173 -0
- package/development/03-checklists/pr-checklist.md +158 -0
- package/development/03-checklists/production-readiness-checklist.md +190 -0
- package/development/03-checklists/release-readiness-checklist.md +154 -0
- package/development/03-checklists/security-review-checklist.md +182 -0
- package/development/04-antipatterns/api-antipatterns.md +657 -0
- package/development/04-antipatterns/architecture-antipatterns.md +686 -0
- package/development/04-antipatterns/backend-antipatterns.md +648 -0
- package/development/04-antipatterns/cicd-antipatterns.md +540 -0
- package/development/04-antipatterns/code-smell-antipatterns.md +571 -0
- package/development/04-antipatterns/data-antipatterns.md +658 -0
- package/development/04-antipatterns/database-antipatterns.md +578 -0
- package/development/04-antipatterns/frontend-antipatterns.md +635 -0
- package/development/04-antipatterns/reliability-antipatterns.md +700 -0
- package/development/04-antipatterns/security-antipatterns.md +747 -0
- package/development/05-cases/case-api-version-migration.md +428 -0
- package/development/05-cases/case-authorization-hardening.md +383 -0
- package/development/05-cases/case-bluegreen-rollback.md +466 -0
- package/development/05-cases/case-cache-snowball-protection.md +485 -0
- package/development/05-cases/case-ci-cd-pipeline.md +544 -0
- package/development/05-cases/case-database-scaling.md +500 -0
- package/development/05-cases/case-db-hotspot-optimization.md +487 -0
- package/development/05-cases/case-incident-mttr-reduction.md +563 -0
- package/development/05-cases/case-microservice-migration.md +375 -0
- package/development/05-cases/case-performance-optimization.md +406 -0
- package/development/05-cases/case-security-incident-response.md +345 -0
- package/development/06-glossary/full-stack-glossary.md +166 -0
- package/development/09-maturity/quarterly-audit-template.md +35 -0
- package/development/11-ui-excellence/ui-aesthetic-system.md +41 -0
- package/development/11-ui-excellence/ui-engineering-excellence.md +435 -0
- package/development/12-scenarios/development-scenarios-guide.md +565 -0
- package/development/13-implementation-assets/implementation-toolkit.md +282 -0
- package/development/13-implementation-assets/knowledge-gates-execution.md +43 -0
- package/development/14-full-lifecycle/software-lifecycle-gates.md +511 -0
- package/development/15-lifecycle-templates/project-templates-collection.md +791 -0
- package/development/api-contract-and-versioning-guide.md +36 -0
- package/development/api-governance-complete.md +43 -0
- package/development/backend-engineering-complete.md +43 -0
- package/development/code-review-quality-complete.md +43 -0
- package/development/concurrency-reliability-complete.md +43 -0
- package/development/database-engineering-complete.md +43 -0
- package/development/engineering-effectiveness-complete.md +43 -0
- package/development/engineering-standards-deep-dive.md +38 -0
- package/development/frontend-engineering-complete.md +43 -0
- package/development/performance-capacity-complete.md +43 -0
- package/development/refactor-migration-complete.md +42 -0
- package/development/refactoring-and-techdebt-playbook.md +37 -0
- package/development/security-in-development-complete.md +43 -0
- package/devops/01-standards/cicd-pipeline-complete.md +262 -0
- package/devops/01-standards/docker-complete.md +1490 -0
- package/devops/01-standards/github-actions-complete.md +337 -0
- package/devops/01-standards/kubernetes-complete.md +638 -0
- package/devops/01-standards/terraform-complete.md +2117 -0
- package/devops/02-playbooks/docker-compose-playbook.md +233 -0
- package/devops/02-playbooks/docker-k8s-production-playbook.md +186 -0
- package/devops/02-playbooks/docker-production-playbook.md +952 -0
- package/edge-iot/01-standards/edge-iot-complete.md +473 -0
- package/experts/architect/api-design.md +178 -0
- package/experts/architect/methodology.md +124 -0
- package/experts/architect/security.md +75 -0
- package/experts/backend-lead/methodology.md +216 -0
- package/experts/devops/methodology.md +160 -0
- package/experts/frontend-lead/methodology.md +178 -0
- package/experts/product-manager/industry/ecommerce.md +43 -0
- package/experts/product-manager/industry/saas.md +40 -0
- package/experts/product-manager/methodology.md +97 -0
- package/experts/qa-lead/methodology.md +123 -0
- package/experts/qa-lead/test-strategy.md +128 -0
- package/experts/uiux-designer/methodology.md +125 -0
- package/frontend/01-standards/accessibility-complete.md +532 -0
- package/frontend/01-standards/accessibility-standard.md +74 -0
- package/frontend/01-standards/admin-dashboard-and-crud.md +72 -0
- package/frontend/01-standards/design-tokens-complete.md +444 -0
- package/frontend/01-standards/forms-and-validation.md +77 -0
- package/frontend/01-standards/frontend-architecture-and-layering.md +119 -0
- package/frontend/01-standards/i18n-and-localization.md +65 -0
- package/frontend/01-standards/nextjs-complete.md +451 -0
- package/frontend/01-standards/react-complete.md +713 -0
- package/frontend/01-standards/react-hooks-complete-guide.md +1100 -0
- package/frontend/01-standards/react-hooks-complete.md +1171 -0
- package/frontend/01-standards/seo-and-web-vitals.md +77 -0
- package/frontend/01-standards/state-management-complete.md +444 -0
- package/frontend/01-standards/vue-complete.md +499 -0
- package/frontend/01-standards/vue3-complete.md +2002 -0
- package/frontend/01-standards/web-framework-best-practices.md +64 -0
- package/frontend/01-standards/web-performance-complete.md +495 -0
- package/frontend/02-playbooks/accessibility-a11y-playbook.md +161 -0
- package/frontend/02-playbooks/frontend-performance-playbook.md +707 -0
- package/frontend/02-playbooks/i18n-internationalization-playbook.md +120 -0
- package/frontend/02-playbooks/performance-optimization-playbook.md +163 -0
- package/frontend/02-playbooks/react-nextjs-production-playbook.md +167 -0
- package/frontend/02-playbooks/react-state-management-playbook.md +173 -0
- package/frontend/03-checklists/component-quality-checklist.md +166 -0
- package/frontend/03-checklists/frontend-launch-checklist.md +299 -0
- package/frontend/04-antipatterns/frontend-antipatterns.md +886 -0
- package/frontend/05-cases/case-performance-optimization.md +274 -0
- package/harmony/01-standards/harmonyos-arkts-standard.md +75 -0
- package/harmony/01-standards/harmonyos-design.md +65 -0
- package/high-quality-engineering-playbook.md +54 -0
- package/incident/01-standards/incident-response-complete.md +303 -0
- package/incident/02-playbooks/chaos-engineering-playbook.md +883 -0
- package/incident/02-playbooks/postmortem-playbook.md +398 -0
- package/incident/03-checklists/incident-readiness-checklist.md +181 -0
- package/incident/04-antipatterns/incident-antipatterns.md +490 -0
- package/incident/05-cases/case-cascade-failure.md +176 -0
- package/incident/06-glossary/incident-glossary.md +114 -0
- package/incident/postmortem-and-response-deep-dive.md +39 -0
- package/industries/ecommerce/ecommerce-complete.md +631 -0
- package/industries/education/education-complete.md +555 -0
- package/industries/fintech/fintech-complete.md +501 -0
- package/industries/gaming/gaming-complete.md +587 -0
- package/industries/healthcare/healthcare-complete.md +452 -0
- package/low-code/01-standards/low-code-complete.md +944 -0
- package/miniprogram/01-standards/ai-common-mistakes.md +61 -0
- package/miniprogram/01-standards/miniprogram-custom-navbar-capsule.md +77 -0
- package/miniprogram/01-standards/miniprogram-design.md +61 -0
- package/miniprogram/01-standards/miniprogram-standard.md +81 -0
- package/mobile/01-standards/android-material-design.md +70 -0
- package/mobile/01-standards/flutter-complete.md +384 -0
- package/mobile/01-standards/ios-design-hig.md +78 -0
- package/mobile/01-standards/mobile-app-standard.md +85 -0
- package/mobile/01-standards/react-native-complete.md +352 -0
- package/mobile/02-playbooks/mobile-cross-platform-playbook.md +175 -0
- package/mobile/02-playbooks/mobile-performance.md +473 -0
- package/mobile/03-checklists/mobile-release-checklist.md +234 -0
- package/mobile/04-antipatterns/mobile-antipatterns.md +798 -0
- package/mobile/05-cases/case-app-performance.md +500 -0
- package/mobile/05-cases/case-app-startup-optimization.md +218 -0
- package/mobile/06-glossary/mobile-glossary.md +484 -0
- package/observability/01-standards/observability-standards.md +103 -0
- package/observability/02-playbooks/prometheus-grafana-playbook.md +135 -0
- package/observability/02-playbooks/structured-logging-playbook.md +73 -0
- package/observability/03-checklists/observability-checklist.md +54 -0
- package/observability/04-antipatterns/observability-antipatterns.md +106 -0
- package/operations/01-standards/prometheus-monitoring-complete.md +1578 -0
- package/operations/02-playbooks/capacity-planning-playbook.md +620 -0
- package/operations/03-checklists/production-launch-checklist.md +365 -0
- package/operations/04-antipatterns/operations-antipatterns.md +664 -0
- package/operations/05-cases/case-sre-practices.md +581 -0
- package/operations/06-glossary/operations-glossary.md +120 -0
- package/operations/aiops-anomaly-detection.md +758 -0
- package/operations/capacity-planning.md +1061 -0
- package/operations/chaos-engineering.md +659 -0
- package/operations/incident-command-system.md +38 -0
- package/operations/observability-complete.md +442 -0
- package/operations/slo-sli-playbook.md +517 -0
- package/operations/sre-operations-deep-dive.md +39 -0
- package/package.json +8 -0
- package/performance/01-standards/performance-and-scalability.md +80 -0
- package/performance/01-standards/performance-standards.md +156 -0
- package/performance/02-playbooks/query-optimization-playbook.md +103 -0
- package/performance/03-checklists/performance-checklist.md +56 -0
- package/performance/04-antipatterns/performance-antipatterns.md +146 -0
- package/product/01-standards/product-management-complete.md +285 -0
- package/product/02-playbooks/feature-launch-playbook.md +207 -0
- package/product/02-playbooks/user-research-playbook.md +532 -0
- package/product/03-checklists/feature-launch-checklist.md +275 -0
- package/product/04-antipatterns/product-antipatterns.md +355 -0
- package/product/05-cases/case-mvp-to-scale.md +384 -0
- package/product/06-glossary/product-glossary.md +462 -0
- package/product/feature-prioritization-framework.md +40 -0
- package/product/kpi-and-metric-tree.md +37 -0
- package/product/product-discovery-and-prd-deep-dive.md +41 -0
- package/quantum/01-standards/quantum-complete.md +1186 -0
- package/security/01-standards/api-security-complete.md +511 -0
- package/security/01-standards/container-runtime-security.md +574 -0
- package/security/01-standards/data-protection-gdpr.md +543 -0
- package/security/01-standards/owasp-top10-complete.md +1890 -0
- package/security/01-standards/secure-coding-baseline.md +90 -0
- package/security/01-standards/supply-chain-security.md +441 -0
- package/security/01-standards/web-security-checklist.md +108 -0
- package/security/01-standards/zero-trust-architecture.md +521 -0
- package/security/02-playbooks/auth-sso-playbook.md +166 -0
- package/security/02-playbooks/incident-response-security-playbook.md +588 -0
- package/security/02-playbooks/owasp-api-security-playbook.md +129 -0
- package/security/02-playbooks/payment-integration-playbook.md +119 -0
- package/security/02-playbooks/penetration-testing-playbook.md +517 -0
- package/security/03-checklists/security-audit-checklist.md +356 -0
- package/security/04-antipatterns/security-coding-antipatterns.md +580 -0
- package/security/05-cases/case-log4shell-incident.md +537 -0
- package/security/05-cases/case-major-breaches.md +468 -0
- package/security/06-glossary/security-glossary.md +212 -0
- package/security/compliance-automation.md +993 -0
- package/security/container-security.md +680 -0
- package/security/devsecops-complete.md +426 -0
- package/security/sast-dast-sca.md +775 -0
- package/security/secrets-management.md +594 -0
- package/security/security-architecture-deep-dive.md +37 -0
- package/security/threat-modeling-stride-playbook.md +40 -0
- package/seed-templates/auth-system.md +59 -0
- package/seed-templates/blog-content.md +94 -0
- package/seed-templates/dashboard.md +89 -0
- package/seed-templates/docs-site.md +73 -0
- package/seed-templates/e-commerce.md +50 -0
- package/seed-templates/saas-landing.md +92 -0
- package/seed-templates/settings-page.md +51 -0
- package/testing/01-standards/test-strategy-and-layering.md +83 -0
- package/testing/01-standards/testing-strategy-complete.md +422 -0
- package/testing/01-standards/unit-testing-best-practices.md +118 -0
- package/testing/02-playbooks/e2e-testing-playbook.md +988 -0
- package/testing/02-playbooks/testing-strategy-playbook.md +126 -0
- package/testing/03-checklists/test-strategy-checklist.md +208 -0
- package/testing/04-antipatterns/testing-antipatterns.md +718 -0
- package/testing/05-cases/case-testing-transformation.md +300 -0
- package/testing/06-glossary/testing-glossary.md +110 -0
- package/testing/risk-based-test-matrix.md +36 -0
- package/testing/testing-strategy-deep-dive.md +37 -0
|
@@ -0,0 +1,355 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: case-real-time-pipeline
|
|
3
|
+
title: 实时数据管道案例:Kafka + Flink 构建实时数据处理系统
|
|
4
|
+
domain: data-engineering
|
|
5
|
+
category: 05-cases
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [agent, case, checklist, data-engineering, pipeline, real, time, 业务背景]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# 实时数据管道案例:Kafka + Flink 构建实时数据处理系统
|
|
12
|
+
|
|
13
|
+
## 概述
|
|
14
|
+
|
|
15
|
+
本案例记录一个电商平台构建实时数据处理系统的完整过程。系统目标是将用户行为数据(浏览、点击、加购、下单)从产生到可查询的延迟从 T+1(次日批处理)缩短到 < 30 秒。日均处理事件 2 亿条,峰值 QPS 50,000。团队 6 人(2 数据工程师 + 2 后端 + 1 SRE + 1 数据分析师),建设周期 10 周。
|
|
16
|
+
|
|
17
|
+
技术栈:Kafka 3.5 + Flink 1.17 + PostgreSQL + Redis + ClickHouse
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## 业务背景
|
|
22
|
+
|
|
23
|
+
### 原有架构(批处理)
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
用户行为 → MySQL binlog → 每日凌晨 Spark 批处理 → Hive → 报表(T+1)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
痛点:
|
|
30
|
+
1. 运营团队需要实时看到活动效果,T+1 延迟不可接受
|
|
31
|
+
2. 推荐系统依赖用户最新行为,批处理数据太旧
|
|
32
|
+
3. 风控系统需要秒级识别异常行为
|
|
33
|
+
4. 凌晨批处理窗口已满负荷,无法扩展
|
|
34
|
+
|
|
35
|
+
### 目标架构(实时 + 批处理 Lambda)
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
用户行为 → Kafka → Flink 实时处理 → ClickHouse(实时查询)
|
|
39
|
+
→ Redis(实时推荐特征)
|
|
40
|
+
→ PostgreSQL(告警/风控)
|
|
41
|
+
同时 → S3 归档 → Spark 批处理(T+1 修正层)
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## 第一阶段:Kafka 集群搭建与数据接入(第 1-3 周)
|
|
47
|
+
|
|
48
|
+
### Kafka 集群规划
|
|
49
|
+
|
|
50
|
+
| 参数 | 配置 | 说明 |
|
|
51
|
+
|------|------|------|
|
|
52
|
+
| Broker 数量 | 5 | 3 个不够峰值,5 个留有余量 |
|
|
53
|
+
| 副本因子 | 3 | 任意 1 个 Broker 宕机不丢数据 |
|
|
54
|
+
| 分区数 | 30 | 按峰值 QPS / 单分区吞吐量计算 |
|
|
55
|
+
| 保留时间 | 7 天 | 满足回填和故障恢复需求 |
|
|
56
|
+
| 压缩 | LZ4 | 吞吐优先,压缩比适中 |
|
|
57
|
+
| 消息格式 | Avro + Schema Registry | 强 Schema 保证数据质量 |
|
|
58
|
+
|
|
59
|
+
### Topic 设计
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
user-events # 原始用户行为事件(浏览/点击/加购/下单)
|
|
63
|
+
user-events-enriched # 富化后事件(关联用户画像和商品信息)
|
|
64
|
+
user-events-dlq # 死信队列(处理失败的消息)
|
|
65
|
+
aggregated-metrics # 聚合后的实时指标
|
|
66
|
+
alert-events # 风控告警事件
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### 数据接入方案
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
1. 前端埋点 → API Gateway → 事件收集服务 → Kafka
|
|
73
|
+
- 使用批量发送(batch.size=16384, linger.ms=10)
|
|
74
|
+
- acks=1(权衡延迟和可靠性)
|
|
75
|
+
- 关键事件(下单/支付)acks=all
|
|
76
|
+
|
|
77
|
+
2. 事件格式(Avro Schema)
|
|
78
|
+
{
|
|
79
|
+
"event_id": "uuid",
|
|
80
|
+
"user_id": "long",
|
|
81
|
+
"event_type": "enum(view, click, add_cart, order, pay)",
|
|
82
|
+
"item_id": "long",
|
|
83
|
+
"timestamp": "long (epoch ms)",
|
|
84
|
+
"properties": "map<string, string>",
|
|
85
|
+
"session_id": "string",
|
|
86
|
+
"device": "string",
|
|
87
|
+
"ip": "string"
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
3. Schema Evolution 策略
|
|
91
|
+
- 使用 BACKWARD 兼容模式
|
|
92
|
+
- 新字段必须有默认值
|
|
93
|
+
- 不允许删除字段或修改类型
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### 数据验证
|
|
97
|
+
|
|
98
|
+
- 发送端:Schema 校验 + 必填字段检查
|
|
99
|
+
- 消费端:二次校验 + 异常数据进 DLQ
|
|
100
|
+
- 端到端:从前端发送到 Kafka 可消费 < 500ms
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## 第二阶段:Flink 实时处理引擎(第 4-7 周)
|
|
105
|
+
|
|
106
|
+
### Flink 集群配置
|
|
107
|
+
|
|
108
|
+
| 参数 | 配置 |
|
|
109
|
+
|------|------|
|
|
110
|
+
| JobManager | 2(HA 模式,ZooKeeper 选主) |
|
|
111
|
+
| TaskManager | 8(每个 4 CPU, 8GB 内存) |
|
|
112
|
+
| 并行度 | 30(与 Kafka 分区数一致) |
|
|
113
|
+
| Checkpoint 间隔 | 60 秒 |
|
|
114
|
+
| Checkpoint 存储 | S3 |
|
|
115
|
+
| State Backend | RocksDB(大状态支持) |
|
|
116
|
+
| 重启策略 | 固定延迟重启,最多 3 次,间隔 30 秒 |
|
|
117
|
+
|
|
118
|
+
### 处理流程
|
|
119
|
+
|
|
120
|
+
```
|
|
121
|
+
Kafka Source (user-events)
|
|
122
|
+
│
|
|
123
|
+
├→ [1] 数据清洗
|
|
124
|
+
│ - Schema 校验
|
|
125
|
+
│ - 时间戳合法性(不超过未来 5 分钟,不早于 7 天前)
|
|
126
|
+
│ - 必填字段非空
|
|
127
|
+
│ - 异常数据 → DLQ
|
|
128
|
+
│
|
|
129
|
+
├→ [2] 数据富化(Async I/O)
|
|
130
|
+
│ - 关联 Redis 中的用户画像(年龄段、等级、地区)
|
|
131
|
+
│ - 关联 Redis 中的商品信息(类目、价格、品牌)
|
|
132
|
+
│ - 使用 AsyncDataStream,并发 100,超时 5s
|
|
133
|
+
│ - 缓存命中率 > 95%,未命中回查数据库
|
|
134
|
+
│
|
|
135
|
+
├→ [3] 实时聚合(窗口计算)
|
|
136
|
+
│ - 滚动窗口(1 分钟):PV/UV/GMV 按分钟聚合
|
|
137
|
+
│ - 滑动窗口(5 分钟滑动 1 分钟):实时趋势
|
|
138
|
+
│ - 会话窗口(30 分钟间隔):用户会话分析
|
|
139
|
+
│ - Watermark:允许 30 秒延迟,超时数据进侧输出
|
|
140
|
+
│
|
|
141
|
+
├→ [4] 实时风控
|
|
142
|
+
│ - 同一用户 1 分钟内下单 > 5 次 → 告警
|
|
143
|
+
│ - 同一 IP 1 分钟内请求 > 1000 次 → 告警
|
|
144
|
+
│ - 异常金额检测(偏离用户历史均值 3 个标准差)
|
|
145
|
+
│ - 使用 Flink CEP(Complex Event Processing)模式匹配
|
|
146
|
+
│
|
|
147
|
+
└→ [5] 多 Sink 输出
|
|
148
|
+
- ClickHouse:富化后的明细数据 + 聚合数据
|
|
149
|
+
- Redis:用户实时特征(最近浏览、加购列表)
|
|
150
|
+
- PostgreSQL:风控告警记录
|
|
151
|
+
- Kafka (aggregated-metrics):下游消费
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### 关键代码模式
|
|
155
|
+
|
|
156
|
+
```
|
|
157
|
+
// Watermark 策略
|
|
158
|
+
WatermarkStrategy
|
|
159
|
+
.forBoundedOutOfOrderness(Duration.ofSeconds(30))
|
|
160
|
+
.withTimestampAssigner((event, timestamp) -> event.getTimestamp())
|
|
161
|
+
.withIdleness(Duration.ofMinutes(1)) // 处理空闲分区
|
|
162
|
+
|
|
163
|
+
// Async I/O 富化
|
|
164
|
+
AsyncDataStream.unorderedWait(
|
|
165
|
+
cleanedStream,
|
|
166
|
+
new UserProfileAsyncFunction(), // Redis 查询
|
|
167
|
+
5, TimeUnit.SECONDS, // 超时
|
|
168
|
+
100 // 并发容量
|
|
169
|
+
)
|
|
170
|
+
|
|
171
|
+
// 窗口聚合
|
|
172
|
+
enrichedStream
|
|
173
|
+
.keyBy(event -> event.getItemId())
|
|
174
|
+
.window(TumblingEventTimeWindows.of(Time.minutes(1)))
|
|
175
|
+
.allowedLateness(Time.seconds(30))
|
|
176
|
+
.sideOutputLateData(lateOutputTag)
|
|
177
|
+
.aggregate(new MetricsAggregateFunction(), new MetricsWindowFunction())
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### 状态管理
|
|
181
|
+
|
|
182
|
+
- 风控状态(用户行为计数器):TTL 设为 1 小时,自动清理
|
|
183
|
+
- 窗口状态:随窗口关闭自动清理
|
|
184
|
+
- 异步查询缓存:使用 MapState,TTL 5 分钟
|
|
185
|
+
- State 大小监控:每个 TaskManager 的 RocksDB 使用量 < 4GB
|
|
186
|
+
|
|
187
|
+
---
|
|
188
|
+
|
|
189
|
+
## 第三阶段:存储层与查询层(第 7-8 周)
|
|
190
|
+
|
|
191
|
+
### ClickHouse 配置
|
|
192
|
+
|
|
193
|
+
```sql
|
|
194
|
+
-- 明细表(按天分区,按用户 ID 排序)
|
|
195
|
+
CREATE TABLE user_events_detail (
|
|
196
|
+
event_id UUID,
|
|
197
|
+
user_id UInt64,
|
|
198
|
+
event_type Enum8('view'=1, 'click'=2, 'add_cart'=3, 'order'=4, 'pay'=5),
|
|
199
|
+
item_id UInt64,
|
|
200
|
+
item_category String,
|
|
201
|
+
event_time DateTime,
|
|
202
|
+
properties Map(String, String)
|
|
203
|
+
) ENGINE = MergeTree()
|
|
204
|
+
PARTITION BY toYYYYMMDD(event_time)
|
|
205
|
+
ORDER BY (user_id, event_time)
|
|
206
|
+
TTL event_time + INTERVAL 90 DAY;
|
|
207
|
+
|
|
208
|
+
-- 聚合表(预聚合,加速查询)
|
|
209
|
+
CREATE TABLE metrics_1min (
|
|
210
|
+
time_bucket DateTime,
|
|
211
|
+
item_id UInt64,
|
|
212
|
+
pv UInt64,
|
|
213
|
+
uv AggregateFunction(uniq, UInt64),
|
|
214
|
+
gmv Decimal(18,2)
|
|
215
|
+
) ENGINE = AggregatingMergeTree()
|
|
216
|
+
PARTITION BY toYYYYMMDD(time_bucket)
|
|
217
|
+
ORDER BY (time_bucket, item_id);
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Redis 实时特征
|
|
221
|
+
|
|
222
|
+
```
|
|
223
|
+
Key 设计:
|
|
224
|
+
user:{uid}:recent_views → List (最近 50 个浏览商品 ID)
|
|
225
|
+
user:{uid}:cart → Set (当前购物车商品 ID)
|
|
226
|
+
user:{uid}:session_events → Counter (会话内事件计数)
|
|
227
|
+
item:{item_id}:realtime_pv → Counter (实时 PV,1 分钟过期)
|
|
228
|
+
|
|
229
|
+
TTL 策略:
|
|
230
|
+
recent_views: 24 小时
|
|
231
|
+
cart: 7 天
|
|
232
|
+
session_events: 30 分钟
|
|
233
|
+
realtime_pv: 1 分钟
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
---
|
|
237
|
+
|
|
238
|
+
## 第四阶段:监控与运维(第 9 周)
|
|
239
|
+
|
|
240
|
+
### 监控指标
|
|
241
|
+
|
|
242
|
+
```
|
|
243
|
+
管道级别:
|
|
244
|
+
- 端到端延迟(从事件产生到可查询):P50 < 10s, P99 < 30s
|
|
245
|
+
- 处理吞吐量:records/sec(正常 2500,峰值 50000)
|
|
246
|
+
- 错误率:< 0.01%
|
|
247
|
+
- Kafka Consumer Lag:< 10000 条
|
|
248
|
+
|
|
249
|
+
Flink 级别:
|
|
250
|
+
- Checkpoint 耗时:< 30 秒
|
|
251
|
+
- Checkpoint 失败率:< 1%
|
|
252
|
+
- Backpressure 比例:< 10%
|
|
253
|
+
- GC 暂停时间:< 500ms
|
|
254
|
+
|
|
255
|
+
存储级别:
|
|
256
|
+
- ClickHouse 写入延迟:< 1 秒
|
|
257
|
+
- Redis 命令延迟:P99 < 5ms
|
|
258
|
+
- ClickHouse 磁盘使用趋势
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### 告警规则
|
|
262
|
+
|
|
263
|
+
| 告警 | 条件 | 级别 |
|
|
264
|
+
|------|------|------|
|
|
265
|
+
| 管道停止 | Flink Job 状态非 RUNNING | P1 |
|
|
266
|
+
| 数据积压 | Consumer Lag > 100000 | P1 |
|
|
267
|
+
| 端到端延迟 | P99 > 60s | P2 |
|
|
268
|
+
| Checkpoint 失败 | 连续 3 次失败 | P2 |
|
|
269
|
+
| 错误率异常 | > 0.1% | P2 |
|
|
270
|
+
| 资源告警 | CPU > 80% 持续 10 分钟 | P3 |
|
|
271
|
+
|
|
272
|
+
### Runbook 摘要
|
|
273
|
+
|
|
274
|
+
| 故障场景 | 处理步骤 |
|
|
275
|
+
|---------|---------|
|
|
276
|
+
| Flink Job 崩溃 | 1. 检查异常日志 2. 从最近 Checkpoint 恢复 3. 若无法恢复则从 Kafka 回溯 |
|
|
277
|
+
| Kafka Broker 宕机 | 1. 确认副本可用 2. 等待自动 Leader 选举 3. 检查数据完整性 |
|
|
278
|
+
| ClickHouse 写入失败 | 1. 检查磁盘空间 2. 检查 MergeTree 合并状态 3. 数据暂存 Kafka 等恢复后补写 |
|
|
279
|
+
| Consumer Lag 持续增长 | 1. 检查是否有 Backpressure 2. 增加并行度 3. 检查下游 Sink 是否阻塞 |
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
|
|
283
|
+
## 第五阶段:上线与优化(第 10 周)
|
|
284
|
+
|
|
285
|
+
### 灰度上线步骤
|
|
286
|
+
|
|
287
|
+
```
|
|
288
|
+
Day 1: 部署管道,仅处理 10% 流量(Kafka 按 partition 分流)
|
|
289
|
+
- 验证数据正确性:与批处理结果对比
|
|
290
|
+
- 验证延迟:端到端 < 30s
|
|
291
|
+
|
|
292
|
+
Day 3: 扩展到 50% 流量
|
|
293
|
+
- 观察资源使用
|
|
294
|
+
- 验证 ClickHouse 查询性能
|
|
295
|
+
|
|
296
|
+
Day 5: 100% 流量
|
|
297
|
+
- 全量运行
|
|
298
|
+
- 关闭旧的批处理报表链路(保留批处理修正层)
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### 上线后性能优化
|
|
302
|
+
|
|
303
|
+
| 问题 | 根因 | 优化 | 效果 |
|
|
304
|
+
|------|------|------|------|
|
|
305
|
+
| 热点分区积压 | 头部用户事件集中在少数 partition | 使用 user_id 哈希分区替代轮询 | Lag 从 50000 降至 2000 |
|
|
306
|
+
| Checkpoint 超时 | State 过大(8GB) | 启用增量 Checkpoint + TTL 清理过期状态 | 从 45s 降至 12s |
|
|
307
|
+
| ClickHouse 写入慢 | 小批量频繁写入 | Flink Sink 攒批 5 秒或 10000 条写入一次 | 写入延迟从 3s 降至 0.5s |
|
|
308
|
+
| GC 暂停 | 对象创建过多 | 使用对象池 + 减少 String 拼接 | GC 暂停从 800ms 降至 200ms |
|
|
309
|
+
|
|
310
|
+
---
|
|
311
|
+
|
|
312
|
+
## 最终成果
|
|
313
|
+
|
|
314
|
+
| 指标 | 旧架构(批处理) | 新架构(实时) |
|
|
315
|
+
|------|-----------------|---------------|
|
|
316
|
+
| 数据延迟 | T+1(12-18 小时) | < 15 秒(P99 < 30s) |
|
|
317
|
+
| 日处理量 | 2 亿条 | 2 亿条(持平) |
|
|
318
|
+
| 峰值吞吐 | N/A(批量) | 50,000 events/sec |
|
|
319
|
+
| 风控响应 | 次日发现 | 秒级告警 |
|
|
320
|
+
| 推荐新鲜度 | 昨日行为 | 最近 30 秒行为 |
|
|
321
|
+
| 运营数据 | 次日报表 | 实时仪表板 |
|
|
322
|
+
|
|
323
|
+
### 业务影响
|
|
324
|
+
|
|
325
|
+
- 推荐点击率提升 18%(实时特征 vs 昨日特征)
|
|
326
|
+
- 风控拦截率提升 35%(秒级 vs 次日)
|
|
327
|
+
- 运营活动调整响应时间从 "次日" 缩短到 "分钟级"
|
|
328
|
+
- 大促期间实时 GMV 看板支撑运营决策
|
|
329
|
+
|
|
330
|
+
---
|
|
331
|
+
|
|
332
|
+
## 经验总结
|
|
333
|
+
|
|
334
|
+
1. **先跑通再优化** - 第一版不追求极致性能,先确保数据正确
|
|
335
|
+
2. **Schema 管理是基础** - Avro + Schema Registry 避免了大量数据质量问题
|
|
336
|
+
3. **State 管理是核心难点** - 必须设置 TTL,否则 State 无限增长导致 OOM
|
|
337
|
+
4. **批处理不要废弃** - Lambda 架构的批处理层作为实时层的修正层仍有价值
|
|
338
|
+
5. **监控先于功能** - 没有监控的实时管道等于定时炸弹
|
|
339
|
+
|
|
340
|
+
---
|
|
341
|
+
|
|
342
|
+
## Agent Checklist
|
|
343
|
+
|
|
344
|
+
以下为 AI Agent 在构建实时数据管道时必须遵循的硬约束:
|
|
345
|
+
|
|
346
|
+
- [ ] 确认 Kafka Topic 的副本因子 ≥ 3
|
|
347
|
+
- [ ] 确认消息格式使用 Schema(Avro/Protobuf),不使用纯 JSON
|
|
348
|
+
- [ ] 确认 Flink Checkpoint 已启用且存储在持久化存储
|
|
349
|
+
- [ ] 确认 State TTL 已设置,防止无限增长
|
|
350
|
+
- [ ] 确认 Watermark 策略已定义,包含允许延迟时间
|
|
351
|
+
- [ ] 确认 DLQ(死信队列)已配置
|
|
352
|
+
- [ ] 确认端到端延迟监控和告警已配置
|
|
353
|
+
- [ ] 确认 Consumer Lag 监控和告警已配置
|
|
354
|
+
- [ ] 确认灰度上线方案已定义(不允许一次性全量切换)
|
|
355
|
+
- [ ] 生成管道上线报告包含:架构图、性能基线、监控配置、Runbook
|