The EDR transaction file dumps the transaction information at the end of the transaction. By default, the file generation is disabled.

The following table provides the information that is stored in the file.

NOTES:

• Each field is separated by comma (,).

• Fields session_uks, session_nuks, execution_stages are a list. These fields are separated by pipe (|). For example, session_uks is denoted as uk1|uk2|uk3.

CSV Format Examples:

V1,15,16,2023/11/02 15:36:21.156,9,imsi-123456789012345,
101,N1RegistrationRequest,supi:123456789012345,
guti:12345601038301000001|guti:12345601038301000002|
stmsi:038301000002|ngapId:4|guti:12345601038301000003|
stmsi:038301000003,imei:123456789012345|gpsi:msisdn-8899776655|
ranId:4194304123456,success,success,UERegistration,
N1RegistrationRequest,Active,init_done|finished,
guti:12345601038301000002|supi:123456789012345|
ranId:4194304123456|ngapId:4|guti:12345601038301000003|stmsi:038301000003

Note	EDR generation occurs after you configure the subscriber ID. Then, you can enable EDR reporting for a specific subscriber or for all the subscribers. If you have enabled the EDR reporting for all the subscribers, then the AMF ignores the individual subscriber ID configuration.

Note

To optimize the performance, it is recommended to enable EDR reporting only for a subset of subscribers with specific procedure ID. You can enable or disable the EDRs dynamically during runtime. The existing EDR records remain the same and the runtime changes get reflected only in the newly generated EDR records.

To enable or disable the EDR generation for subscribers, use the following sample configuration:

config 
    edr reporting { enable [ all subscribers | file [ transaction | transaction-collision ] ] | disable file [ transaction | transaction-collision ] } 
    edr all subscribers  
    end  

NOTES:

• edr reporting { enable [ all subscribers | file [ transaction | transaction-collision ] ] | disable file [ transaction | transaction-collision ] } —Specify this keyword to configure the EDR reporting on AMF. Use the edr reporting enable command to enable the EDR reporting functionality. Use the edr reporting disablefile command to disable the EDR reporting functionality for a specific file. By default, the EDR reporting is disabled.

  For transaction-collision details, see EDR Transaction Collision.

• Use the edr reporting enable all subscribers command or edr all subscribers to enable the EDR for all the subscribers.

  Note

  To enable EDR reporting for a subscriber, use the edr subscribers subscriber_id command. subscriber_id must be an alphanumeric string. The default value is empty. Ensure to specify the exact subscriber key in this command. The AMF supports only IMSI (SUPI)-based EDR reporting. Configure a minimum of one subscriber upon enabling the EDR reporting. You can configure a maximum of 10 subscribers for generation of transaction collision EDRs.

Use the following sample configuration to generate the EDR events at transaction level.

config 
   edr file { transaction | transaction-collision } 
      procedure-id procedure_value  
         event-id event_value  
            field-id field_value 
            end 

• edr file { transaction | transaction-collision } : Specify to generate EDR files with transaction or transaction-collision level details for subscriber sessions. For transaction-collision , see EDR Transaction Collision

• procedure-id procedure_value : Specify the procedure ID or procedure name for which the event reporting must be enabled.

• event-id event_value : Specify the event ID or event name for which the event reporting must be enabled.

• field-id field_value : Specify the field ID or field name for which the event reporting must be enabled.

• All procedure IDs, event IDs, and field IDs registered by application, are enabled by default.

• If one or more procedures are enabled, then all the other procedures will be disabled and will not be populated in the transaction EDR. Similarly, if one or more events are enabled under a procedure, all other events under that procedure will be disabled and will not be populated in the transaction EDR.

• If a procedure-id is disabled, no event start, add field, or event-end will be honored for the procedure-id.

• If an event-id is disabled within a procedure id, then event-start, event-end, or add field will not be honored for the procedure-id and event-id combination.

• If a field-id is disabled for an event-id, then add-field will not be honored, and a blank entry will be present instead of value in CSV entry.

Example Configuration:

edr file transaction
  procedure-id 24 32
  procedure-id 25
    event-id 5 7 8   
    event-id 5
      field-id 10 12 14 

In the preceding example, event-id 5 7 8 means enable the event-id 5, 7, and 8 for procedure-id 25. The field-id 10 12 14 means enable the field-id 10, 12, and 14 for procedure-id 25 and event-id 5.

To define the EDR parameters, use the following sample configuration:

config 
   edr file transaction  
      flush interval file_flush_interval 
      limit [ size file_size | count file_count| storage edr_storage_size ] 
      procedure procedure_value event event_value field field_value 
      rate rate_value  
      reporting [ disable | enable ] 
      threshold [ cpu cpu_threshold | session session_thresold  ] 
      end 

NOTES:

• flush interval file_flush_interval —Specify the time interval, in milliseconds, to flush the EDR files. The default value is 1000 ms.

• limit [ size file_size | count file_count| storage edr_storage_size] —Specify the file-related limits.

  • Use the limit size file_size command to specify the maximum size of an EDR file, after which the EDR file is compressed and new CSV file is created. The default file size is 100 MB.

    The file_size must be an integer in the range of 1 to 2048.

    Note

    The system periodically monitors the size of an EDR file once per second or after the configured flush interval, whichever value is higher. After the EDR file reaches its maximum size, it's compressed and new CSV file is created. However, in some scenarios, the data is being continuously written to the EDR file just before the system performs a periodic check based on the previously mentioned threshold limits. This results in an EDR file that might slightly exceed the configured maximum file size.

  • Use the limit count file_count command to specify the maximum number of EDR files to be preserved. The default file count is 10.

    The file_count must be an integer in the range of 2 to 128.

    When the configured file count is reached, the file is moved to persistent volume and then deleted.

  • Use the limit storage edr_storage_size command to specify the EDR storage size of persistent volume in GiB.

    The edr_storage_size must be an integer in the range of 1 to 24. The default storage size is 4 GiB.

  • Use the limit storage edr_storage_size command to specify the EDR storage size of persistent volume in GiB.

    The edr_storage_size must be an integer in the range of 0 to 64. Set the value to 0 to disable persistent volume in edr-monitor pod. The default storage size is 24 GiB.

    Important

    The storage limit can be changed only in “system mode shutdown” mode. Hence, disabling of persistent volume can be done only when the system is in shutdown state.

• procedure procedure_value event event_value field field_value —Specify the transaction-level procedure ID configuration information. The procedure_value must be a procedure ID or a procedure name. The event_value must be an event ID or an event name along with a field value.

  Note

  By default, all the procedure IDs, event IDs, and field IDs, which are registered during the application-start, are enabled. If one or more procedures are enabled, then all other procedures are disabled and are not populated in the transaction EDR. If one or more events are enabled in a procedure, then all other events in that procedure are disabled and are not populated in the transaction EDR. If one or more fields are enabled in an event, then all other fields in that event are disabled and are not populated in the transaction EDR. For the disabled procedure IDs, no event-start, add field, or event-end are honored. For the disabled event IDs in a procedure ID, no event-start, event-end, or add field are honored for the procedure ID and event ID combination. For a disabled field ID within an event ID, no add-field is honored, and a blank entry is available instead of value in CSV entry.

• rate rate_value —Specify the allowed rate per second to generate EDR records. The default rate is 4096.

  rate_value must be an integer in the range of 32 to 65535.

  When the EDR generation rate limit is reached, transaction EDRs are dropped and a metric is added to track EDR generated, dropped, drop reason, and so on. Note that the rate limiting is performed per service (amf-service) pod instance.

• reporting [ disable | enable ] —Specify the file for which you have to enable or disable reporting.

  Important

  The edr-monitor pods are spawned only when the transaction edr is enabled.

• threshold [ cpu cpu_threshold | session session_thresold ] —Specify the threshold to limit the EDR generation.

  • Use the threshold cpu cpu_threshold command to configure the CPU threshold in percentage. If the threshold is breached for a AMF service pod instance, then the application stops generating EDRs. The cpu_threshold must be an integer in the range of 1 to 100, with default value of 80%.

  • Use the threshold session session_thresold command to configure session threshold per GR instance. If the threshold is breached for a GR instance, then the application stops generating EDRs. The session_thresold must be an integer in the range of 0 to 1,000,000, with default value of 100,000.

    Note	If the rack is running with active-active mode, the session threshold is applied individually for both the GR instances.

Use the following show commands to display the currently registered procedures, events, and fields for the application along with their respective IDs.

show edr transaction-procedure procedure_id event event_id 

show edr event event_id 

You can provide all the procedures and events. Otherwise, you can provide a particular procedure name and event name or procedure-id and event-id.

Note	The show command output is based on the mapping registered by the application.

The following is an example of the show command output.

Procedure-id 20, Procedure-Name: xyz
    Event-id 1, Event-Name: abc
         1 – Field1-Name
         2 – Field2-Name
         …
         …
         …
     Event-id 2, Event-Name: efgh
          1 – Field1-Name
          2 – Field2-Name
          …
          …
          …
    …
    …
    …
Procedure-id 21, Procedure-Name: bbbb
     Event-id 1, Event-Name: cccc
          1 – Field1-Name
          2 – Field2-Name
          …
          …
          …
     Event-id 2, Event-Name: dddd
          1 – Field1-Name
          2 – Field2-Name
          …
          …
          …

This output helps the operator to know current CSV format of a particular procedure-id and event-id pair.

The AMF maintains the following bulk statistics as part of this feature.

• edr_error_total

  Labels:

  • error_code – The EDR writing error code

This metric is pegged whenever an error occurs during EDR writing. This metric displays "EdrQueueFull" as the error_code when the writing queue is full and the EDR is dropped.

Following metric is used to monitor the EDR count and status.

• edr_total

  Labels:

  • name – Name of the transaction EDR.

  • status – Status of the EDR transaction if it is successful or has any errors.

  • status_code – The following status codes are supported:

    • EdrReportingDisabled

    • EdrTxnReportingDisabled

    • EdrSessThreshold

    • EdrCpuThreshold

    • EdrRateLimitExceeded

    • EdrFileWriteFailed

    • EdrInvalidEdrId

    • EdrQueueFull

    • EdrIgnored_NoEventRecorded