Merge pull request #91 from navikt/logger-readme

Logger readme and  definition file for applicaiton-monitoring

Author: frodehoen

sfdx-project.json

@@ -48,12 +48,10 @@
       ]
     },
     {
-      "versionName": "ver 0.1",
-      "versionNumber": "0.1.0.NEXT",
       "path": "src/application-monitoring",
-      "default": false,
       "package": "application-monitoring",
-      "versionDescription": "Rammeverk for logging"
+      "versionNumber": "0.1.0.NEXT",
+      "definitionFile": "config/scratch-org-def.json"
     }
   ],
   "packageAliases": {

src/application-monitoring/README.md

@@ -2,9 +2,23 @@
 
 ## Application Log
 
-Logger rammeverk som publiserer logger til Application_Log\_\_c
+This package contains an application logging framework that can be used for logging various events either på utilizing the _LoggerUtility_ apex class, or by generating _Application_Log\_\_c_ records via process builder, flow, workflow etc. The logger has four log levels: (Error, Warning, Info, Critical). It is highly recommended to also pass a _CRM_ApplicationDomain.Domain_ parameter, which defines which area of the application is both creating the log entry and is responsible for follow up. Calling the respective logger methods can be done as shown:
 
-Datamodellen ligger i pakken [platform-data-model](src/platform-data-model/README.md)
+```Apex
+LoggerUtility logger = new LoggerUtility();
+logger.Info('Message', SObjectRef, domain);
+logger.Warning('Message', SObjectRef, domain);
+logger.Error('Message', SObjectRef, domain);
+logger.Critical('Message', SObjectRef, domain);
+
+logger.Exception(ex, domain) //Used for logging catched exceptions
+logger.publish();
+```
+
+The logger framework automatically adds the stacktrace, source function and source class to the log record when creating a log entry. To allow for application logging while also rolling back a transaction the framework includes also an _Application_Event\_\_e_ platform event counterpart that can be published even when rolling back transactions, _the standard publish() will generate a platform event_. Each log entry generates an unique UUID at runtime that can be handy for i.e. callouts requiring unique callout references in the callout chain. This examples returns the UUID of the last logged event:
+`logger.peek().UUID__c`
+
+The data model is available in [platform-data-model](src/platform-data-model/README.md)
 
 |         |     |
 | ------- | --- |
@@ -13,29 +27,16 @@ Datamodellen ligger i pakken [platform-data-model](src/platform-data-model/READM
 | Flow    | ✅  |
 | Trigger | ✅  |
 
-## Hvordan ta i bruk
+````
 
-Husk å angi teamet som er ansvarlig for funksjonaliteten som logges i LoggerUtility.
+## Dependencies
 
-```java
-  private LoggerUtility logger = new LoggerUtility(
-        CRM_ApplicationDomain.Domain.PLATFORCE,
-        'LoginFlow'
-    );
-
-    logger.errorAndPublish('Error message');
-    logger.warningAndPublish('Warning message');
-    logger.infoAndPublish('Info message');
-```
-
-## Avhengigheter
-
-- [platform-datamodel](src/platform-data-model/feature-flag-custom-metadata) - datamodell
+- [platform-datamodel](src/platform-data-model/feature-flag-custom-metadata) - data model
 
 ```mermaid
 ---
-title: Pakkeavhengigheter
+title: Package dependencies
 ---
 graph TD
     application-monitoring --> platform-datamodel;
-```
+````