6 Data Export Feature

Data Export Service provides the capability to export xDRs in CSV format and/or associated messages in PCAP format, which can be represented by a list of transactions, calls, or sessions. The generated export records can provide deep insights and visibility into the customer network and can be useful in features such as:

  • Network troubleshooting
  • Revenue assurance
  • Advanced analytics & observability

Network troubleshooting is one of the key features of the monitoring solution, and the correlation capability will help Data Director to provide applications and utilities to perform troubleshooting of failing network scenarios, trace network scenarios across multiple NFs, and generate KPIs to provide network utilization and load. This feature is an enabler for network visibility and observability through the trace of records.

6.1 Prerequisites

This section lists the prerequisites for data export configuration.

  1. Create SFTP test server
  2. Create SFTP credential
  3. Create stored procedure and events (managed internally by the Export Service)

Note:

For steps to delete stored procedures, see "Extended xDR Storage" section in the Oracle Communications Cloud Native Configuration Console User Guide.

6.2 Configuration Parameters

The following table provides the details of the configuration parameters for data export:

Table 6-1 Configuration Parameters

Parameter Details
configurationName

Data Type: String

P: M

Cardinality: 1

Description: The name of the export configuration. It should be a unique name across all export configurations.

correlationFeedName

Data Type: String

P: M

Cardinality: 1

Description: The name of CORRELATED or CORRELATED_FILTERED ACL feed configuration.

Note: The UI needs to fetch a list of available feed types (CORRELATED, CORRELATED_FILTERED) from the configuration service and provide an option to the user to select the configuration name from the list of available Kafka feed names (CORRELATED, CORRELATED_FILTERED). Manual entry for the configuration name should also be allowed. In case feeds are deleted, manual entry for the configuration name should be allowed.

userName

Data Type: String

P: M

Cardinality: 1

Description: The username provided by the Dashboard GUI configuring the export configuration.

exportType

Data Type: Enum

P: M

Cardinality: 1

Description: This parameter defines the type of data export to be transferred to the external file system.

Options:
  • CSV
  • PCAP

Default: CSV

CSV: Only xDR records will be converted to CSV format and transferred to the configured file location.

PCAP: Only xDR records' messages will be converted to PCAP format and transferred to the configured file location.

To be supported in a future release:

CSV_XDR_MESSAGE: The xDR records along with messages (if messages are present for xDR records) will be converted to CSV format and transferred to the configured file location.

CSV_PCAP: The xDR records will be converted to CSV format and the messages will be converted to PCAP format and transferred to the file location.

Note: When "includeMessageWithxDR==None" in correlation feed configuration, only xDR records will be stored in xDR DB, so PCAP export will not work.

startTime

Data Type: String

P: M

Cardinality: 1

Description: It defines the time from which xDR records fetch will be started from the DB for data export. It should be in UTC format. The start time should be either a past time or the current time.

endTime

Data Type: String

P: O

Cardinality: 1

Description: It defines the time when data export needs to be stopped. It should be in UTC format. When provided, it should be greater than 'startTime+Interval'. When end time is not provided, the data will be exported continuously to external file storage.

interval

Data Type: Int

P: M

Cardinality: 1

Description: Periodic data export interval. It would be in minutes.

Range: [1-15]

Default: 5

exportStorageInfo

Data Type: ExportStorageInfoDto

P: M

Cardinality: 1

Description: Information about the external file storage server where data is to be exported by DD.

exportFilterInfo

Data Type: List<ExportFilterInfoDto>

P: O

Cardinality: 1

Description: The filter criteria to be applied on xDR records before data export to file storage.

Current release: Only one ExportFilterInfo value (single row) will be present in the list. A list of ExportFilterInfo will be supported in future releases based on need or use case.

advanceExportInfo

Data Type: AdvanceExportInformationDto

P: C

Cardinality: 1

Description: Information about CSV or PCAP data export format and it will be applied while converting JSON data into CSV or into PCAP format for data export.

It is mandatory for format type PCAP.

6.3 Data Export Format

The Data Export feature provides conversion of JSON data into two formats:

CSV Export

The CSV Export feature supports exporting xDR records and their messages from JSON format to CSV format.

JSON xDR:
{
    "version": "2.0.0",
    "beginTime": "2023-10-04T05:39:24.228Z",
    "endTime": "2023-10-04T05:39:27.728Z",
    "configurationName": "feed1",
    "xdrStatus": "COMPLETE",
    "totalPduCount": 4,
    "totalLength": 7030,
    "transactionTime": 3500,
    "userAgent": "Go-http-client/2.0",
    "path": "/nudm-uecm/v1/234150999999999/registrations/amf-3gpp-access",
    "pei": "990000862471854",
    "methodType": "PUT",
    "statusCode": "503",
    "consumerVia": "2.0 SEPP-sepp1.inter.oracle.com",
    "producerVia": "2.0 SEPP-sepp2.inter.oracle.com",
    "feedSourceNfFqdn": "SEPP",
    "feedSourceNfId": "9faf1bbc-6e4a-4454-a507-aef01a101a06",
    "consumerId": "b159694e-8138-4826-bde2-ed6d82571b26",
    "producerId": "adb514c8-b9fa-450a-bda2-4bd73140b974",
    "producerFqdn": "udmsonu.5gc.mnc555.mcc444.3gppnetwork.org:5815",
    "contentType": "application/json"
}
CSV xDR:

version,beginTime,endTime,configurationName,xdrStatus,totalPduCount,totalLength,transactionTime,userAgent,path,pei,methodType,statusCode,consumerVia,producerVia,feedSourceNfFqdn,feedSourceNfId,consumerId,producerId,producerFqdn,contentType
2.0.0,2023-10-04T05:39:24.228Z,2023-10-04T05:39:27.728Z,feed1,COMPLETE,4,7030,3500,Go-http-client/2.0,/nudm-uecm/v1/234150999999999/registrations/amf-3gpp-access,990000862471854,PUT,503,2.0 SEPP-sepp1.inter.oracle.com,2.0 SEPP-sepp2.inter.oracle.com,SEPP,9faf1bbc-6e4a-4454-a507-aef01a101a06,b159694e-8138-4826-bde2-ed6d82571b26,adb514c8-b9fa-450a-bda2-4bd73140b974,udmsonu.5gc.mnc555.mcc444.3gppnetwork.org:5815,application/json

PCAP Export

The PCAP export feature is specifically designed for exporting messages of xDR records in JSON format to PCAP format.