Nebula Logger

Nebula Logger is a native Salesforce observability solution that uses an event-driven pub/sub architecture via the LogEntryEvent__e platform event.

Key Capabilities:

• Multi-Platform Logging: Supports Apex (classes, triggers, anonymous), Lightning Components (LWC & Aura), Flow & Process Builder (via invocable actions), and OmniStudio (Omniscripts & Integration Procedures).
• Data Storage: Logs are stored in five custom objects: Log__c, LogEntry__c, LogEntryTag__c, LoggerTag__c, and LoggerScenario__c.
• Security & Configuration: Includes automatic data masking via LogEntryDataMaskRule__mdt and customizable logging settings per user/profile using LoggerSettings__c.
• UI Integration: View related logs on any Lightning record page using the relatedLogEntries LWC component.
• Extensibility: Features a built-in plugin framework (available in Unlocked Package) to automate actions on log objects using Apex or Flow triggers.

Since asynchronous jobs (Batchable, Queueable) run in separate transactions with unique transaction IDs, you can use Logger.setParentLogTransactionId(String) to link them to an original transaction. This populates the Log__c.ParentLog__c field, allowing you to trace the entire execution chain.

Pattern for Batchable:

1. In start(), capture the original ID using Logger.getTransactionId().
2. In execute() and finish(), pass that ID to Logger.setParentLogTransactionId() before logging.

public with sharing class BatchableLoggerExample implements Database.Batchable<SObject>, Database.Stateful {
  private String originalTransactionId;

  public Database.Queryable start(Database.BatchableContext batchableContext) {
    this.originalTransactionId = Logger.getTransactionId();
    Logger.info('Starting BatchableLoggerExample');
    Logger.saveLog();
    return Database.getQueryLocator([SELECT Id FROM Account]);
  }

  public void execute(Database.BatchableContext batchableContext, List<Account> scope) {
    Logger.setParentLogTransactionId(this.originalTransactionId);
    for (Account account : scope) {
      Logger.info('Processed an account record', account);
    }
    Logger.saveLog();
  }

  public void finish(Database.BatchableContext batchableContext) {
    Logger.setParentLogTransactionId(this.originalTransactionId);
    Logger.info('Finishing running BatchableLoggerExample');
    Logger.saveLog();
  }
}

Nebula Logger's behavior is centrally controlled through the LoggerParameter class, which loads settings from LoggerParameter_t custom metadata records. You can modify these settings to enable/disable features, change data storage strategies, or optimize performance.

Common configuration categories include:

• Data Storage: Control whether to use custom objects (e.g., LoggerTag__c) or standard fields (e.g., LogEntry__c.Tags__c) via NORMALIZE_TAG_DATA and NORMALIZE_SCENARIO_DATA.
• Querying & Performance: Enable or disable querying of specific Salesforce schemas (e.g., QUERY_USER_DATA, QUERY_ORGANIZATION_DATA) and control whether these queries happen synchronously or asynchronously.
• Stack Traces: Enable parsing via ENABLE_STACK_TRACE_PARSING and filter out specific utility classes using IGNORED_APEX_ORIGINS.
• Limits & Metadata: Toggle storage of transaction limits (STORE_TRANSACTION_LIMITS), organization limits (STORE_ORGANIZATION_LIMITS), or HTTP/REST header values.
• Platform Cache: Enable the use of Platform Cache via USE_PLATFORM_CACHE to optimize organization and session data retrieval.

Nebula Logger supports two modes for storing tags. Note that the Salesforce Topics mode is not available in the managed package.

1. Logger's Custom Tagging Objects (Default)

This mode uses custom objects to manage tags and is available in both unlocked and managed packages.

• Data Model: Uses LoggerTag__c (the unique tag name) and LogEntryTag__c (a junction object between the tag and the log entry).
• Visibility: Controlled via standard Salesforce sharing (OWD, sharing rules, etc.). By default, LoggerTag__c is 'public read-only' for internal users.
• Capabilities: Supports all standard platform features like custom list views, reports, dashboards, Chatter feeds, and activities.

2. Salesforce Topic and TopicAssignment Objects

This mode leverages native Chatter functionality.

• Data Model: Uses the standard Topic object and the TopicAssignment junction object.
• Visibility: Topic records are visible to all Chatter users. TopicAssignment records are only visible to users with access to the related EntityId (the LogEntry__c).
• Capabilities: Allows using Topics to filter list views. However, using Topics in reports and dashboards is only partially implemented by Salesforce.