Welcome to the Nebula Logger wiki!

Nebula Logger is an open source logging tool for Salesforce. It's designed for Salesforce admins, developers & architects, to aid in development, troubleshooting & monitoring of your Salesforce environments.

Features

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, using LogEntryEvent__e platform events. For more details on leveraging platform events, see the 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 included LoggerSettings__c custom hierarchy settings object

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

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

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

8. Dynamically assign tags to Log__c and LogEntry__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 - using Apex's Callable interface and Nebula Logger's included implementation CallableLogger (requires v4.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

Learn more about the design and history of the project on the Joys Of Apex:

• Advanced Logging Using Nebula Logger
• What's New With Nebula Logger