From 702a72eb1a8c3a68f834f1cdd25671bf3bc9736f Mon Sep 17 00:00:00 2001 From: DanB Date: Mon, 9 Mar 2020 13:21:05 +0100 Subject: [PATCH] [Docs] CDRs config options --- config/config_defaults.go | 2 +- docs/cdrs.rst | 40 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+), 1 deletion(-) diff --git a/config/config_defaults.go b/config/config_defaults.go index b8749f0c1..a7fa35f88 100755 --- a/config/config_defaults.go +++ b/config/config_defaults.go @@ -262,7 +262,7 @@ const CGRATES_CFG_JSON = ` "store_cdrs": true, // store cdrs in StorDB "session_cost_retries": 5, // number of queries to session_costs before recalculating CDR "chargers_conns": [], // connection to ChargerS for CDR forking, empty to disable billing for CDRs: <""|*internal|x.y.z.y:1234> - "rals_conns": [], // connections to RALs for cost calculation: <""|*internal|x.y.z.y:1234> + "rals_conns": [], // connections to RALs for cost calculation: <""|*internal|x.y.z.y:1234> "attributes_conns": [], // connection to AttributeS for altering *raw CDRs, empty to disable attributes functionality: <""|*internal|x.y.z.y:1234> "thresholds_conns": [], // connection to ThresholdS for CDR reporting, empty to disable thresholds functionality: <""|*internal|x.y.z.y:1234> "stats_conns": [], // connections to StatS for CDR reporting, empty to disable stats functionality: <""|*internal|x.y.z.y:1234> diff --git a/docs/cdrs.rst b/docs/cdrs.rst index dad73392f..e524d9801 100644 --- a/docs/cdrs.rst +++ b/docs/cdrs.rst @@ -11,6 +11,46 @@ Due to multiple interfaces exposed, the **CDRs** is designed to function as cent * \*files* like *.csv*, *.fwv*, *.xml*, *.json*. * \*database events* like *sql*, *kafka*, *rabbitmq*. +Parameters +---------- + + +CDRs +^^^^ + +**CDRs** is configured within **cdrs** section from :ref:`JSON configuration ` via the following parameters: + +enabled + Will enable starting of the service. Possible values: . + +extra_fields + Select extra fields from the request, other than the primary ones used by CGRateS (see storage schemas for listing those). Used in particular applications where the received fields are not selectable at the source(ie. FreeSWITCH JSON). + +store_cdrs + Controls storing of the received CDR within the *StorDB*. Possible values: . + +session_cost_retries + In case of decoupling the events charging from CDRs, the charges done by :ref:`SessionS` will be stored in *sessions_costs* *StorDB* table. When receiving the CDR, these costs will be retrieved and attached to the CDR. To avoid concurrency between events and CDRs, it is possible to configure a multiple number of retries from *StorDB* table. + +chargers_conns + Connections towards :ref:`ChargerS` component to query charges for CDR events. Empty to disable the functionality. + +rals_conns + Connections towards :ref:`RALs` component to query costs for CDR events. Empty to disable the functionality. + +attributes_conns + Connections towards :ref:`AttributeS` component to alter information within CDR events. Empty to disable the functionality. + +thresholds_conns + Connections towards :ref:`ThresholdS` component to monitor and react to information within CDR events. Empty to disable the functionality. + +stats_conns + Connections towards :ref:`StatS` component to compute stat metrics for CDR events. Empty to disable the functionality. + +online_cdr_exports + List of :ref:`CDRe` profiles which will be processed for each CDR event. Empty to disable online CDR exports. + + APIs logic ----------