External Connection Properties

External Configuration Properties describes the properties for configuring SBA Gateway external connections for Kafka.

Table 1. External Configuration Properties
Property	Description
gateway.external.kafka.enabled	When set to `true`, external Kafka connections are enabled. The default value is `false`.
gateway.external.kafka.kafkaClientType	Specifies the client type. The default value is `LOGGER` (the only supported option).
gateway.external.kafka.config()	Specifies Apache Kafka producer configuration settings.
gateway.external.kafka.writeQueueMaxSize	The size the pending queue is allowed to reach before Kafka is bypassed. When this is set to 0 the limit is disabled.
gateway.external.kafka.logger.enabled	When set to `true`, failed records from the CHF are logged. The default value is `false`.
gateway.external.kafka.logger.shutdownLoggingGraceSeconds	The amount of time, in seconds, to wait for any pending records to be written to disk at /var/events/records/mtx-sba-cdr.log, by default. If that path has been changed by, either providing a substitute log4j2.xml file or by updating either of the `CDR_MTX_LOG_DIR` or `CDR_MTX_LOG_FILENAME` environment variables, then the new path must be specified in gateway.external.kafka.logger.loggerFile. The default value is 5.
gateway.external.kafka.logger.loggerName	Specifies the default logger name as defined in `log4j2.xml`.
gateway.external.kafka.metrics.enabled	Set to `true` to export Kafka metrics. The default value is `true`.

The following gateway.yaml excerpt shows the common configuration default values (where defaults exist) for these properties:

  # Kafka settings
  external:
 
    kafka:
      # determines whether records are sent to Kafka
      enabled: false
      # use the logger kafka producer, only current option
      kafkaClientType: LOGGER
      # Apache Kafka producer config settings
      config: {}
      # default pending queue size before bypassing Kafka
      # when '0' then disabled
      writeQueueMaxSize: 0
      logger:
        enabled: false   # failed records from CHF are NOT logged
        # default write-to-disk grace period
        shutdownLoggingGraceSeconds: 5
        # default logger name as defined in log4j2.xml
        loggerName: networkcdr
      metrics:
        enabled: true
      uriPatterns:
        - "/nchf-convergedcharging/v2/chargingdata/([^/]+)/update"
        - "/nchf-convergedcharging/v2/chargingdata/([^/]+)/release"