New 'Log Scenario Rules' CMDT

[jongpie]

This PR closes #235 (and further extends the 'scenario' functionality added in #218) - Added new CMDT object LoggerScenarioRule__mdt to provide a way to configure scenario-specific behavior. Each rule controls 2 aspects of a scenario:

1. The user's logging level for a particular scenario - This overrides the logging level configured via LoggerSettings__c.
2. The retention date for a particular scenario - This overrides the retention date configured via LoggerSettings__c.

Example rule

This example rule overrides the user's logging level for the scenario 'some scenario' - after Logger.setScenario(String) is called, the user will (temporarily) have their logging level set to FINE for the remainder of the Apex transaction. It also sets the retention date for the logs to 90 days.

With the above rule configured, this script will save only the second log entry (the one logged after calling Logger.setScenario(String), and the log will have a retention date of "TODAY + 90 days"

Logger.getUserSettings().LoggingLevel__c = LoggingLevel.ERROR.name();
Logger.info('this will not be saved since it does not meet the user logging level of ERROR');
Logger.setScenario('some scenario');
Logger.info('this will be saved since it meets the scenario logging level, and setScenario() has been called');
Logger.saveLog();

Other Changes

The previous release, v4.6.11, included a new dynamic dashboard. I did not take into consideration that most orgs have a limit of 10 dynamic dashboards, which has caused upgrade issues for several people already. To help with this issue, the dashboard has been removed from the core unlocked package, and is now going to be provided as an optional plugin package - any org that wants to use the dashboard (and has not hit their org limit) can install the dashboard plugin on top of Nebula Logger v4.6.12.

[codecov]

Codecov Report

Merging #237 (cdd8ef0) into main (ab7dc20) will decrease coverage by 0.05%.
The diff coverage is 91.66%.

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

@@            Coverage Diff             @@
##             main     #237      +/-   ##
==========================================
- Coverage   95.51%   95.45%   -0.06%     
==========================================
  Files          28       28              
  Lines        2829     2858      +29     
  Branches       42       42              
==========================================
+ Hits         2702     2728      +26     
- Misses        126      129       +3     
  Partials        1        1              

Flag	Coverage Δ
Apex	96.01% <91.66%> (-0.08%)	⬇️
LWC	90.07% <ø> (ø)

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

Impacted Files	Coverage Δ
...ebula-logger/main/logger-engine/classes/Logger.cls	95.18% <90.90%> (-0.08%)	⬇️
...-logger/main/log-management/classes/LogHandler.cls	97.64% <92.00%> (-2.36%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ab7dc20...69e9b68. Read the comment docs.

[jverelst]

@jongpie I've tested this version in one of our sandboxes and indeed it works as expected, very nice, thanks!! I do have some feedback on the PR though because the package failed to install on the first try.

The package now contains a dashboard, which looks amazing, but since we already were on the limit of 10 dynamic dashboards, I had un-dynamic one of our existing dashboards. That's fine on a sandbox for testing, but will give us problems when deploying this package with the new dynamic dashboard to production.

ERROR:  Encountered errors installing the package!,Installation errors: 
1) (LogDashboards/LoggerAdmin) You reached the limit for dashboards run as the logged-in user., Details: LogDashboards/LoggerAdmin: You reached the limit for dashboards run as the logged-in user.
2) (LoggerConsoleHomePage) Component [desktopDashboards:embeddedDashboard] attribute [dashboardName]: Invalid dashboard Unique Name LoggerAdmin - no dashboards found., Details: LoggerConsoleHomePage: Component [desktopDashboards:embeddedDashboard] attribute [dashboardName]: Invalid dashboard Unique Name LoggerAdmin - no dashboards found.

I don't know if the dashboard could be an optional somehow?

[jongpie]

@jverelst that is some very helpful feedback, thanks for sharing! I had completely forgotten about the limit on dynamic dashboards - to avoid that issue, I'll remove the dashboards & reports from the main unlocked package as part of this PR, and I'll instead put the dashboards/reports into an optional add-on package. That way, anyone that wants to use the dashboard can easily install it in their org, but it will be completely optional.

I am also working on some additional features for the new 'Logger Retention Rules' custom metadata type - once I've made a bit more progress, I'll share another beta package link in case you'd like to test the additional changes before I finish this PR.

Thanks again for all of your feedback!