From a9d7d867be9ec4e20e195b8058088f02e7ae2ba8 Mon Sep 17 00:00:00 2001 From: "ljf (zamentur)" Date: Tue, 5 Jun 2018 17:40:31 +0200 Subject: [PATCH 1/4] [enh] Add doc about log registration feature --- packaging_apps.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/packaging_apps.md b/packaging_apps.md index 3f04d214..221aa5bb 100644 --- a/packaging_apps.md +++ b/packaging_apps.md @@ -48,6 +48,35 @@ Take a look at the [ownCloud package](https://github.com/Kloadut/owncloud_ynh) f ### Helpers Helpers +### Register a log +In a lot of case, you could want to register log file created by your app, to display it in YunoHost webadmin. To register a log, you can create a reference file in /var/log/yunohost/categories/app/APPNAME.yml + +You can specify started date by begining the file name by the date formatted as YYYYMMDD-HHMMSS. + +Example of yml metatdata log file: +``` +log_path: /path/to/your/log/file.log +``` + +If you want display some context info, you can add : +``` +extra: + env: + args1: value1 + args2: value2 + args3: value3 +``` + +You can attach the domain to an app, domain, service or user like this : +``` +related_to: + - ['app', 'APPNAME'] + - ['service', 'SERVICE1'] + - ['service', 'SERVICE2'] + - ['domain', 'DOMAIN.TLD'] +``` +This will be used to filter logs and display all log related to an entity lika a user, a domain, an app or a service. + ### Test it! In order to test your package, you can execute your script standalone as `admin` (do not forget to append required arguments): ```bash From 9b926559ce3f87f8246b0d036d3c088545f40187 Mon Sep 17 00:00:00 2001 From: "ljf (zamentur)" Date: Tue, 5 Jun 2018 17:50:24 +0200 Subject: [PATCH 2/4] [enh] Add fr for new doc about log system --- packaging_apps_fr.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/packaging_apps_fr.md b/packaging_apps_fr.md index 4b5d9a07..8bac6be0 100644 --- a/packaging_apps_fr.md +++ b/packaging_apps_fr.md @@ -45,6 +45,36 @@ Comme les instances de YunoHost possèdent une architecture unifiée, vous serez ### Commandes pratiques Commandes pratiques +### Référencement des logs +Dans de nombreuses situations, vous pouvez vouloir indexer un fichier de log pour qu'il soit affiché dans la webadmin. Pour indexer un log, il faut créer un fichier d'indexation dans /var/log/yunohost/categories/app/APPNAME.yml. + +Il est possible de spécifier la date de début en commençant le nom de fichier par la date YYYYMMDD-HHMMSS. + +Exemple de fichier de log d'indexation: +``` +log_path: /chemin/vers/le/fichier.log +``` + +Il est possible d'afficher des infos complémentaires, la variable env sera affichée dans la partie "Contexte" : +``` +extra: + env: + args1: value1 + args2: value2 + args3: value3 +``` + +Il est possible de rattacher le log à une application précise et/ou un service, un nom de domaine, une personne : +``` +related_to: + - ['app', 'APPNAME'] + - ['service', 'SERVICE1'] + - ['service', 'SERVICE2'] + - ['domain', 'DOMAIN.TLD'] +``` +Ces informations seront utilisées pour pemettre de filtrer le slogs en relation avec une de ces entités application, service, domaine, personne. + + ### Améliorer la qualité du paquet d’installation Vous trouverez ci-dessous une liste des points à vérifier concernant la qualité de vos scripts : * Vos scripts utilisent bien `sudo cp -a ../sources/. $final_path` plutôt que `sudo cp -a ../sources/* $final_path` ; From f1a96a907fc2e4a24ebef65f5172f8cfc0894474 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Sun, 26 Aug 2018 17:47:18 +0200 Subject: [PATCH 3/4] Fix typo / wording --- packaging_apps.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/packaging_apps.md b/packaging_apps.md index 221aa5bb..ba719ed1 100644 --- a/packaging_apps.md +++ b/packaging_apps.md @@ -48,18 +48,19 @@ Take a look at the [ownCloud package](https://github.com/Kloadut/owncloud_ynh) f ### Helpers Helpers -### Register a log -In a lot of case, you could want to register log file created by your app, to display it in YunoHost webadmin. To register a log, you can create a reference file in /var/log/yunohost/categories/app/APPNAME.yml +### Registering a log file -You can specify started date by begining the file name by the date formatted as YYYYMMDD-HHMMSS. +In a lot of case, you might want to register a log file created by your app, to make it available in the webadmin. To register a log, you can create a reference file `/var/log/yunohost/categories/app/APPNAME.yml`. -Example of yml metatdata log file: -``` +You can specify a start date by starting the file name with the date formatted as `YYYYMMDD-HHMMSS`. + +Example of yml metadata log file: +```bash log_path: /path/to/your/log/file.log ``` -If you want display some context info, you can add : -``` +If you want display some context info, you can add: +```bash extra: env: args1: value1 @@ -67,15 +68,16 @@ extra: args3: value3 ``` -You can attach the domain to an app, domain, service or user like this : -``` +You can attach the log to an app, domain, service or user like this : +```bash related_to: - ['app', 'APPNAME'] - ['service', 'SERVICE1'] - ['service', 'SERVICE2'] - ['domain', 'DOMAIN.TLD'] ``` -This will be used to filter logs and display all log related to an entity lika a user, a domain, an app or a service. + +This will be used to filter logs and display all log related to an entity like a user, a domain, an app or a service. ### Test it! In order to test your package, you can execute your script standalone as `admin` (do not forget to append required arguments): From 3e06be361276110e6b501a32364c595e2d44b237 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Sun, 26 Aug 2018 17:48:21 +0200 Subject: [PATCH 4/4] Update packaging_apps_fr.md --- packaging_apps_fr.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/packaging_apps_fr.md b/packaging_apps_fr.md index 8bac6be0..8c3c7129 100644 --- a/packaging_apps_fr.md +++ b/packaging_apps_fr.md @@ -46,17 +46,17 @@ Comme les instances de YunoHost possèdent une architecture unifiée, vous serez Commandes pratiques ### Référencement des logs -Dans de nombreuses situations, vous pouvez vouloir indexer un fichier de log pour qu'il soit affiché dans la webadmin. Pour indexer un log, il faut créer un fichier d'indexation dans /var/log/yunohost/categories/app/APPNAME.yml. +Dans de nombreuses situations, vous pouvez vouloir indexer un fichier de log pour qu'il soit affiché dans la webadmin. Pour indexer un log, il faut créer un fichier d'indexation dans `/var/log/yunohost/categories/app/APPNAME.yml`. -Il est possible de spécifier la date de début en commençant le nom de fichier par la date YYYYMMDD-HHMMSS. +Il est possible de spécifier la date de début en commençant le nom de fichier par la date `YYYYMMDD-HHMMSS`. Exemple de fichier de log d'indexation: -``` +```bash log_path: /chemin/vers/le/fichier.log ``` Il est possible d'afficher des infos complémentaires, la variable env sera affichée dans la partie "Contexte" : -``` +```bash extra: env: args1: value1 @@ -65,14 +65,15 @@ extra: ``` Il est possible de rattacher le log à une application précise et/ou un service, un nom de domaine, une personne : -``` +```bash related_to: - ['app', 'APPNAME'] - ['service', 'SERVICE1'] - ['service', 'SERVICE2'] - ['domain', 'DOMAIN.TLD'] ``` -Ces informations seront utilisées pour pemettre de filtrer le slogs en relation avec une de ces entités application, service, domaine, personne. + +Ces informations seront utilisées pour permettre de filtrer les logs en relation avec une de ces entités application, service, domaine, personne. ### Améliorer la qualité du paquet d’installation