Repository files navigation

The most robust observability solution for Salesforce experts. Built 100% natively on the platform, and designed to work seamlessly with Apex, Lightning Components, Flow, OmniStudio, and integrations.

sf package install --wait 20 --security-type AdminsOnly --package 04tKe0000011Mi9IAE

sf package install --wait 30 --security-type AdminsOnly --package 04t5Y0000015pGtQAI

1. A unified logging tool that supports easily adding log entries across the Salesforce platform, using:

   • Apex: classes, triggers, and anonymous Apex scripts
   • Lightning Components: lightning web components (LWCs) & aura components
   • Flow & Process Builder: any Flow type that supports invocable actions
   • OmniStudio: omniscripts and omni integration procedures

2. Built with an event-driven pub/sub messaging architecture, usingLogEntryEvent__eplatform events. For more details on leveraging platform events, seethe Platform Events Developer Guide site

3. Actionable observability data about your Salesforce org, available directly in your Salesforce org via the 5 included custom objects

   • Log__c
   • LogEntry__c
   • LogEntryTag__c
   • LoggerTag__c
   • LoggerScenario__c

4. Customizable logging settings for different users & profiles, using the includedLoggerSettings__c custom hierarchy settings object

5. Easily scales in highly complex Salesforce orgs with large data volumes, using global feature flags inLoggerParameter__mdt

6. Automatic data masking of sensitive data, using rules configured in theLogEntryDataMaskRule__mdt custom metadata type object

7. View relatedLogEntry__c records on any Lightning record page in App Builder by adding the 'Related Log Entries' component (relatedLogEntries LWC)

8. Dynamically assign tags toLog__c andLogEntry__c records for tagging/labeling your logs

9. Extendable with a built-in plugin framework: easily build or install plugins that enhance Nebula Logger, using Apex or Flow (not currently available in the managed package)

10. ISVs & package developers have several options for leveraging Nebula Logger in your own packages

    • Optional Dependency: dynamically leverage Nebula Logger in your own packages - when it's available in a subscriber's org - usingApex'sCallable interface and Nebula Logger's included implementationCallableLogger (requiresv4.14.10 of Nebula Logger or newer)
    • Hard Dependency: add either Nebula Logger's unlocked (no namespace) package or its managed package (Nebula namespace) as a dependency for your package to ensure customers always have a version of Nebula Logger installed
    • No Dependency: Bundle Nebula Logger's metadata into your own project - all of Nebula Logger's metadata is fully open source & freely available. This approach provides with full control of what's included in your own app/project.

Learn more about the design and history of the project onJoys Of Apex blog post

Nebula Logger is built natively on Salesforce, using Apex, lightning components and various types of objects. There are no required external dependencies. To learn more about the architecture, check out thearchitecture overview in the wiki.

Nebula Logger is available as both an unlocked package and a managed package. The metadata is the same in both packages, but there are some differences in the available functionality & features. All examples inREADME are for the unlocked package (no namespace) - simply add theNebula namespace to the examples if you are using the managed package.

After installing Nebula Logger in your org, there are a few additional configuration changes needed...

• Assign permission set(s) to users
  • See the wiki pageAssigning Permission Sets for more details on each of the included permission sets
• Customize the default settings inLoggerSettings__c
  • You can customize settings at the org, profile and user levels

For Apex developers, theLogger class has several methods that can be used to add entries with different logging levels. Each logging level's method has several overloads to support multiple parameters.

// This will generate a debug statement within developer consoleSystem.debug('Debug statement using native Apex');// This will create a new `Log__c` record with multiple related `LogEntry__c` recordsLogger.error('Add log entry using Nebula Logger with logging level == ERROR');Logger.warn('Add log entry using Nebula Logger with logging level == WARN');Logger.info('Add log entry using Nebula Logger with logging level == INFO');Logger.debug('Add log entry using Nebula Logger with logging level == DEBUG');Logger.fine('Add log entry using Nebula Logger with logging level == FINE');Logger.finer('Add log entry using Nebula Logger with logging level == FINER');Logger.finest('Add log entry using Nebula Logger with logging level == FINEST');Logger.saveLog();

This results in 1Log__c record with several relatedLogEntry__c records.

For lightning component developers, thelogger LWC provides very similar functionality that is offered in Apex. Simply incorporate thelogger LWC into your component, and call the desired logging methods within your code.

// For LWC, import logger's getLogger() function into your componentimport{getLogger}from'c/logger';exportdefaultclassLoggerDemoextendsLightningElement{logger=getLogger();connectedCallback(){this.logger.info('Hello, world');this.logger.saveLog();}}

// For aura, retrieve logger from your component's markupconstlogger=component.find('logger');logger.error('Hello, world!').addTag('some important tag');logger.warn('Hello, world!');logger.info('Hello, world!');logger.debug('Hello, world!');logger.fine('Hello, world!');logger.finer('Hello, world!');logger.finest('Hello, world!');logger.saveLog();

Within Flow & Process Builder, you can select 1 of the several Logging actions

In this simple example, a Flow is configured after-insert and after-update to log a Case record (using the action 'Add Log Entry for an SObject Record')

This results in aLog__c record with relatedLogEntry__c records.

For OmniStudio builders, the included Apex classCallableLogger provides access to Nebula Logger's core features, directly in omniscripts and omni integration procedures. Simply use theCallableLogger class as a remote action within OmniStudio, and provide any inputs needed for the logging action. For more details (including what actions are available, and their required inputs), seethe section on theCallableLogger Apex class. For more details on logging in OmniStudio,see the OmniStudio wiki page

Within Apex, there are several different methods that you can use that provide greater control over the logging system.

Apex developers can use additionalLogger methods to dynamically control how logs are saved during the current transaction.

• Logger.suspendSaving() – causesLogger to ignore any calls tosaveLog() in the current transaction untilresumeSaving() is called. Useful for reducing DML statements used byLogger
• Logger.resumeSaving() – re-enables saving aftersuspendSaving() is used
• Logger.flushBuffer() – discards any unsaved log entries
• Logger.setSaveMethod(SaveMethod saveMethod) - sets the default save method used when callingsaveLog(). Any subsequent calls tosaveLog() in the current transaction will use the specified save method
• Logger.saveLog(SaveMethod saveMethod) - saves any entries in Logger's buffer, using the specified save method for only this call. All subsequent calls tosaveLog() will use the default save method.
• EnumLogger.SaveMethod - this enum can be used for bothLogger.setSaveMethod(saveMethod) andLogger.saveLog(saveMethod)
  • Logger.SaveMethod.EVENT_BUS - The default save method, this uses theEventBus class to publishLogEntryEvent__e records. The default save method can also be controlled declaratively by updating the fieldLoggerSettings__c.DefaultSaveMethod__c
  • Logger.SaveMethod.QUEUEABLE - This save method will triggerLogger to save any pending records asynchronously using a queueable job. This is useful when you need to defer some CPU usage and other limits consumed by Logger.
  • Logger.SaveMethod.REST - This save method will use the current user’s session ID to make a synchronous callout to the org’s REST API. This is useful when you have other callouts being made and you need to avoid mixed DML operations.
  • Logger.SaveMethod.SYNCHRONOUS_DML - This save method will skip publishing theLogEntryEvent__e platform events, and instead immediately createsLog__c andLogEntry__c records. This is useful when you are logging from within the context of another platform event and/or you do not anticipate any exceptions to occur in the current transaction.Note: when using this save method, any exceptions will prevent your log entries from being saved - Salesforce will rollback any DML statements, including your log entries! Use this save method cautiously.

In Salesforce, asynchronous jobs like batchable and queuable run in separate transactions - each with their own unique transaction ID. To relate these jobs back to the original log, Apex developers can use the method Logger.setParentLogTransactionId(String).Logger uses this value to relate childLog__c records, using the fieldLog__c.ParentLog__c.

This example batchable class shows how you can leverage this feature to relate all of your batch job’s logs together.

ℹ️ If you deploy this example class to your org,you can run it usingDatabase.executeBatch(new BatchableLoggerExample());

public with sharingclassBatchableLoggerExampleimplementsDatabase.Batchable<SObject>, Database.Stateful {privateStringoriginalTransactionId;public Database.QueryLocatorstart(Database.BatchableContextbatchableContext) {// Each batchable method runs in a separate transaction,// so store the first transaction ID to later relate the other transactionsthis.originalTransactionId=Logger.getTransactionId();Logger.info('Starting BatchableLoggerExample');Logger.saveLog();// Just as an example, query all accountsreturnDatabase.getQueryLocator([SELECTId,Name,RecordTypeIdFROMAccount]);  }publicvoidexecute(Database.BatchableContextbatchableContext,List<Account>scope) {// One-time call (per transaction) to set the parent logLogger.setParentLogTransactionId(this.originalTransactionId);for (Accountaccount:scope) {// Add your batch job's logic here// Then log the resultLogger.info('Processed an account record',account);    }Logger.saveLog();  }publicvoidfinish(Database.BatchableContextbatchableContext) {// The finish method runs in yet-another transaction, so set the parent log againLogger.setParentLogTransactionId(this.originalTransactionId);Logger.info('Finishing running BatchableLoggerExample');Logger.saveLog();  }}

Queueable jobs can also leverage the parent transaction ID to relate logs together. This example queueable job will run several chained instances. Each instance uses the parentLogTransactionId to relate its log back to the original instance's log.

ℹ️ If you deploy this example class to your org,you can run it usingSystem.enqueueJob(new QueueableLoggerExample(3));

public with sharingclassQueueableLoggerExampleimplementsQueueable {privateIntegernumberOfJobsToChain;privateStringparentLogTransactionId;privateList<LogEntryEvent__e>logEntryEvents=newList<LogEntryEvent__e>();// Main constructor - for demo purposes, it accepts an integer that controls how many times the job runspublicQueueableLoggerExample(IntegernumberOfJobsToChain) {this(numberOfJobsToChain,null);  }// Second constructor, used to pass the original transaction's ID to each chained instance of the job// You don't have to use a constructor - a public method or property would work too.// There just needs to be a way to pass the value of parentLogTransactionId between instancespublicQueueableLoggerExample(IntegernumberOfJobsToChain,StringparentLogTransactionId) {this.numberOfJobsToChain=numberOfJobsToChain;this.parentLogTransactionId=parentLogTransactionId;  }// Creates some log entries and starts a new instance of the job when applicable (based on numberOfJobsToChain)publicvoidexecute(System.QueueableContextqueueableContext) {Logger.setParentLogTransactionId(this.parentLogTransactionId);Logger.fine('queueableContext=='+queueableContext);Logger.info('this.numberOfJobsToChain=='+this.numberOfJobsToChain);Logger.info('this.parentLogTransactionId=='+this.parentLogTransactionId);// Add your queueable job's logic hereLogger.saveLog();--this.numberOfJobsToChain;if (this.numberOfJobsToChain>0) {StringparentLogTransactionId=this.parentLogTransactionId!=null?this.parentLogTransactionId:Logger.getTransactionId();System.enqueueJob(newQueueableLoggerExample(this.numberOfJobsToChain,parentLogTransactionId));    }  }}

Each of the logging methods inLogger (such asLogger.error(),Logger.debug(), and so on) has several static overloads for various parameters. These are intended to provide simple method calls for common parameters, such as:

• Log a message and a record -Logger.error(String message, SObject record)
• Log a message and a record ID -Logger.error(String message, Id recordId)
• Log a message and a save result -Logger.error(String message, Database.SaveResult saveResult)
• ...

To see the full list of overloads, check out theLogger classdocumentation.

Each of the logging methods inLogger returns an instance of the classLogEntryEventBuilder. This class provides several additional methods together to further customize each log entry - each of the builder methods can be chained together. In this example Apex, 3 log entries are created using different approaches for callingLogger - all 3 approaches result in identical log entries.

// Get the current user so we can log it (just as an example of logging an SObject)UsercurrentUser= [SELECTId,Name,Username,EmailFROMUserWHEREId=:UserInfo.getUserId()];// Using static Logger method overloadsLogger.debug('my string',currentUser);// Using the instance of LogEntryEventBuilderLogEntryEventBuilderbuilder=Logger.debug('my string');builder.setRecord(currentUser);// Chaining builder methods togetherLogger.debug('my string').setRecord(currentUser);// Save all of the log entriesLogger.saveLog();

The classLogMessage provides the ability to generate string messages on demand, usingString.format(). This provides 2 benefits:

1. Improved CPU usage by skipping unnecessary calls toString.format()

   StringformattedString=String.format('my example with input: {0}',List<Object>{'myString'});Logger.fine(formattedString);// With LogMessage, when the specified logging level (FINE) is disabled for the current user, `String.format()` is not calledLogMessagelogMessage=newLogMessage('my example with input: {0}','myString');Logger.fine(logMessage);

2. Easily build complex strings

   StringunformattedMessage='my string with 3 inputs: {0} and then {1} and finally {2}';StringformattedMessage=newLogMessage(unformattedMessage,'something','something else','one more').getMessage();StringexpectedMessage='my string with 3 inputs: something and then something else and finally one more';System.assertEquals(expectedMessage,formattedMessage);

For more details, check out theLogMessage classdocumentation.

As ofv4.14.10, Nebula Logger includes the Apex classCallableLogger, which implementsApex'sCallable interface.

• TheCallable interface only has 1 method:Object call(String action, Map<String,Object> args). It leverages string values and genericObject values as a mechanism to provide loose coupling on Apex classes that may or may not exist in a Salesforce org.
• This can be used by ISVs & package developers to optionally leverage Nebula Logger for logging, when it's available in a customer's org. And when it's not available, your package can still be installed, and still be used.

Using the providedCallableLogger class, a subset of Nebula Logger's features can be called dynamically in Apex. For example, this sample Apex code adds & saves 2 log entries (when Nebula Logger is available).

// Check for both the managed package (Nebula namespace) and the unlocked package to see if either is availableTypenebulaLoggerType=Type.forName('Nebula','CallableLogger') ??Type.forName('CallableLogger');CallablenebulaLoggerInstance= (Callable)nebulaLoggerType?.newInstance();if (nebulaLoggerInstance==null) {// If it's null, then neither of Nebula Logger's packages is available in the org 🥲return;}// Example: Add a basic "hello, world!" INFO extryMap<String,Object>newEntryInput=newMap<String,Object>{'loggingLevel'=>System.LoggingLevel.INFO,'message'=>'hello, world!'};nebulaLoggerInstance.call('newEntry',newEntryInput);// Example: Add an ERROR extry with an Apex exceptionExceptionsomeException=newDmlException('oops');Map<String,Object>newEntryInput=newMap<String,Object>{'exception'=>someException,'loggingLevel'=>LoggingLevel.ERROR,'message'=>'An unexpected exception was thrown'};nebulaLoggerInstance.call('newEntry',newEntryInput);// Example: Save any pending log entriesnebulaLoggerInstance.call('saveLog',null);

For more details,visit the wiki.

For lightning component developers, the includedlogger LWC can be used in other LWCs & aura components for frontend logging. Similar toLogger andLogEntryBuilder Apex classes, the LWC has bothlogger andlogEntryBuilder classes. This provides a fluent API for JavaScript developers so they can chain the method calls.

Once you've incorporatedlogger into your lightning components, you can see yourLogEntry__c records using the included list view "All Component Log Entries'.

EachLogEntry__c record automatically stores the component's type ('Aura' or 'LWC'), the component name, and the component function that calledlogger. This information is shown in the section "Lightning Component Information"

For lightning component developers, thelogger LWC provides very similar functionality that is offered in Apex. Simply import thegetLogger function in your component, use it to initialize an instance once per component, and call the desired logging methods within your code.

// For LWC, import logger's createLogger() function into your componentimport{getLogger}from'c/logger';importcallSomeApexMethodfrom'@salesforce/apex/LoggerLWCDemoController.callSomeApexMethod';exportdefaultclassLoggerDemoextendsLightningElement{// Call getLogger() once per componentlogger=getLogger();asyncconnectedCallback(){this.logger.setScenario('some scenario');this.logger.finer('initialized demo LWC, using async connectedCallback');}  @wire(callSomeApexMethod)wiredCallSomeApexMethod({ error, data}){this.logger.info('logging inside a wire function');if(data){this.logger.info('wire function return value: '+data);}if(error){this.logger.error('wire function error: '+JSON.stringify(error));}}logSomeStuff(){this.logger.error('Add log entry using Nebula Logger with logging level == ERROR').addTag('some important tag');this.logger.warn('Add log entry using Nebula Logger with logging level == WARN');this.logger.info('Add log entry using Nebula Logger with logging level == INFO');this.logger.debug('Add log entry using Nebula Logger with logging level == DEBUG');this.logger.fine('Add log entry using Nebula Logger with logging level == FINE');this.logger.finer('Add log entry using Nebula Logger with logging level == FINER');this.logger.finest('Add log entry using Nebula Logger with logging level == FINEST');this.logger.saveLog();}doSomething(event){this.logger.finest('Starting doSomething() with event: '+JSON.stringify(event));try{this.logger.debug('TODO - finishing implementation of doSomething()').addTag('another tag');// TODO add the function's implementation below}catch(thrownError){this.logger.error('An unexpected error log entry using Nebula Logger with logging level == ERROR').setExceptionDetails(thrownError).addTag('some important tag');}finally{this.logger.saveLog();}}}

To use the logger component, it has to be added to your aura component's markup:

<aura:componentimplements="force:appHostable"><c:loggeraura:id="logger"/><div>My component</div></aura:component>

Once you've added logger to your markup, you can call it in your aura component's controller:

({logSomeStuff:function(component,event,helper){constlogger=component.find('logger');logger.error('Hello, world!').addTag('some important tag');logger.warn('Hello, world!');logger.info('Hello, world!');logger.debug('Hello, world!');logger.fine('Hello, world!');logger.finer('Hello, world!');logger.finest('Hello, world!');logger.saveLog();}});

Within Flow (and Process Builder), there are 4 invocable actions that you can use to leverage Nebula Logger

1. 'Add Log Entry' - uses the classFlowLogEntry to add a log entry with a specified message
2. 'Add Log Entry for an SObject Record' - uses the classFlowRecordLogEntry to add a log entry with a specified message for a particular SObject record
3. 'Add Log Entry for an SObject Record Collection' - uses the classFlowCollectionLogEntry to add a log entry with a specified message for an SObject record collection
4. 'Save Log' - uses the classLogger to save any pending logs

Nebula Logger supports dynamically tagging/labeling yourLogEntry__c records via Apex, Flow, and custom metadata records inLogEntryTagRule__mdt. Tags can then be stored using one of the two supported modes (discussed below).

Apex developers can use 2 new methods inLogEntryBuilder to add tags -LogEntryEventBuilder.addTag(String) andLogEntryEventBuilder.addTags(List<String>).

// Use addTag(String tagName) for adding 1 tag at a timeLogger.debug('my log message').addTag('some tag').addTag('another tag');// Use addTags(List<String> tagNames) for adding a list of tags in 1 method callList<String>myTags=newList<String>{'some tag','another tag'};Logger.debug('my log message').addTags(myTags);

Flow builders can use theTags property to specify a comma-separated list of tags to apply to the log entry. This feature is available for all 3 Flow classes:FlowLogEntry,FlowRecordLogEntry andFlowCollectionLogEntry.

Admins can configure tagging rules to append additional tags using the custom metadata typeLogEntryTagRule__mdt.

• Rule-based tags are only added whenLogEntry__c records are created (not on update).
• Rule-based tags are added in addition to any tags that have been added via Apex and/or Flow.
• Each rule is configured to apply tags based on the value of a single field onLogEntry__c (e.g.,LogEntry__c.Message__c).
• Each rule can only evaluate 1 field, but multiple rules can evaluate the same field.
• A single rule can apply multiple tags. When specifying multiple tags, put each tag on a separate line within the Tags field (LogEntryTagRule__mdt.Tags__c).

Rules can be set up by configuring a custom metadata record with these fields configured:

1. Logger SObject: currently, only the "Log Entry" object (LogEntry__c) is supported.
2. Field: the SObject's field that should be evaluated - for example,LogEntry__c.Message__c. Only 1 field can be selected per rule, but multiple rules can use the same field.
3. Comparison Type: the type of operation you want to use to compare the field's value. Currently supported options are:CONTAINS,EQUALS,MATCHES_REGEX, andSTARTS_WITH.
4. Comparison Value: the comparison value that should be used for the selected field operation.
5. Tags: a list of tag names that should be dynamically applied to any matchingLogEntry__c records.
6. Is Enabled: only enabled rules are used by Logger - this is a handy way to easily enable/disable a particular rule without having to entirely delete it.

Below is an example of what a rule looks like once configured. Based on this rule, anyLogEntry__c records that contain "My Important Text" in theMessage__c field will automatically have 2 tags added - "Really important tag" and "A tag with an emoji, whynot?! 🔥"

Once you've implementing log entry tagging within Apex or Flow, you can choose how the tags are stored within your org. Each mode has its own pros and cons - you can also build your own plugin if you want to leverage your own tagging system (note: plugins are not currently available in the managed package).

Nebula Logger supports defining, setting, and mapping custom fields within Nebula Logger's data model. This is helpful in orgs that want to extend Nebula Logger's included data model by creating their own org/project-specific fields.

This feature requires that you populate your custom fields yourself, and is only available in Apex & JavaScript currently. The plan is to add in a future release the ability to also set custom fields via Flow.

• v4.13.14 added this functionality for Apex
• v4.14.6 added this functionality for JavaScript (lightning components)

The first step is to add a field to the platform eventLogEntryEvent__e

• Create a custom field onLogEntryEvent__e. Any data type supported by platform events can be used.

  • In this example, a custom text field calledSomeCustomField__c has been added:

    

• In Apex, you have 2 ways to populate your custom fields

  1. Set the field once per transaction - everyLogEntryEvent__e logged in the transaction will then automatically have the specified field populated with the same value.
     • This is typically used for fields that are mapped to an equivalentLog__c orLoggerScenario__c field.
  • How: call the static method overloadsLogger.setField(Schema.SObjectField field, Object fieldValue) orLogger.setField(Map<Schema.SObjectField, Object> fieldToValue)
  2. Set the field on a specificLogEntryEvent__e record - other records will not have the field automatically set.
     • This is typically used for fields that are mapped to an equivalentLogEntry__c field.
     • How: call the instance method overloadsLogEntryEventBuilder.setField(Schema.SObjectField field, Object fieldValue) orLogEntryEventBuilder.setField(Map<Schema.SObjectField, Object> fieldToValue)

  // Set My_Field__c on every log entry event created in this transaction with the same valueLogger.setField(LogEntryEvent__e.My_Field__c,'some value that applies to the whole Apex transaction');// Set fields on specific entriesLogger.warn('hello, world - "a value" set for Some_Other_Field__c').setField(LogEntryEvent__e.Some_Other_Field__c,'a value')Logger.warn('hello, world - "different value" set for Some_Other_Field__c').setField(LogEntryEvent__e.Some_Other_Field__c,'different value')Logger.info('hello, world - no value set for Some_Other_Field__c');Logger.saveLog();

• In JavaScript, you have 2 ways to populate your custom fields. These are very similar to the 2 ways available in Apex (above).

  1. Set the field once per component - everyLogEntryEvent__e logged in your component will then automatically have the specified field populated with the same value.
     • This is typically used for fields that are mapped to an equivalentLog__c orLoggerScenario__c field.
  • How: call thelogger LWC functionlogger.setField(Object fieldToValue)
  2. Set the field on a specificLogEntryEvent__e record - other records will not have the field automatically set.
     • This is typically used for fields that are mapped to an equivalentLogEntry__c field.
     • How: call the instance functionLogEntryEventBuilder.setField(Object fieldToValue)

  import{getLogger}from'c/logger';exportdefaultclassLoggerDemoextendsLightningElement{logger=getLogger();connectedCallback(){// Set My_Field__c on every log entry event created in this component with the same valuethis.logger.setField({My_Field__c,'some value that applies to any subsequent entry'});// Set fields on specific entriesthis.logger.warn('hello, world - "a value" set for Some_Other_Field__c').setField({Some_Other_Field__c:'a value'});this.logger.warn('hello, world - "different value" set for Some_Other_Field__c').setField({Some_Other_Field__c:'different value'});this.logger.info('hello, world - no value set for Some_Other_Field__c');this.logger.saveLog();}}

If you want to store the data in one of Nebula Logger's custom objects, you can follow the above steps, and also...

• Create an equivalent custom field on one of Nebula Logger's custom objects - right now, onlyLog__c,LogEntry__c, andLoggerScenario__c are supported.

  • In this example, a custom text fieldalso calledSomeCustomField__c has been added toLog__c object - this will be used to store the value of the fieldLogEntryEvent__e.SomeCustomField__c:

    

• Create a record in the new CMDTLoggerFieldMapping__mdt to map theLogEntryEvent__e custom field to the custom object's custom field, shown below. Nebula Logger will automatically populate the custom object's target field with the value of the sourceLogEntryEvent__e field.

  • In this example, a custom text field calledSomeCustomField__c has been added to bothLogEntryEvent__e andLog__c.

    

The Logger Console app provides access to the tabs for Logger's objects:Log__c,LogEntry__c,LogEntryTag__c andLoggerTag__c (for any users with the correct access).

To help development and support teams better manage logs (and any underlying code or config issues), some fields onLog__c are provided to track the owner, priority and status of a log. These fields are optional, but are helpful in critical environments (production, QA sandboxes, UAT sandboxes, etc.) for monitoring ongoing user activities.

• All editable fields onLog__c can be updated via the 'Manage Log' quick action (shown below)

  

• Additional fields are automatically set based on changes toLog__c.Status__c

  • Log__c.ClosedBy__c - The user who closed the log
  • Log__c.ClosedDate__c - The datetime that the log was closed
  • Log__c.IsClosed__c - Indicates if the log is closed, based on the selected status (and associated config in the 'Log Status' custom metadata type)
  • Log__c.IsResolved__c - Indicates if the log is resolved (meaning that it required analaysis/work, which has been completed). Only closed statuses can be considered resolved. This is also driven based on the selected status (and associated config in the 'Log Status' custom metadata type)

• To customize the statuses provided, simply update the picklist values forLog__c.Status__c and create/update corresponding records in the custom metadata typeLogStatus__mdt. This custom metadata type controls which statuses are considered closed and resolved.

Everyone loves JSON - so to make it easy to see a JSON version of aLog__c record, you can use the 'View JSON' quick action button. It displays the currentLog__c + all relatedLogEntry__c records in JSON format, as well as a handy button to copy the JSON to your clipboard. All fields that the current user can view (based on field-level security) are dynamically returned, including any custom fields added directly in your org or by plugins.

Within Logger Console app, the Log Entry Event Stream tab provides real-time monitoring ofLogEntryEvent__e platform events. Simply open the tab to start monitoring, and use the filters to further refine withLogEntryEvent__e records display in the stream.

Within App Builder, admins can add the 'Related Log Entries' lightning web component (lwc) to any record page. Admins can also control which columns are displayed be creating & selecting a field set onLogEntry__c with the desired fields.

• The component automatically shows any related log entries, based onLogEntry__c.RecordId__c == :recordId
• Users can search the list of log entries for a particular record using the component's built-insearch box. The component dynamically searches all related log entries using SOSL.
• Component automatically enforces Salesforce's security model
  • Object-Level Security - Users without read access toLogEntry__c will not see the component
  • Record-Level Security - Users will only see records that have been shared with them
  • Field-Level Security - Users will only see the fields within the field set that they have access to

Admins can easily delete old logs using 2 methods: list views or Apex batch jobs

Salesforce (still) does not support mass deleting records out-of-the-box. There's beenan Idea for 11+ years about it, but it's still not standard functionality. A custom button is available onLog__c list views to provide mass deletion functionality.

1. Admins can select 1 or moreLog__c records from the list view to choose which logs will be deleted

2. The button shows a Visualforce pageLogMassDelete to confirm that the user wants to delete the records

Two Apex classes are provided out-of-the-box to handle automatically deleting old logs

1. LogBatchPurger - this batch Apex class will delete anyLog__c records withLog__c.LogRetentionDate__c <= System.today().
   • By default, this field is populated with "TODAY + 14 DAYS" - the number of days to retain a log can be customized inLoggerSettings__c.
   • Admins can also manually edit this field to change the retention date - or set it to null to prevent the log from being automatically deleted
2. LogBatchPurgeScheduler - this schedulable Apex class can be schedule to runLogBatchPurger on a daily or weekly basis

If you want to add your own automation to theLog__c orLogEntry__c objects, you can leverage Apex or Flow to define "plugins" - the logger system will then automatically run the plugins after each trigger event (BEFORE_INSERT, BEFORE_UPDATE, AFTER_INSERT, AFTER_UPDATE, and so on). This framework makes it easy to build your own plugins, or deploy/install others' prebuilt packages, without having to modify the logging system directly.

• Flow plugins: your Flow should be built as auto-launched Flows with these parameters:

  1. Input parametertriggerOperationType - The name of the current trigger operation (such as BEFORE_INSERT, BEFORE_UPDATE, etc.)
  2. Input parametertriggerNew - The list of logger records being processed (Log__c orLogEntry__c records)
  3. Output parameterupdatedTriggerNew - If your Flow makes any updates to the collection of records, you should return a record collection containing the updated records
  4. Input parametertriggerOld - The list of logger records as they exist in the datatabase

• Apex plugins: your Apex class should implementsLoggerPlugin.Triggerable. For example:

  publicclassExampleTriggerablePluginimplementsLoggerPlugin.Triggerable {publicvoidexecute(LoggerPlugin__mdtconfiguration,LoggerTriggerableContextinput) {// Example: only run the plugin for Log__c recordsif (context.sobjectType!=Schema.Log__c.SObjectType) {return;    }List<Log__c>logs= (List<Log__c>)input.triggerNew;switchoninput.triggerOperationType {whenBEFORE_INSERT {for (Log__clog:logs) {log.Status__c='On Hold';        }      }whenBEFORE_UPDATE {// TODO add before-update logic      }    }  }}

Once you've created your Apex or Flow plugin(s), you will also need to configure the plugin:

• 'Logger Plugin' - use the custom metadata typeLoggerPlugin__mdt to define your plugin, including the plugin type (Apex or Flow) and the API name of your plugin's Apex class or Flow
• 'Logger Parameter' - use the custom metadata typeLoggerParameter__mdt to define any configurable parameters needed for your plugin, such as environment-specific URLs and other similar configurations

Note: the logger plugin framework is not available in the managed package due to some platform limitations & considerations with some of the underlying code. The unlocked package is recommended (instead of the managed package) when possible, including if you want to be able to leverage the plugin framework in your org.

The optionalSlack plugin leverages the Nebula Logger plugin framework to automatically send Slack notifications for logs that meet a certain (configurable) logging level. The plugin also serves as a functioning example of how to build your own plugin for Nebula Logger, such as how to:

• Use Apex to apply custom logic toLog__c andLogEntry__c records
• Add custom fields and list views to Logger's objects
• Extend permission sets to include field-level security for your custom fields
• Leverage the newLoggerParameter__mdt CMDT object to store configuration for your plugin

Check out theSlack plugin for more details on how to install & customize the plugin

If you want to remove the unlocked or managed packages, you can do so by simply uninstalling them in your org under Setup --> Installed Packages.