Configure EDR Parameters

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 file 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 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 combinaton.

    • 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 value 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 (smf-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 SMF 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.