Skip to content

Commit

Permalink
Better text fomratin
Browse files Browse the repository at this point in the history
  • Loading branch information
adriens authored and mbarre committed Mar 30, 2022
1 parent 7565061 commit 961588f
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ les développements d'application à l'[OPT-NC](https://github.com/opt-nc).
Toutes les logs sont dans le même fichier `.log (${LOG_FILE})` à l'exception des logs métiers qui se
trouvent dans un seul fichier `.json` `(${LOG_FILE_JSON})` si le besoin est exprimé.

## Import de la dépendance publique
## ⬇️ Import de la dépendance publique

Cette dépendance est disponible publiquement via [Jitpack](https://jitpack.io/#opt-nc/opt-logging).

### Maven
### 🪶 Maven

Ajouter la repo Jitpack :
Ajouter la repo [Jitpack](https://jitpack.io/) :

```xml
<repositories>
Expand All @@ -39,7 +39,7 @@ Puis la dépedance :
</dependency>
```

### Gradle
### 🐘 Gradle

Ajouter la repo :

Expand All @@ -60,17 +60,17 @@ dependencies {
}
```
## Import de la dépendance via GH Packages
## :octocat: Import de la dépendance via GH Packages
### Gradle
### 🐘 Gradle
Ajouter la dépendance suivante dans votre build.gradle :
```gradle
compile group: 'nc.opt.core', name: 'opt-logging', version: '${opt-logging.verion}'
```

### Maven
### 🪶 Maven

```xml
<dependency>
Expand Down Expand Up @@ -104,9 +104,9 @@ Contenu du fichier `src/main/resources/logback-spring.xml` :
<include resource="nc/opt/core/logging/logs-metiers.xml" />
```

## Fonctionnalités
## 📑 Fonctionnalités

## Logs classiques
### Logs classiques

Dans la configuration par défaut en version `1.3.0` :

Expand All @@ -116,7 +116,7 @@ Dans la configuration par défaut en version `1.3.0` :
4. Le rootLogger est par défaut à `INFO`


## Logs métiers
### Logs métiers

Dans la configuration des logs métiers en version `1.3.0` :

Expand All @@ -125,7 +125,7 @@ Dans la configuration des logs métiers en version `1.3.0` :
- Le Logger métier est par défaut à `INFO`


## Variables d'environnement
### Variables d'environnement

4 variables d'environnement sont nécessaires avec un profil non dev :

Expand All @@ -144,7 +144,7 @@ Une variable supplémentaire est nécessaire si on veut utiliser le service de l
- [x] La variable doit se terminer par `.json`


## How to log ?
## How to log

### Utilisation des logs classiques

Expand All @@ -167,7 +167,7 @@ Le fichier est un fichier `.log` avec une ligne par log de la forme suivante :
2017-09-19 10:01:27,273 [StreamThread-1] [INFO ] nc.opt.kafka.wfm.service.impl.WfmServiceImpl - TypeTCRM=THDF | Produit=null | Queue=Telecom::CPMC::IC::RLB | TypeId=10
```

**NB : Le fichier peut contenir des logs multi lignes en cas de stack trace java.**
👉 **Le fichier peut contenir des logs multi lignes en cas de stack trace java.**

### Utilisation du service de log métier

Expand Down

0 comments on commit 961588f

Please sign in to comment.