Skip to content

Commit

Permalink
Added New Comments__c Field on LoggerParameter__mdt (#650)
Browse files Browse the repository at this point in the history
* Added new field LoggerParameter__mdt.Comments__c as a place for admins & developers to store notes about why a LoggerParameter__mdt record has been customized. This is only intended for documentation purposes to help admins viewing the record in the org, as well as a way to document customizations in git/VCS

* Updated LoggerParameter__mdt records to include the XML node for the new Comments__c field

* Scope creep: added missing project license info in several LWC files

* Scope creep: added .npmrc to explicitly set the npm registry
  • Loading branch information
jongpie authored Mar 14, 2024
1 parent f6b0afc commit b3a08f0
Show file tree
Hide file tree
Showing 46 changed files with 196 additions and 14 deletions.
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
registry=https://registry.npmjs.org
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@

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

## Unlocked Package - v4.13.3
## Unlocked Package - v4.13.4

[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001MkEwQAK)
[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001MkEwQAK)
[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001MkFBQA0)
[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001MkFBQA0)
[![View Documentation](./images/btn-view-documentation.png)](https://jongpie.github.io/NebulaLogger/)

`sf package install --wait 20 --security-type AdminsOnly --package 04t5Y000001MkEwQAK`
`sf package install --wait 20 --security-type AdminsOnly --package 04t5Y000001MkFBQA0`

`sfdx force:package:install --wait 20 --securitytype AdminsOnly --package 04t5Y000001MkEwQAK`
`sfdx force:package:install --wait 20 --securitytype AdminsOnly --package 04t5Y000001MkFBQA0`

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Call Status API</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Default Log Entry Related List Field Set</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,15 @@
>
<label>Enable Log Entry Event Stream</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<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>
>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&apos;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
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Enable Logger System Messages</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value xsi:type="xsd:string">When enabled, log entries may be generated that contain additional details about the logging system.</value>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Enable Stack Trace Parsing</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Enable Tagging</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Log Entry Event Stream Display Fields</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value xsi:type="xsd:string">Contains the fields to be displayed in the Tabular view of the Log Entry Event Stream Tab under the Logger Console.</value>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Normalize Scenario Data</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Normalize Tag Data</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Platform Cache Partition Name</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value xsi:type="xsd:string">Indicates the name of the Platform Cache partition to use for caching (when platform cache is enabled).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Query Apex Class Data</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Query Apex Trigger Data</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Query Auth Session Data</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Query Auth Session Data Synchronously</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Query Flow Definition View Data</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Query Network Data</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value xsi:type="xsd:string">Note: this parameter only applies to orgs that are using Experience Cloud (Communities).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Query Network Data Synchronously</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value xsi:type="xsd:string">Note: this parameter only applies to orgs that are using Experience Cloud (Communities).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Query Organization Data</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Query Organization Data Synchronously</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Query Related Record Data</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Query User Data</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Query User Data Synchronously</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Send Error Email Notifications</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Store HTTP Response Header Values</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Store Organization Limits</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Store REST Request Header Values</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Store REST Response Header Values</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Store Transaction Limits</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>System.debug() Message Format</label>
<protected>true</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value xsi:type="xsd:string">Controls the format of the Apex Log System Debug messages with fields from LogEntryEvent__e</value>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Use First Specified Scenario</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,16 @@
>
<label>Use Platform Cache</label>
<protected>false</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value
xsi:type="xsd:string"
>When set to &apos;true&apos; (default), Nebula Logger will used Platform Cache to cache organization and session data in the cache partition LoggerCache.

When set to &apos;false&apos;, any cached data is only cached within a single transaction.</value>
</values>
<values>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
>
<label>Use Topics for Tags</label>
<protected>true</protected>
<values>
<field>Comments__c</field>
<value xsi:nil="true" />
</values>
<values>
<field>Description__c</field>
<value xsi:type="xsd:string">When set to &apos;true&apos;, any custom Logger tags will use the standard objects Topic and TopicAssignment
Expand Down
Loading

0 comments on commit b3a08f0

Please sign in to comment.