Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 92 additions & 3 deletions docs/2.modules/9.logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ updatedAt: '2023-03-01'
Les logs sont un historique des actions faites sur votre serveur. Ils vous permettent de pouvoir retrouver une action qui vous intrigue ou bien de voir qui a fait quelle action.

Les logs sont des embeds qui sont envoyés non pas par **DraftBot**, mais par des webhooks. Un webhook vous permet d'envoyer un message avec une photo de profil, un nom et un contenu personnalisé.
> ***DraftBot** gère ses propres webhooks et l'envoi des messages avec ses derniers. Si vous supprimez son webhook de logs, il le recréera automatiquement lors de l'envoi du prochain log.*

## Configuration générale

Expand All @@ -29,10 +28,15 @@ Les logs sont des embeds qui sont envoyés non pas par **DraftBot**, mais par de
Ici sera affiché, pour chaque module :
- Log activé (✅) ou non (❌).
- Salon d'envoi.
- Couleur.
- Couleur. <:icon_premium_:1096140508625125417>
- Avatar. <:icon_premium_:1096140508625125417>

::hint{ type="info" }
Les logs de messages et de boosts sont réservés aux serveurs [premium <:icon_premium_:1096140508625125417>](/premium).
Les fonctionnalités accompagnées du symbole <:icon_premium:1096140508625125417> sont réservées aux serveurs [premium](/premium) <:icon_premium_:1096140508625125417>.
::

::hint{ type="info" }
Les logs de **messages** et de **boosts** sont réservés aux serveurs [premium](/premium) <:icon_premium_:1096140508625125417>.
::

Sous ce message, retrouvez les boutons permettant de configurer les logs :
Expand Down Expand Up @@ -67,6 +71,89 @@ Les logs sont des embeds qui sont envoyés non pas par **DraftBot**, mais par de
::
::

## Configuration des destinations

Chaque log peut être envoyé vers différentes destinations.

### Choix de la destination

::tabs
::tab{ label="Via le panel" }
[⫸ Accéder au panel de **DraftBot**](/dashboard/first/logs)

![Configuration d'un module de log depuis le panel](../assets/logs/panel_module.png)

Vous pouvez choisir la destination d'envoi des logs en cliquant sur **Modifier** puis choisir le type de destination parmi [ces options](#les-options).
::

::tab{ label="Via la commande /config" }
Si vous souhaitez effectuer toute la configuration directement depuis Discord, vous pouvez le faire via la commande /config, puis en vous rendant dans l'onglet "Logs". Le menu ressemble alors à ceci :

![Configuration d'un module de log depuis le /config](../assets/logs/config_moderation.png)

Vous pouvez choisir la destination d'envoi des logs en cliquant sur **Destination** puis choisir le type de destination parmi [ces options](#les-options).
::
::

### Les options

::tabs
::tab{ label="Serveur" }
L'option par défaut, les logs sont envoyés dans un salon configuré du serveur.

> ***DraftBot** gère ses propres webhooks et l'envoi des messages avec ses derniers. Si vous supprimez son webhook de logs, il le recréera automatiquement lors de l'envoi du prochain log.*
::

::tab{ label="Autres serveurs" }
::hint{ type="warning" }
Vous devez être propriétaire du serveur en question afin de pouvoir configurer cette fonctionnalité.
::
Les logs sont envoyés vers un autre serveur Discord à l'aide d'un **webhook Discord** externe.

> Exemple :
> https://discord.com/api/webhooks/...

Pour créer un webhook, vous devez aller dans les \<:icon_settings:1120818166067646664> **Paramètres** de votre salon de réception, dans la section **Intégrations** et vous pourrez alors **Créer un webhook**.

![Créez vos webhooks en cliquant sur "Créer un webhook"](../assets/logs/server_webhook.png)

Après avoir créer votre webhook, vous pouvez modifier votre webhook.

![Menu qui apparaît lors de la modifiication d'un webhook](../assets/logs/server_webhook_section.png)

Parmi ce qui apparaît dans ce menu, nous retrouvons :

| Composant | Description |
|-----------|-------------|
| Nom | Le nom avec lequel le webhook enverra les logs de **DraftBot** |
| Image | L'image avec laquelle le webhook enverra les logs de **DraftBot** |
| Salon | Le salon dans lequel le webhook enverra les logs de **DraftBot** |
| Copier l'URL du webhook | Permet de copier l'URL du webhook afin de le renseigner dans le [choix de la destination](#choix-de-la-destination) |
| Suppression du webhook | Permet de supprimer le webhook si vous n'en avez plus besoin. |

::hint{ type="warning" }
**Attention :** Cette action est irréversible
::
::

::tab{ label="API Externe" }
Les logs sont envoyés vers une URL externe (API, site web, service tiers).

| Type | Description | Exemple |
|------|-------------|---------|
| **URL personnalisée** | URL vers laquelle les données sont envoyées. Elle doit être valide et commencer par http:// ou https://. | https://example.com/webhook |
| **Headers HTTP personnalisés** | Paires clé/valeur ajoutées à la requête HTTP (authentification, options…). Jusqu'à 3 headers sont autorisés. | X-API-Key: YOUR_API_KEY |

::hint{ type="info" }
Cette fonctionnalité est réservée aux serveurs [premium](/premium) <:icon_premium_:1096140508625125417>.
::

::hint{ type="warning" }
Vous devez être propriétaire du serveur en question afin de pouvoir configurer cette fonctionnalité.
::
::
::

## Configuration par module

::tabs
Expand Down Expand Up @@ -115,3 +202,5 @@ Les logs sont des embeds qui sont envoyés non pas par **DraftBot**, mais par de
::
::



Binary file added docs/assets/logs/config_moderation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/logs/config_modules.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/logs/config_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/logs/panel_activate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/logs/panel_module.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/logs/server_webhook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/logs/server_webhook_section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.