How accurateproject/accurate works
Project type and purpose
• Full-stack, Go-based real-time rating engine with:
– Event ingestion (Freeswitch, Kamailio, Diameter, SMG, etc.)
– Core rating/charging engine
– REST API & CLI console
– Configurable data stores (Mongo, MySQL, Postgres)
– Load balancing, caching, scheduling, and packaging
Top-level components (map to your file tree)
• Session Manager(s) (folder sessionmanager): protocol adapters for FreeSWITCH, OpenSIPS/Kamailio, Diameter, SMG
• Engine (folder engine): core rating logic (accounts, LCR, call cost, stats, triggers, derived charging) with internal pub/sub
• API Server (folder api/v1 + utils/server.go): HTTP/JSON endpoints exposing accounts, CDRs, triggers, statistics
• CLI Console (folder console + cmd/cc-console): operator commands calling RPC/HTTP on the API Server
• Agents (folder agents): Diameter agent, DMT agent, HA pool connectors
• Load Balancer (folder balancer2go): incoming request distribution for high availability
• Cache (folder cache2go): in-memory TTL caching layer for tariff and lookup data
• Scheduler (folder scheduler): timed triggers and job queue
• Configuration Loader (folder config + data/conf): JSON/YAML configurations and model definitions
• Persistence:
– CDR store (Mongo/MySQL/Postgres via engine/storage_*)
– Metadata store (accounts, rating plans, triggers)
– History logger (folder history)
• Packaging & Deployment (data/docker, packages/*, Vagrant, scripts)
Interactions and data flows
• External telecom elements → Session Manager
– e.g. FreeSWITCH JSON CDR over event socket
– Kamailio via TCP events
– Diameter traffic
• Session Manager → Engine
– Transforms events into internal CDR representations
– Publishes to Engine’s pub/sub (engine/pubsub.go)
• Engine → Storage
– Writes rated CDRs to CDR DB
– Reads tariff plans, accounts, LCR rules from metadata store (cache layer)
– Emits statistics to stats queue & metrics subsystem
• API Server → Engine/Storage
– CRUD on accounts, triggers, tariff plans
– Query CDRs and stats
• CLI Console → API Server
– Ad‐hoc administrative commands (e.g. add account, reload config)
• Balancer sits in front of API Server & Engine (if sharded)
• Scheduler periodically enqueues triggers → Engine
Architectural patterns & design principles
• Modularity: each concern in its own Go package
• Pub/Sub: decouples ingestion from processing
• Adapter pattern: sessionmanager for each protocol
• Cache aside: cache2go for static lookup data
• Separation of concerns: API, engine, console, agents are separate binaries (cmd/)
• Config‐as‐code: JSON models under data/conf loaded at startup
Essential elements checklist
– Clear labels on every component (use folder/binary names)
– External systems (telecom switches, DB servers, operator console)