Skip to content

Commit

Permalink
modifying readme
Browse files Browse the repository at this point in the history
  • Loading branch information
matcdac committed Apr 23, 2023
1 parent 30bbe40 commit 2f0268b
Showing 1 changed file with 58 additions and 19 deletions.
77 changes: 58 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Throwable Utility


Throwable JSON Transformer Module
Java's Throwable JSON Transformer Module

[![Maven Central](https://img.shields.io/maven-central/v/com.github.TurquoiseSpace/throwable-utility.svg?label=Maven%20Central)](https://repo1.maven.org/maven2/com/github/TurquoiseSpace/throwable-utility/)

Expand All @@ -15,37 +15,49 @@ Throwable JSON Transformer Module



## Help - Starting off with "Throwable Utility"
## Usage as Dependency


The actual code is located inside
- Maven

./src/main/java/
```
<dependency>
<groupId>com.github.TurquoiseSpace</groupId>
<artifactId>throwable-utility</artifactId>
<version>0.0.3</version>
</dependency>
```

with the base package as
- Gradle

com.TurquoiseSpace
```
implementation group: 'com.github.TurquoiseSpace', name: 'throwable-utility', version: '0.0.3'
```

and child packages (shows the call heirarchy from top to bottom)
and in java files
- Gradle (Short)

```
implementation 'com.github.TurquoiseSpace:throwable-utility:0.0.3'
```

- Gradle (Kotlin)

```
implementation("com.github.TurquoiseSpace:throwable-utility:0.0.3")
```

utility
ExceptionLogUtil.java
GenericJsonUtil.java
JsonUtil.java
model
GenericException.java
ExceptionMeta.java
ExceptionPoint.java


### Description

The Utility classes `JsonUtil.java` or `GenericJsonUtil.java` are meant for mapping any Object to JSON, or vice versa
The main Utility class `ExceptionLogUtil.java` actually logs the Exception in JSON format, for better readibilty, or gives the Throwable JSON.

The other Utility class `JsonUtil.java` is meant for mapping any Object to JSON, or vice versa.

While `ExceptionLogUtil.java` logs the Exception in JSON format, for better readibilty.
Can be easily viewed in AWS Cloud Watch or DataDog or Splunk.
Easy to search, by providing whole paragraph of Exception log in one single line

Easy to search, by providing whole paragraph of Exception log in one single line.



### Log Search KeyWords
Expand All @@ -61,6 +73,31 @@ exceptionMeta



## Help - Starting off with the Code of "Throwable Utility" Repository


The actual code is located inside

./src/main/java/

with the base package as

com.TurquoiseSpace

and child packages (shows the call heirarchy from top to bottom)
and in java files

utility
ExceptionLogUtil.java
GenericJsonUtil.java
JsonUtil.java
model
GenericException.java
ExceptionMeta.java
ExceptionPoint.java



## GPG Keys


Expand Down Expand Up @@ -93,6 +130,7 @@ gpg --keyserver hkp://pgp.mit.edu --send-keys 876A6DD3FB3573F1
```



## Build


Expand All @@ -109,6 +147,7 @@ mvn -Dmaven.artifact.threads=25 clean eclipse:eclipse -DdownloadSources=true dep
```



## Publish Artifact

```
Expand Down

0 comments on commit 2f0268b

Please sign in to comment.