Skip to content

Commit

Permalink
Bumped package version number and name, generated updated ApexDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
jongpie committed Jun 6, 2023
1 parent e9c6574 commit 38fcea0
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 15 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

The most robust logger for Salesforce. Works with Apex, Lightning Components, Flow, Process Builder & Integrations. Designed for Salesforce admins, developers & architects.

## Unlocked Package - v4.10.6
## Unlocked Package - v4.11.0

[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000023SCqQAM)
[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000023SCqQAM)
Expand Down
4 changes: 4 additions & 0 deletions docs/apex/Configuration/LoggerParameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ Provides a centralized way to load parameters for SObject handlers & plugins

Indicates if Nebula Logger will make an async callout to `https://api.status.salesforce.com` to get additional details about the current org, which is then stored on the Log\_\_c record. Controlled by the custom metadata record `LoggerParameter.CallStatusApi`, or `false` as the default

#### `ENABLE_LOG_ENTRY_EVENT_STREAM``Boolean`

Indicates if Nebula Logger's LWC `logEntryEventStream` is enabled. The component uses the Emp API, which counts towards orgs' daily delivery allocations for platform events. To help reduce usage of the daily allocation limit, orgs can disable the LWC. Controlled by the custom metadata record `LoggerParameter.EnableLogEntryEventStream`, or `true` as the default

#### `ENABLE_STACK_TRACE_PARSING``Boolean`

Indicates if Nebula Logger will parse a stack trace for each log entry, which is then used to populate fields like `LogEntry__c.StackTrace__c` and `LogEntry__c.OriginLocation__c`. Controlled by the custom metadata record `LoggerParameter.EnableStackTraceParsing`, or `true` as the default
Expand Down
14 changes: 14 additions & 0 deletions docs/apex/Log-Management/LogEntryEventStreamController.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,18 @@ List<String>

The instance of `List<String>`, containing the list of columns to be displayed in

#### `isEnabled()``Boolean`

Indicates if the LWC `logEntryEventStream` has been enabled (default) or disabled

##### Return

**Type**

Boolean

**Description**

The `Boolean` value of the `LoggerParameter_t` record `LoggerParameter.EnableLogEntryEventStream`

---
4 changes: 0 additions & 4 deletions docs/apex/Log-Management/LoggerHomeHeaderController.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,6 @@ An instance of `LoggerHomeHeaderController.Environment`

###### `organizationDomainUrl``String`

###### `organizationEnvironment``String`

###### `organizationFormattedCreatedDate``String`

###### `organizationId``String`
Expand All @@ -64,8 +62,6 @@ An instance of `LoggerHomeHeaderController.Environment`

###### `organizationReleaseVersion``String`

###### `organizationStatus``String`

###### `organizationType``String`

---
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@ public class LoggerParameter {
}

/**
* @description Indicates if Nebula Logger will parse a stack trace for each log entry, which is then used to populate
* fields like `LogEntry__c.StackTrace__c` and `LogEntry__c.OriginLocation__c`.
* Controlled by the custom metadata record `LoggerParameter.EnableStackTraceParsing`, or `true` as the default
* @description Indicates if Nebula Logger's LWC `logEntryEventStream` is enabled. The component uses
* the Emp API, which counts towards orgs' daily delivery allocations for platform events.
* To help reduce usage of the daily allocation limit, orgs can disable the LWC.
* Controlled by the custom metadata record `LoggerParameter.EnableLogEntryEventStream`,
* or `true` as the default
*/
public static final Boolean ENABLE_LOG_ENTRY_EVENT_STREAM {
get {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
<protected>false</protected>
<values>
<field>Description__c</field>
<value xsi:type="xsd:string">When set to &apos;true&apos; (default), the LWC logEntryEventStream is enabled &amp; subscribes to LogEntryEvent__e records, using the Emp API. Using the Emp API counts towards your org's event delivery allocations, so the LWC can be disabled if the allocation needs to be conserved. See this page for more details may be generated that contain additional details about the logging system - https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_event_limits.htm</value>
<value
xsi:type="xsd:string"
>When set to &apos;true&apos; (default), the LWC logEntryEventStream is enabled &amp; subscribes to LogEntryEvent__e records, using the Emp API. Using the Emp API counts towards your org's event delivery allocations, so the LWC can be disabled if the allocation needs to be conserved. See this page for more details may be generated that contain additional details about the logging system - https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_event_limits.htm</value>
</values>
<values>
<field>Value__c</field>
Expand Down
2 changes: 1 addition & 1 deletion nebula-logger/core/main/logger-engine/classes/Logger.cls
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
global with sharing class Logger {
// There's no reliable way to get the version number dynamically in Apex
@TestVisible
private static final String CURRENT_VERSION_NUMBER = 'v4.10.6';
private static final String CURRENT_VERSION_NUMBER = 'v4.11.0';
private static final System.LoggingLevel FALLBACK_LOGGING_LEVEL = System.LoggingLevel.DEBUG;
private static final Set<String> IGNORED_APEX_CLASSES = initializeIgnoredApexClasses();
private static final List<LogEntryEventBuilder> LOG_ENTRIES_BUFFER = new List<LogEntryEventBuilder>();
Expand Down
2 changes: 1 addition & 1 deletion nebula-logger/core/main/logger-engine/lwc/logger/logger.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import { LightningElement, api } from 'lwc';
import { createLoggerService } from './loggerService';

const CURRENT_VERSION_NUMBER = 'v4.10.6';
const CURRENT_VERSION_NUMBER = 'v4.11.0';

export default class Logger extends LightningElement {
#loggerService = createLoggerService();
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "nebula-logger",
"version": "4.10.6",
"version": "4.11.0",
"description": "The most robust logger for Salesforce. Works with Apex, Lightning Components, Flow, Process Builder & Integrations. Designed for Salesforce admins, developers & architects.",
"author": "Jonathan Gillespie",
"license": "MIT",
Expand Down
6 changes: 3 additions & 3 deletions sfdx-project.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
"package": "Nebula Logger - Core",
"path": "./nebula-logger/core",
"definitionFile": "./config/scratch-orgs/base-scratch-def.json",
"versionNumber": "4.10.6.NEXT",
"versionName": "More Log__c and LogEntry__c fields",
"versionDescription": "Added more fields to capture additional Flow details, organization details, and browser details via logger LWC",
"versionNumber": "4.11.0.NEXT",
"versionName": "Summer '23 Release",
"versionDescription": "Updated all metadata to API v58.0, added LoggerParameter__mdt record to disable the LWC logEntryEventStream",
"releaseNotesUrl": "https://github.com/jongpie/NebulaLogger/releases",
"unpackagedMetadata": {
"path": "./nebula-logger/extra-tests"
Expand Down

0 comments on commit 38fcea0

Please sign in to comment.