Skip to main content
#P1648

GET /v2/batch-accounting/report/comprehensive

Comprehensive Redis Accounting Report

این اندپوینت یک گزارش جامع (Comprehensive Report) از وضعیت کامل سیستم Redis Accounting و Batch Accounting تولید می‌کند. این گزارش شامل آمار عمومی Redis، تحلیل اسناد ماهانه، بخش‌های پرمصرف (Top Subsidiaries)، جمع‌بندی بالانس‌ها، گزارش حافظه، و متریک‌های عملکردی است. این گزارش معمولاً برای تیم‌های DevOps، Backend Engineering و تیم‌های Performance Monitoring استفاده می‌شود.

Request Overview

URL: /v2/batch-accounting/report/comprehensive
Method: GET
Middleware: authWithJwt, shamsiDate

Query Parameters

این اندپوینت هیچ پارامتر ورودی ندارد.

Field Type Required Description
No parameters

Response (Success)

Field Type Description
success boolean وضعیت نهایی عملیات
data.general_stats object خروجی کامل getRedisStats شامل تعداد اسناد، ایندکس‌ها، بالانس‌ها و حافظه Redis
data.documents_by_month array آمار تجمیع‌شده اسناد بر اساس ماه (مثلاً {1403-01: 1280})
data.top_subsidiaries array بیشترین سطح فعالیت (Subsidiary Codes با بیشترین سند/بیشترین تراکنش)
data.balance_summary object خلاصه مانده‌ها در تمام لایه‌ها (account, general, group, subsidiary)
data.memory_info object گزارش جزئی مصرف حافظه Redis (مقایسه internal metrics)
data.performance_metrics object متریک‌های وظرفیت و throughput پردازش Batch
message string پیام خروجی 
{
  "success": true,
  "data": {
    "general_stats": {
      "total_documents": 12850,
      "total_indexes": 5120,
      "total_balances": 740,
      "memory_usage": "148 MB"
    },
    "documents_by_month": {
      "1403-01": 1320,
      "1403-02": 1408,
      "1403-03": 960
    },
    "top_subsidiaries": [
      { "code": 21012, "documents": 482 },
      { "code": 21007, "documents": 441 }
    ],
    "balance_summary": {
      "total_debit": 483900000,
      "total_credit": 480200000,
      "difference": 3700000
    },
    "memory_info": {
      "used_memory": 183783424,
      "peak_memory": 221184000,
      "fragmentation_ratio": 1.23
    },
    "performance_metrics": {
      "avg_documents_per_batch": 280,
      "avg_processing_time_ms": 14.2,
      "throughput_docs_per_second": 905.4
    }
  },
  "message": "گزارش کامل تهیه شد"
}

Response (Server Error)

{
  "success": false,
  "message": "خطا در تهیه گزارش: Internal server error..."
}

Internal Architecture

Component Description
redisAccountingService->getRedisStats() آمار کلیدی Redis شامل کلیدها، مانده‌ها و حافظه
getDocumentsByMonth() خروجی تحلیلی تعداد اسناد بر اساس سال/ماه شمسی
getTopSubsidiaries() تشخیص پُرتراکنش‌ترین کدهای معین
getBalanceSummary() تجمیع مانده‌های کل سیستم
getDetailedMemoryInfo() گزارش چرایی مصرف حافظه: fragmentation, allocator, peaks
getPerformanceMetrics() متریک‌های سرعت، حجم Batch، زمان‌بندی‌ها و throughput

Process Flow

Validate JWT Token
↓
Fetch Redis General Stats
↓
Analyze Documents by Month
↓
Calculate Top Subsidiaries
↓
Summarize Balances
↓
Read Memory Detailed Info
↓
Collect Performance Metrics
↓
Return Final Comprehensive Report
Back to top