docs(audit): document the audit log screen

docs/admin-guide/audit-log.md → docs/admin-guide/audit-log/README.md

@@ -10,7 +10,8 @@ role, who created an API token. Each event shows who did it, when, from which ad
 worked. Use it to find out what happened on your installation, or send the events to your SIEM to keep them
 next to the rest of your logs.
 
-The audit log is available in every edition. Sending events to a SIEM requires Semaphore Pro.
+The audit log is available in every edition. Filtering, exporting it as a file and sending events to a SIEM
+require Semaphore Pro.
 
 ## What is recorded {#recorded-events}
 
@@ -27,6 +28,7 @@ Semaphore currently records sign-in, account, project and task activity:
   completions and deleted task history;
 - runner changes, registrations (including refused registration tokens), unregistrations and runner reports
   with an invalid status;
+- exports of the audit log as a file;
 - every server start.
 
 For the full list, see
@@ -110,7 +112,7 @@ networks your users connect from: anyone there could set these headers to any ad
 
 ## Storage {#storage}
 
-Events are stored in the Semaphore database, so your regular database backups include them. Semaphore does not show audit events in the UI. By default it keeps every event. To delete old events, set a
+Events are stored in the Semaphore database, so your regular database backups include them. By default Semaphore keeps every event. To delete old events, set a
 retention period in days:
 
 ```json
@@ -364,6 +366,7 @@ descriptions, views, clearing the project cache and scheduled secret storage syn
 
 ## What's next {#whats-next}
 
+- [View the audit log](/admin-guide/audit-log/view) — read, filter and export events in the web UI.
 - [Audit events](/reference/audit-events) — the event format and every recorded event.
 - [Configuration options](/reference/configuration#audit-log) — every `audit.*` option and environment variable.
 - [Logs](/admin-guide/logs) — server, activity and task logs.

docs/admin-guide/audit-log/view.md

@@ -0,0 +1,30 @@
+---
+title: View the audit log
+description: "Read the audit log in the web UI: the newest events, every field of an event and, with Semaphore Pro, filters and export to CSV or JSON Lines."
+---
+
+# View the audit log
+
+Administrators open **Audit log** from the user menu. The newest events come first, 50 to a page.
+
+![The audit log, newest events first](/assets/audit-log-list.png)
+
+Click an event to see every field it has. The copy button copies the event in the format Semaphore sends to a
+SIEM.
+
+![An event with all of its fields](/assets/audit-log-card.png)
+
+## Filter and export <FeatureState feature="audit-log-filters" /> {#filter-export}
+
+Filter by period, user, event kind, result, project or IP address. In an event, the user, the address, the object
+and the project are links that filter the log by them.
+
+![The log filtered by the address of an event](/assets/audit-log-filters.png)
+
+When a combination of filters finds few events, Semaphore searches about two seconds at a time. **Older** and
+**Newer** keep searching on their own until they find events, show how far the search got and stop on **Stop**.
+
+**Export** saves every event that matches the filters as a CSV or JSON Lines file. Each export is recorded as an
+`audit.log/export` event.
+
+![Export as CSV or JSON Lines](/assets/audit-log-export.png)

docs/reference/audit-events.md

@@ -173,8 +173,10 @@ Every event is a JSON object. Fields that do not apply to an event are left out.
 | `system.license` | `activate` | `change` | success, failure | `activation_failed` |  | Pro |
 | `audit.lifecycle` | `start` | `start` | success |  | `destinations` | Community |
 | `audit.retention` | `delete` | `deletion` | success |  | `deleted`, `last_seq`, `retention_days` | Community |
+| `audit.log` | `export` | `access` | success |  | `format`, `filters`, `events`, `complete` | Pro |
 
 ## Related pages {#related-pages}
 
 - [Audit log](/admin-guide/audit-log) — turn on the audit log and send events to a SIEM.
+- [View the audit log](/admin-guide/audit-log/view) — read, filter and export events in the web UI.
 - [Configuration options](/reference/configuration#audit-log) — every `audit.*` option and environment variable.

i18n/de/docusaurus-plugin-content-docs/current.json

@@ -74,5 +74,9 @@
   "sidebar.tutorialSidebar.category.FAQ": {
     "message": "FAQ",
     "description": "The label for category FAQ in sidebar tutorialSidebar"
+  },
+  "sidebar.tutorialSidebar.category.Audit log": {
+    "message": "Audit-Protokoll",
+    "description": "The label for category Audit log in sidebar tutorialSidebar"
   }
 }

i18n/de/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md → i18n/de/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md

@@ -10,7 +10,7 @@ oder eine Rolle geändert hat, wer ein API-Token erstellt hat. Jedes Ereignis ze
 welcher Adresse und ob es funktioniert hat. Damit finden Sie heraus, was in Ihrer Installation passiert ist,
 oder Sie senden die Ereignisse an Ihr SIEM, damit sie neben Ihren übrigen Logs liegen.
 
-Das Audit-Protokoll ist in jeder Edition verfügbar. Für das Senden an ein SIEM wird Semaphore Pro benötigt.
+Das Audit-Protokoll ist in jeder Edition verfügbar. Für das Filtern, den Export als Datei und das Senden an ein SIEM wird Semaphore Pro benötigt.
 
 ## Was aufgezeichnet wird {#recorded-events}
 
@@ -27,6 +27,7 @@ Derzeit zeichnet Semaphore Anmeldungen, Konto-, Projekt- und Task-Aktivitäten a
   Abschlüsse und gelöschter Task-Verlauf;
 - Änderungen an Runnern, Registrierungen (auch abgelehnte Registrierungs-Tokens), Abmeldungen von Runnern und Runner-Meldungen
   mit ungültigem Status;
+- Exporte des Audit-Protokolls als Datei;
 - jeden Serverstart.
 
 Die vollständige Liste finden Sie unter
@@ -114,7 +115,7 @@ aus denen sich Ihre Benutzer verbinden: Jeder dort könnte diese Header auf eine
 
 Ereignisse werden in der Semaphore-Datenbank gespeichert, sodass Ihre üblichen Datenbank-Backups sie
 enthalten.
-Semaphore zeigt Audit-Ereignisse nicht in der Oberfläche an. Standardmäßig behält es jedes Ereignis. Um alte
+Semaphore behält standardmäßig jedes Ereignis. Um alte
 Ereignisse zu löschen, legen Sie eine Aufbewahrungsdauer in Tagen fest:
 
 ```json
@@ -374,6 +375,7 @@ Projekt-Caches und geplante Synchronisierungen von Geheimnisspeichern werden nic
 
 ## Wie geht es weiter {#whats-next}
 
+- [Audit-Protokoll ansehen](/admin-guide/audit-log/view) — Ereignisse in der Weboberfläche lesen, filtern und exportieren.
 - [Audit-Ereignisse](/reference/audit-events) — das Ereignisformat und alle aufgezeichneten Ereignisse.
 - [Konfigurationsoptionen](/reference/configuration#audit-log) — alle `audit.*`-Optionen und Umgebungsvariablen.
 - [Logs](/admin-guide/logs) — Server-, Aktivitäts- und Aufgaben-Logs.

i18n/de/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md

@@ -0,0 +1,31 @@
+---
+title: Audit-Protokoll ansehen
+description: "Das Audit-Protokoll in der Weboberfläche lesen: die neuesten Ereignisse, alle Felder eines Ereignisses und mit Semaphore Pro Filter und Export als CSV oder JSON Lines."
+---
+
+# Audit-Protokoll ansehen
+
+Administratoren öffnen das **Audit log** im Benutzermenü. Die neuesten Ereignisse stehen oben, 50 pro Seite.
+
+![Das Audit-Protokoll, neueste Ereignisse zuerst](/assets/audit-log-list.png)
+
+Klicken Sie auf ein Ereignis, um alle seine Felder zu sehen. Die Schaltfläche zum Kopieren kopiert das Ereignis in
+dem Format, in dem Semaphore es an ein SIEM sendet.
+
+![Ein Ereignis mit allen seinen Feldern](/assets/audit-log-card.png)
+
+## Filtern und exportieren <FeatureState feature="audit-log-filters" /> {#filter-export}
+
+Filtern Sie nach Zeitraum, Benutzer, Ereignisart, Ergebnis, Projekt oder IP-Adresse. In einem Ereignis sind der
+Benutzer, die Adresse, das Objekt und das Projekt Links, die das Protokoll danach filtern.
+
+![Das nach der Adresse eines Ereignisses gefilterte Protokoll](/assets/audit-log-filters.png)
+
+Wenn eine Kombination von Filtern nur wenige Ereignisse findet, sucht Semaphore jeweils etwa zwei Sekunden lang.
+**Older** und **Newer** suchen von selbst weiter, bis sie Ereignisse finden, zeigen, wie weit die Suche gekommen ist,
+und halten mit **Stop** an.
+
+**Export** speichert jedes Ereignis, das zu den Filtern passt, als CSV- oder JSON-Lines-Datei. Jeder Export wird
+als Ereignis `audit.log/export` aufgezeichnet.
+
+![Export als CSV oder JSON Lines](/assets/audit-log-export.png)

i18n/es/docusaurus-plugin-content-docs/current.json

@@ -74,5 +74,9 @@
   "sidebar.tutorialSidebar.category.FAQ": {
     "message": "Preguntas frecuentes",
     "description": "The label for category FAQ in sidebar tutorialSidebar"
+  },
+  "sidebar.tutorialSidebar.category.Audit log": {
+    "message": "Registro de auditoría",
+    "description": "The label for category Audit log in sidebar tutorialSidebar"
   }
 }

i18n/es/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md → i18n/es/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md

@@ -10,8 +10,7 @@ usuario o un rol, quién creó un token de API. Cada evento muestra quién lo hi
 y si funcionó. Úselo para averiguar qué pasó en su instalación o envíe los eventos a su SIEM para tenerlos
 junto al resto de sus registros.
 
-El registro de auditoría está disponible en todas las ediciones. Enviar eventos a un SIEM requiere
-Semaphore Pro.
+El registro de auditoría está disponible en todas las ediciones. Filtrar el registro, exportarlo como archivo y enviar eventos a un SIEM requieren Semaphore Pro.
 
 ## Qué se registra {#recorded-events}
 
@@ -28,6 +27,7 @@ Actualmente Semaphore registra los inicios de sesión y la actividad de las cuen
   finalizaciones y el historial de tareas eliminado;
 - cambios en los runners, registros (incluidos los tokens de registro rechazados), bajas de registro y los informes de los runners
   con un estado no válido;
+- exportaciones del registro de auditoría como archivo;
 - cada arranque del servidor.
 
 Para ver la lista completa, consulte
@@ -116,7 +116,7 @@ dirección en esas cabeceras.
 
 Los eventos se guardan en la base de datos de Semaphore, así que sus copias de seguridad habituales los
 incluyen.
-Semaphore no muestra los eventos de auditoría en la interfaz. De forma predeterminada conserva todos los eventos.
+De forma predeterminada, Semaphore conserva todos los eventos.
 Para eliminar los eventos antiguos, defina un período de retención en días:
 
 ```json
@@ -374,6 +374,7 @@ las vistas, la limpieza de la caché del proyecto ni las sincronizaciones progra
 
 ## Siguientes pasos {#whats-next}
 
+- [Ver el registro de auditoría](/admin-guide/audit-log/view) — leer, filtrar y exportar eventos en la interfaz web.
 - [Eventos de auditoría](/reference/audit-events) — el formato de los eventos y todos los eventos registrados.
 - [Opciones de configuración](/reference/configuration#audit-log) — todas las opciones `audit.*` y variables de entorno.
 - [Registros](/admin-guide/logs) — registros del servidor, de actividad y de tareas.

i18n/es/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md

@@ -0,0 +1,31 @@
+---
+title: Ver el registro de auditoría
+description: "Lea el registro de auditoría en la interfaz web: los eventos más recientes, todos los campos de un evento y, con Semaphore Pro, filtros y exportación a CSV o JSON Lines."
+---
+
+# Ver el registro de auditoría
+
+Los administradores abren **Audit log** desde el menú de usuario. Los eventos más recientes aparecen primero, 50 por página.
+
+![El registro de auditoría, con los eventos más recientes primero](/assets/audit-log-list.png)
+
+Haga clic en un evento para ver todos sus campos. El botón de copiar copia el evento en el formato que Semaphore
+envía a un SIEM.
+
+![Un evento con todos sus campos](/assets/audit-log-card.png)
+
+## Filtrar y exportar <FeatureState feature="audit-log-filters" /> {#filter-export}
+
+Filtre por período, usuario, tipo de evento, resultado, proyecto o dirección IP. En un evento, el usuario, la
+dirección, el objeto y el proyecto son enlaces que filtran el registro por ellos.
+
+![El registro filtrado por la dirección de un evento](/assets/audit-log-filters.png)
+
+Cuando una combinación de filtros encuentra pocos eventos, Semaphore busca unos dos segundos cada vez. **Older** y
+**Newer** siguen buscando por sí mismos hasta encontrar eventos, muestran hasta dónde ha llegado la búsqueda y se
+detienen con **Stop**.
+
+**Export** guarda todos los eventos que cumplen los filtros como un archivo CSV o JSON Lines. Cada exportación se
+registra como un evento `audit.log/export`.
+
+![Exportación como CSV o JSON Lines](/assets/audit-log-export.png)

i18n/fr/docusaurus-plugin-content-docs/current.json

@@ -74,5 +74,9 @@
   "sidebar.tutorialSidebar.category.FAQ": {
     "message": "FAQ",
     "description": "The label for category FAQ in sidebar tutorialSidebar"
+  },
+  "sidebar.tutorialSidebar.category.Audit log": {
+    "message": "Journal d'audit",
+    "description": "The label for category Audit log in sidebar tutorialSidebar"
   }
 }

i18n/fr/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md → i18n/fr/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md

@@ -10,7 +10,7 @@ modifié un utilisateur ou un rôle, qui a créé un jeton d'API. Chaque événe
 depuis quelle adresse et si l'action a réussi. Utilisez-le pour comprendre ce qui s'est passé sur votre
 installation, ou envoyez les événements vers votre SIEM pour les conserver avec le reste de vos journaux.
 
-Le journal d'audit est disponible dans toutes les éditions. L'envoi vers un SIEM nécessite Semaphore Pro.
+Le journal d'audit est disponible dans toutes les éditions. Le filtrage, l'export du journal sous forme de fichier et l'envoi vers un SIEM nécessitent Semaphore Pro.
 
 ## Ce qui est enregistré {#recorded-events}
 
@@ -30,6 +30,7 @@ Semaphore enregistre actuellement les connexions, l'activité des comptes, celle
   fins et historique de tâches supprimé ;
 - modifications des runners, enregistrements (y compris les jetons d'enregistrement refusés), désenregistrements et rapports de runners
   avec un statut invalide ;
+- exports du journal d'audit sous forme de fichier ;
 - chaque démarrage du serveur.
 
 Pour la liste complète, consultez
@@ -118,7 +119,7 @@ pourrait mettre n'importe quelle adresse dans ces en-têtes.
 
 Les événements sont stockés dans la base de données de Semaphore, vos sauvegardes habituelles les incluent
 donc.
-Semaphore n'affiche pas les événements d'audit dans l'interface. Par défaut, il conserve tous les événements. Pour
+Par défaut, Semaphore conserve tous les événements. Pour
 supprimer les anciens événements, définissez une durée de conservation en jours :
 
 ```json
@@ -382,6 +383,7 @@ sont pas enregistrés non plus.
 
 ## Et ensuite {#whats-next}
 
+- [Consulter le journal d'audit](/admin-guide/audit-log/view) — consulter, filtrer et exporter les événements dans l'interface web.
 - [Événements d'audit](/reference/audit-events) — le format des événements et tous les événements enregistrés.
 - [Options de configuration](/reference/configuration#audit-log) — toutes les options `audit.*` et variables d'environnement.
 - [Journaux](/admin-guide/logs) — journaux du serveur, d'activité et des tâches.

i18n/fr/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md

@@ -0,0 +1,31 @@
+---
+title: Consulter le journal d'audit
+description: "Consultez le journal d'audit dans l'interface web : les événements les plus récents, tous les champs d'un événement et, avec Semaphore Pro, les filtres et l'export en CSV ou JSON Lines."
+---
+
+# Consulter le journal d'audit
+
+Les administrateurs ouvrent **Audit log** depuis le menu utilisateur. Les événements les plus récents viennent en premier, 50 par page.
+
+![Le journal d'audit, événements les plus récents en premier](/assets/audit-log-list.png)
+
+Cliquez sur un événement pour voir tous ses champs. Le bouton de copie copie l'événement dans le format que
+Semaphore envoie à un SIEM.
+
+![Un événement avec tous ses champs](/assets/audit-log-card.png)
+
+## Filtrer et exporter <FeatureState feature="audit-log-filters" /> {#filter-export}
+
+Filtrez par période, utilisateur, type d'événement, résultat, projet ou adresse IP. Dans un événement,
+l'utilisateur, l'adresse, l'objet et le projet sont des liens qui filtrent le journal selon eux.
+
+![Le journal filtré par l'adresse d'un événement](/assets/audit-log-filters.png)
+
+Quand une combinaison de filtres trouve peu d'événements, Semaphore cherche environ deux secondes à la fois.
+**Older** et **Newer** continuent de chercher d'eux-mêmes jusqu'à trouver des événements, montrent jusqu'où la
+recherche est allée et s'arrêtent avec **Stop**.
+
+**Export** enregistre tous les événements qui correspondent aux filtres dans un fichier CSV ou JSON Lines. Chaque
+export est enregistré comme un événement `audit.log/export`.
+
+![Export en CSV ou JSON Lines](/assets/audit-log-export.png)

i18n/it/docusaurus-plugin-content-docs/current.json

@@ -74,5 +74,9 @@
   "sidebar.tutorialSidebar.category.FAQ": {
     "message": "FAQ",
     "description": "The label for category FAQ in sidebar tutorialSidebar"
+  },
+  "sidebar.tutorialSidebar.category.Audit log": {
+    "message": "Log di audit",
+    "description": "The label for category Audit log in sidebar tutorialSidebar"
   }
 }

i18n/it/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md → i18n/it/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md

@@ -10,7 +10,7 @@ modificato un utente o un ruolo, chi ha creato un token API. Ogni evento mostra
 quale indirizzo e se l'azione è riuscita. Usalo per capire cosa è successo nella tua installazione, oppure
 invia gli eventi al tuo SIEM per tenerli insieme al resto dei log.
 
-Il log di audit è disponibile in tutte le edizioni. L'invio a un SIEM richiede Semaphore Pro.
+Il log di audit è disponibile in tutte le edizioni. Il filtraggio, l'esportazione come file e l'invio a un SIEM richiedono Semaphore Pro.
 
 ## Cosa viene registrato {#recorded-events}
 
@@ -27,6 +27,7 @@ Attualmente Semaphore registra gli accessi e l'attività di account, progetti e
   completamenti e cronologia dei task eliminata;
 - modifiche ai runner, registrazioni (inclusi i token di registrazione rifiutati), annullamenti della registrazione e report dei runner
   con uno stato non valido;
+- esportazioni del log di audit come file;
 - ogni avvio del server.
 
 Per l'elenco completo, consulta
@@ -114,7 +115,7 @@ indirizzo.
 ## Archiviazione {#storage}
 
 Gli eventi sono salvati nel database di Semaphore, quindi i normali backup del database li includono.
-Semaphore non mostra gli eventi di audit nell'interfaccia. Per impostazione predefinita conserva tutti gli eventi.
+Per impostazione predefinita Semaphore conserva tutti gli eventi.
 Per eliminare i vecchi eventi, imposta un periodo di conservazione in giorni:
 
 ```json
@@ -374,6 +375,7 @@ template, le viste, la pulizia della cache del progetto e le sincronizzazioni pi
 
 ## Prossimi passi {#whats-next}
 
+- [Visualizzare il log di audit](/admin-guide/audit-log/view) — consultare, filtrare ed esportare gli eventi nell'interfaccia web.
 - [Eventi di audit](/reference/audit-events) — il formato degli eventi e tutti gli eventi registrati.
 - [Opzioni di configurazione](/reference/configuration#audit-log) — tutte le opzioni `audit.*` e le variabili d'ambiente.
 - [Log](/admin-guide/logs) — log del server, delle attività e dei task.

i18n/it/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md

@@ -0,0 +1,31 @@
+---
+title: Visualizzare il log di audit
+description: "Consulta il log di audit nell'interfaccia web: gli eventi più recenti, tutti i campi di un evento e, con Semaphore Pro, filtri ed esportazione in CSV o JSON Lines."
+---
+
+# Visualizzare il log di audit
+
+Gli amministratori aprono **Audit log** dal menu utente. Gli eventi più recenti vengono per primi, 50 per pagina.
+
+![Il log di audit, con gli eventi più recenti per primi](/assets/audit-log-list.png)
+
+Fai clic su un evento per vedere tutti i suoi campi. Il pulsante di copia copia l'evento nel formato che
+Semaphore invia a un SIEM.
+
+![Un evento con tutti i suoi campi](/assets/audit-log-card.png)
+
+## Filtrare ed esportare <FeatureState feature="audit-log-filters" /> {#filter-export}
+
+Filtra per periodo, utente, tipo di evento, risultato, progetto o indirizzo IP. In un evento, l'utente,
+l'indirizzo, l'oggetto e il progetto sono link che filtrano il log in base a essi.
+
+![Il log filtrato per l'indirizzo di un evento](/assets/audit-log-filters.png)
+
+Quando una combinazione di filtri trova pochi eventi, Semaphore cerca circa due secondi alla volta. **Older** e
+**Newer** continuano a cercare da soli finché non trovano eventi, mostrano fin dove è arrivata la ricerca e si fermano
+con **Stop**.
+
+**Export** salva tutti gli eventi che corrispondono ai filtri come file CSV o JSON Lines. Ogni esportazione viene
+registrata come evento `audit.log/export`.
+
+![Esportazione come CSV o JSON Lines](/assets/audit-log-export.png)