Added logging support for instances of RestRequest and RestResponse

[jongpie]

Core Unlocked Package Changes

Added logging support for instances of RestRequest and RestResponse

• Resolved Ability to Log against RestRequest/RestResponse #514 by introducing new features & fields to support logging instances of System.RestRequest and System.RestResponse that are used for Apex REST services:

  • Added 2 new global instance methods in LogEntryBuilder to provide a way to log instances of System.RestRequest and System.RestResponse:

    1. global LogEntryEventBuilder setRestRequestDetails(System.RestRequest request);
    2. global LogEntryEventBuilder setRestResponseDetails(System.RestResponse response);

  • Added 2 new LoggerParameter__mdt records to control logging of request & response headers when using the new builder methods. These LoggerParameter__mdt records are equivalent to the record StoreHttpResponseHeaderValues (introduced in Nebula Logger v4.11.8) for System.HttpResponse logging:

    1. StoreRestRequestHeaderValues - this metadata records controls if the request's header values are stored in new fields LogEntryEvent__e.RestRequestHeaders__c and LogEntryEvent__e.RestrequestHeaders__c. By default, it's enabled.
    2. StoreRestResponseHeaderValues - this metadata records controls if the response's header values are stored in new fields LogEntryEvent__e.RestResponseHeaders__c and LogEntryEvent__e.RestResponseHeaders__c. By default, it's enabled.

  • Added 9 new fields for System.RestRequest data on LogEntryEvent__e platform event

    1. LogEntryEvent__e.RestRequestBodyMasked__c
    2. LogEntryEvent__e.RestRequestBody__c
    3. LogEntryEvent__e.RestRequestHeaderKeys__c
    4. LogEntryEvent__e.RestRequestHeaders__c
    5. LogEntryEvent__e.RestRequestMethod__c
    6. LogEntryEvent__e.RestRequestParameters__c
    7. LogEntryEvent__e.RestRequestRemoteAddress__c
    8. LogEntryEvent__e.RestRequestResourcePath__c
    9. LogEntryEvent__e.RestRequestUri__c

  • Added 5 new fields for System.RestResponse data on LogEntryEvent__e platform event

    1. LogEntryEvent__e.RestResponseBodyMasked__c
    2. LogEntryEvent__e.RestResponseBody__c
    3. LogEntryEvent__e.RestResponseHeaderKeys__c
    4. LogEntryEvent__e.RestResponseHeaders__c
    5. LogEntryEvent__e.RestResponseStatusCode__c

  • Added 12 new fields for System.RestResponse data on LogEntry__c custom object

    1. LogEntry__c.HasRestRequestBody__c
    2. LogEntry__c.HasRestRequestHeaderKeys__c
    3. LogEntry__c.HasRestRequestHeaders__c
    4. LogEntry__c.RestRequestBody__c
    5. LogEntry__c.RestRequestBodyMasked__c
    6. LogEntry__c.RestRequestHeaderKeys__c
    7. LogEntry__c.RestRequestHeaders__c
    8. LogEntry__c.RestRequestMethod__c
    9. LogEntry__c.RestRequestParameters__c
    10. LogEntry__c.RestRequestRemoteAddress__c
    11. LogEntry__c.RestRequestResourcePath__c
    12. LogEntry__c.RestRequestUri__c

  • Added 8 new fields for System.RestResponse data on LogEntry__c custom object

    1. LogEntry__c.HasRestResponseBody__c
    2. LogEntry__c.HasRestResponseHeaderKeys__c
    3. LogEntry__c.HasRestResponseHeaders__c
    4. LogEntry__c.RestResponseBodyMasked__c
    5. LogEntry__c.RestResponseBody__c
    6. LogEntry__c.RestResponseHeaderKeys__c
    7. LogEntry__c.RestResponseHeaders__c
    8. LogEntry__c.RestResponseStatusCode__c

  • Updated permission sets LoggerAdmin, LoggerLogViewer, and LoggerEndUser to add access to the new custom fields on LogEntry__c

  • Add 2 new sections on LogEntryRecordPage flexipage

    • Apex REST Service Request section shows the corresponding fields for RestRequest data (when populated)
    • Apex REST Service Response section shows the corresponding fields for RestResponse data (when populated)

  • Renamed 2 existing sections on LogEntryRecordPage flexipage to help avoid confusion with the 2 new sections Apex Rest Service Request and Apex REST Service Response

    • HTTP Request is now HTTP Callout Request
    • HTTP Response is now HTTP Callout Response

Reduced the Max Length of Several Existing Long Textarea Fields

• LogEntryEvent__e.ExceptionMessage__c: 131,072 limit reduced to 5,000
• LogEntryEvent__e.ExceptionStackTrace__c: 131,072 limit reduced to 5,000
• LogEntryEvent__e.StackTrace__c: 131,072 limit reduced to 5,000
• LogEntryEvent__e.Topics__c (deprecated/no longer used): 131,072 limit reduced to 256
• LogEntry__c.ExceptionMessage__c: 131,072 limit reduced to 5,000
• LogEntry__c.ExceptionStackTrace__c: 131,072 limit reduced to 5,000
• LogEntry__c.FlowDescription__c: 131,072 limit reduced to 5,000
• LogEntry__c.StackTrace__c: 131,072 limit reduced to 5,000

[codecov]

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (21e02ac) 95.66% compared to head (c4ae423) 95.73%.

❗ Current head c4ae423 differs from pull request most recent head a72d926. Consider uploading reports for the commit a72d926 to get more accurate results

Files	Patch %	Lines
...ain/logger-engine/classes/LogEntryEventBuilder.cls	98.18%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #613      +/-   ##
==========================================
+ Coverage   95.66%   95.73%   +0.06%     
==========================================
  Files          48       48              
  Lines        5215     5297      +82     
==========================================
+ Hits         4989     5071      +82     
  Misses        226      226              

Flag	Coverage Δ
Apex	95.73% <98.79%> (+0.06%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.