Files
cgrates/docs/cgr-engine.rst
ionutboangiu 63129feb4c prevent memprof file overwrites for small intervals
Previously, the timestamp was accurate only down to seconds. For smaller intervals,
this would truncate the previous file(s). Now, for small intervals, the number of
microseconds is appended to the file name.

Added the possibility to disable timestamps in the memory profile file names and use
increments of 1 instead.

Updated the memory profiling integration tests.
2024-08-02 09:35:36 +02:00

89 lines
2.1 KiB
ReStructuredText

.. _cgr-engine:
cgr-engine
==========
Groups most of functionality from services and components.
Customisable through the use of *json* :ref:`JSON configuration <configuration>` or command line arguments (higher prio).
Able to read the configuration from either a local directory of *.json* files with an unlimited number of subfolders (ordered alphabetically) or a list of http paths (separated by ";").
::
$ cgr-engine -help
Usage of cgr-engine:
-config_path string
Configuration directory path (default "/etc/cgrates/")
-cpuprof_dir string
Directory for CPU profiles
-http_pprof
Enable HTTP pprof profiling
-log_level int
Log level (0=emergency to 7=debug) (default -1)
-logger string
Logger type <*syslog|*stdout>
-memprof_dir string
Directory for memory profiles
-memprof_interval duration
Interval between memory profile saves (default 15s)
-memprof_maxfiles int
Number of memory profiles to keep (most recent) (default 1)
-memprof_timestamp
Add timestamp to memory profile files
-node_id string
Node ID of the engine
-pid string
Path to write the PID file
-preload string
Loader IDs used to load data before engine starts
-print_config
Print configuration object in JSON format
-scheduled_shutdown duration
Shutdown the engine after the specified duration
-set_versions
Overwrite database versions (equivalent to cgr-migrator -exec=*set_versions)
-singlecpu
Run on a single CPU core
-version
Print application version and exit
.. hint:: $ cgr-engine -config_path=/etc/cgrates
.. figure:: images/CGRateSInternalArchitecture.png
:alt: CGRateS Internal Architecture
:align: Center
:scale: 75 %
Internal Architecture of **cgr-engine**
The components from the diagram can be found documented in the links bellow:
.. toctree::
:maxdepth: 1
agents
sessions
rals
cdrs
ees
attributes
chargers
resources
routes
stats
thresholds
filters
dispatchers
schedulers
apiers
loaders
caches
datadb
stordb