diff --git a/docs/admin-guide/audit-log.md b/docs/admin-guide/audit-log/README.md similarity index 97% rename from docs/admin-guide/audit-log.md rename to docs/admin-guide/audit-log/README.md index 6646f6de..b353470e 100644 --- a/docs/admin-guide/audit-log.md +++ b/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. diff --git a/docs/admin-guide/audit-log/view.md b/docs/admin-guide/audit-log/view.md new file mode 100644 index 00000000..e6779d33 --- /dev/null +++ b/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 {#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) diff --git a/docs/reference/audit-events.md b/docs/reference/audit-events.md index 8e56bae9..005d64d7 100644 --- a/docs/reference/audit-events.md +++ b/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. diff --git a/i18n/de/docusaurus-plugin-content-docs/current.json b/i18n/de/docusaurus-plugin-content-docs/current.json index 644065c7..3bd8126d 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current.json +++ b/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" } } diff --git a/i18n/de/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md b/i18n/de/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md similarity index 97% rename from i18n/de/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md rename to i18n/de/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md index e5e8a748..14a32078 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md +++ b/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. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md b/i18n/de/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md new file mode 100644 index 00000000..dd140707 --- /dev/null +++ b/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 {#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) diff --git a/i18n/es/docusaurus-plugin-content-docs/current.json b/i18n/es/docusaurus-plugin-content-docs/current.json index 262a1b29..3c0371cd 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current.json +++ b/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" } } diff --git a/i18n/es/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md b/i18n/es/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md similarity index 97% rename from i18n/es/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md rename to i18n/es/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md index 0113b14d..73a8417b 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md +++ b/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. diff --git a/i18n/es/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md b/i18n/es/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md new file mode 100644 index 00000000..e27b4137 --- /dev/null +++ b/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 {#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) diff --git a/i18n/fr/docusaurus-plugin-content-docs/current.json b/i18n/fr/docusaurus-plugin-content-docs/current.json index 21e213c3..7bee4843 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/current.json +++ b/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" } } diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md b/i18n/fr/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md similarity index 97% rename from i18n/fr/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md rename to i18n/fr/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md index b1c23a53..3caf216c 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md +++ b/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. diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md b/i18n/fr/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md new file mode 100644 index 00000000..bf0b6672 --- /dev/null +++ b/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 {#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) diff --git a/i18n/it/docusaurus-plugin-content-docs/current.json b/i18n/it/docusaurus-plugin-content-docs/current.json index 678d1829..5df08100 100644 --- a/i18n/it/docusaurus-plugin-content-docs/current.json +++ b/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" } } diff --git a/i18n/it/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md b/i18n/it/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md similarity index 97% rename from i18n/it/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md rename to i18n/it/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md index 8958556d..3b507145 100644 --- a/i18n/it/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md +++ b/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. diff --git a/i18n/it/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md b/i18n/it/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md new file mode 100644 index 00000000..27530d4c --- /dev/null +++ b/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 {#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) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current.json b/i18n/ja/docusaurus-plugin-content-docs/current.json index 956d6f0d..aaf232a4 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current.json +++ b/i18n/ja/docusaurus-plugin-content-docs/current.json @@ -74,5 +74,9 @@ "sidebar.tutorialSidebar.category.FAQ": { "message": "よくある質問", "description": "The label for category FAQ in sidebar tutorialSidebar" + }, + "sidebar.tutorialSidebar.category.Audit log": { + "message": "監査ログ", + "description": "The label for category Audit log in sidebar tutorialSidebar" } } diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md b/i18n/ja/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md similarity index 97% rename from i18n/ja/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md rename to i18n/ja/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md index 6f22d0f5..1f29b899 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md @@ -7,7 +7,7 @@ description: 監査ログを有効にして Semaphore で誰が何をしたか 監査ログは、Semaphore での重要な操作を記録します。誰がサインインしたか、誰がユーザーやロールを変更したか、誰が API トークンを作成したかなどです。各イベントには、誰が、いつ、どのアドレスから操作し、成功したかどうかが含まれます。インストールで何が起きたかを調べたり、イベントを SIEM に送って他のログと一緒に保管したりできます。 -監査ログはすべてのエディションで利用できます。SIEM へのイベント送信には Semaphore Pro が必要です。 +監査ログはすべてのエディションで利用できます。フィルタリング、ファイルへのエクスポート、SIEM へのイベント送信には Semaphore Pro が必要です。 ## 記録される内容 {#recorded-events} @@ -21,6 +21,7 @@ description: 監査ログを有効にして Semaphore で誰が何をしたか - システム設定の変更と Pro ライセンスの有効化 - タスクの開始とそのトリガー(API、スケジュール、インテグレーション、自動実行、ワークフロー)、承認、停止、完了、削除されたタスク履歴 - ランナーの変更、登録(拒否された登録トークンを含む)、登録解除、無効なステータスのランナーレポート +- 監査ログのファイルへのエクスポート - サーバーの起動 一覧は [監査イベント](/reference/audit-events) を参照してください。 @@ -88,7 +89,7 @@ SEMAPHORE_AUDIT_TRUSTED_PROXY_CIDRS='["10.0.0.0/8"]' ## 保存 {#storage} -イベントは Semaphore のデータベースに保存されるため、通常のデータベースバックアップに含まれます。Semaphore は監査イベントを UI に表示しません。デフォルトではすべてのイベントを保持します。古いイベントを削除するには、保持期間を日数で設定します。 +イベントは Semaphore のデータベースに保存されるため、通常のデータベースバックアップに含まれます。デフォルトではすべてのイベントを保持します。古いイベントを削除するには、保持期間を日数で設定します。 ```json { @@ -309,6 +310,7 @@ UI の一部の操作は記録されません。ライセンスの削除、ア ## 次のステップ {#whats-next} +- [監査ログを表示する](/admin-guide/audit-log/view) — Web UI でイベントを確認、フィルター、エクスポートします。 - [監査イベント](/reference/audit-events) — イベントの形式と、記録されるすべてのイベント。 - [構成オプション](/reference/configuration#audit-log) — すべての `audit.*` オプションと環境変数。 - [ログ](/admin-guide/logs) — サーバー、アクティビティ、タスクのログ。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md b/i18n/ja/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md new file mode 100644 index 00000000..0295d79a --- /dev/null +++ b/i18n/ja/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md @@ -0,0 +1,26 @@ +--- +title: 監査ログを表示する +description: "Web UI で監査ログを確認します。最新のイベント、イベントのすべてのフィールド、Semaphore Pro ではフィルターと CSV または JSON Lines へのエクスポートを使えます。" +--- + +# 監査ログを表示する + +管理者は、ユーザーメニューから **Audit log** を開きます。新しいイベントが先頭に表示され、1 ページに 50 件ずつ表示されます。 + +![新しいイベントが先頭に表示される監査ログ](/assets/audit-log-list.png) + +イベントをクリックすると、そのイベントのすべてのフィールドを確認できます。コピーボタンは、Semaphore が SIEM に送信する形式でイベントをコピーします。 + +![すべてのフィールドを表示したイベント](/assets/audit-log-card.png) + +## フィルタリングとエクスポート {#filter-export} + +期間、ユーザー、イベントの種類、結果、プロジェクト、IP アドレスで絞り込めます。イベント内のユーザー、アドレス、オブジェクト、プロジェクトはリンクになっており、クリックするとそれらでログを絞り込みます。 + +![イベントのアドレスで絞り込んだログ](/assets/audit-log-filters.png) + +フィルターの組み合わせで見つかるイベントが少ない場合、Semaphore は一度に約 2 秒ずつ検索します。**Older** と **Newer** はイベントが見つかるまで自動で検索を続け、どこまで検索したかを表示し、**Stop** で止まります。 + +**Export** は、フィルターに一致するすべてのイベントを CSV または JSON Lines ファイルとして保存します。エクスポートはそのたびに `audit.log/export` イベントとして記録されます。 + +![CSV または JSON Lines でエクスポート](/assets/audit-log-export.png) diff --git a/i18n/ko/docusaurus-plugin-content-docs/current.json b/i18n/ko/docusaurus-plugin-content-docs/current.json index 8a66f161..67a24789 100644 --- a/i18n/ko/docusaurus-plugin-content-docs/current.json +++ b/i18n/ko/docusaurus-plugin-content-docs/current.json @@ -74,5 +74,9 @@ "sidebar.tutorialSidebar.category.FAQ": { "message": "자주 묻는 질문", "description": "The label for category FAQ in sidebar tutorialSidebar" + }, + "sidebar.tutorialSidebar.category.Audit log": { + "message": "감사 로그", + "description": "The label for category Audit log in sidebar tutorialSidebar" } } diff --git a/i18n/ko/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md b/i18n/ko/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md similarity index 97% rename from i18n/ko/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md rename to i18n/ko/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md index a97e6f00..4b696386 100644 --- a/i18n/ko/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md +++ b/i18n/ko/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md @@ -7,7 +7,7 @@ description: 감사 로그를 켜서 Semaphore에서 누가 무엇을 했는지 감사 로그는 Semaphore의 중요한 작업을 기록합니다. 누가 로그인했는지, 누가 사용자나 역할을 변경했는지, 누가 API 토큰을 만들었는지 등입니다. 각 이벤트에는 누가, 언제, 어떤 주소에서 작업했고 성공했는지가 담깁니다. 설치 환경에서 무슨 일이 있었는지 확인하거나, 이벤트를 SIEM으로 보내 다른 로그와 함께 보관할 수 있습니다. -감사 로그는 모든 에디션에서 사용할 수 있습니다. SIEM으로 이벤트를 보내려면 Semaphore Pro가 필요합니다. +감사 로그는 모든 에디션에서 사용할 수 있습니다. 필터링, 파일로 내보내기, SIEM으로 이벤트 보내기에는 Semaphore Pro가 필요합니다. ## 기록되는 내용 {#recorded-events} @@ -21,6 +21,7 @@ description: 감사 로그를 켜서 Semaphore에서 누가 무엇을 했는지 - 시스템 설정 변경과 Pro 라이선스 활성화 - 트리거(API, 일정, 통합, 자동 실행, 워크플로)가 포함된 태스크 시작, 승인, 중지, 완료 및 삭제된 태스크 기록 - 러너 변경, 등록(거부된 등록 토큰 포함), 등록 해제, 잘못된 상태의 러너 보고 +- 감사 로그를 파일로 내보내기 - 서버 시작 전체 목록은 [감사 이벤트](/reference/audit-events)를 참고하세요. @@ -88,7 +89,7 @@ SEMAPHORE_AUDIT_TRUSTED_PROXY_CIDRS='["10.0.0.0/8"]' ## 저장 {#storage} -이벤트는 Semaphore 데이터베이스에 저장되므로 평소의 데이터베이스 백업에 포함됩니다.Semaphore는 감사 이벤트를 UI에 표시하지 않습니다. 기본적으로 모든 이벤트를 보관합니다. 오래된 이벤트를 삭제하려면 보존 기간을 일 단위로 설정하세요. +이벤트는 Semaphore 데이터베이스에 저장되므로 평소의 데이터베이스 백업에 포함됩니다. 기본적으로 모든 이벤트를 보관합니다. 오래된 이벤트를 삭제하려면 보존 기간을 일 단위로 설정하세요. ```json { @@ -309,6 +310,7 @@ UI의 일부 작업은 기록되지 않습니다. 라이선스 제거, 앱 설 ## 다음 단계 {#whats-next} +- [감사 로그 보기](/admin-guide/audit-log/view) — 웹 UI에서 이벤트를 확인하고 필터링하고 내보냅니다. - [감사 이벤트](/reference/audit-events) — 이벤트 형식과 기록되는 모든 이벤트. - [구성 옵션](/reference/configuration#audit-log) — 모든 `audit.*` 옵션과 환경 변수. - [로그](/admin-guide/logs) — 서버, 활동, 작업 로그. diff --git a/i18n/ko/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md b/i18n/ko/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md new file mode 100644 index 00000000..cc84ab89 --- /dev/null +++ b/i18n/ko/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md @@ -0,0 +1,26 @@ +--- +title: 감사 로그 보기 +description: "웹 UI에서 감사 로그를 확인합니다. 최신 이벤트와 이벤트의 모든 필드를 보고, Semaphore Pro에서는 필터와 CSV 또는 JSON Lines 내보내기를 사용할 수 있습니다." +--- + +# 감사 로그 보기 + +관리자는 사용자 메뉴에서 **Audit log**를 엽니다. 최신 이벤트가 먼저 나오고 한 페이지에 50개씩 표시됩니다. + +![최신 이벤트가 먼저 나오는 감사 로그](/assets/audit-log-list.png) + +이벤트를 클릭하면 이벤트의 모든 필드를 볼 수 있습니다. 복사 버튼은 Semaphore가 SIEM으로 보내는 형식으로 이벤트를 복사합니다. + +![모든 필드가 표시된 이벤트](/assets/audit-log-card.png) + +## 필터링과 내보내기 {#filter-export} + +기간, 사용자, 이벤트 종류, 결과, 프로젝트, IP 주소로 필터링할 수 있습니다. 이벤트에서 사용자, 주소, 객체, 프로젝트는 링크이며, 클릭하면 해당 값으로 로그를 필터링합니다. + +![이벤트의 주소로 필터링한 로그](/assets/audit-log-filters.png) + +필터 조합으로 찾은 이벤트가 적으면 Semaphore는 한 번에 약 2초씩 검색합니다. **Older**와 **Newer**는 이벤트를 찾을 때까지 스스로 검색을 계속하고, 검색이 어디까지 진행되었는지 보여 주며, **Stop**으로 멈춥니다. + +**Export**는 필터와 일치하는 모든 이벤트를 CSV 또는 JSON Lines 파일로 저장합니다. 내보내기는 매번 `audit.log/export` 이벤트로 기록됩니다. + +![CSV 또는 JSON Lines로 내보내기](/assets/audit-log-export.png) diff --git a/i18n/pt/docusaurus-plugin-content-docs/current.json b/i18n/pt/docusaurus-plugin-content-docs/current.json index 14eef6b5..17580650 100644 --- a/i18n/pt/docusaurus-plugin-content-docs/current.json +++ b/i18n/pt/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 de auditoria", + "description": "The label for category Audit log in sidebar tutorialSidebar" } } diff --git a/i18n/pt/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md b/i18n/pt/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md similarity index 97% rename from i18n/pt/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md rename to i18n/pt/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md index ad20be38..ed385281 100644 --- a/i18n/pt/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md +++ b/i18n/pt/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md @@ -10,7 +10,7 @@ função, quem criou um token de API. Cada evento mostra quem fez, quando, de qu Use-o para descobrir o que aconteceu na sua instalação ou envie os eventos para o seu SIEM para mantê-los junto com o restante dos seus logs. -O log de auditoria está disponível em todas as edições. Enviar eventos para um SIEM requer o Semaphore Pro. +O log de auditoria está disponível em todas as edições. Filtrar, exportar como arquivo e enviar eventos para um SIEM requerem o Semaphore Pro. ## O que é registrado {#recorded-events} @@ -27,6 +27,7 @@ Atualmente o Semaphore registra entradas e atividades de contas, projetos e tare conclusões e histórico de tarefas excluído; - alterações em runners, registros (incluindo tokens de registro recusados), cancelamentos de registro e relatórios de runners com um status inválido; +- exportações do log de auditoria como arquivo; - cada início do servidor. Para a lista completa, consulte @@ -113,7 +114,7 @@ cabeçalhos. ## Armazenamento {#storage} Os eventos são armazenados no banco de dados do Semaphore, então seus backups normais do banco os incluem. -O Semaphore não mostra eventos de auditoria na interface. Por padrão, ele mantém todos os eventos. Para apagar +Por padrão, o Semaphore mantém todos os eventos. Para apagar eventos antigos, defina um período de retenção em dias: ```json @@ -369,6 +370,7 @@ sincronizações agendadas de armazenamentos de segredos também não são regis ## Próximos passos {#whats-next} +- [Ver o log de auditoria](/admin-guide/audit-log/view) — consultar, filtrar e exportar eventos na interface web. - [Eventos de auditoria](/reference/audit-events) — o formato dos eventos e todos os eventos registrados. - [Opções de configuração](/reference/configuration#audit-log) — todas as opções `audit.*` e variáveis de ambiente. - [Logs](/admin-guide/logs) — logs do servidor, de atividade e de tarefas. diff --git a/i18n/pt/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md b/i18n/pt/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md new file mode 100644 index 00000000..a4ef9d87 --- /dev/null +++ b/i18n/pt/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md @@ -0,0 +1,30 @@ +--- +title: Ver o log de auditoria +description: "Consulte o log de auditoria na interface web: os eventos mais recentes, todos os campos de um evento e, com o Semaphore Pro, filtros e exportação para CSV ou JSON Lines." +--- + +# Ver o log de auditoria + +Os administradores abrem **Audit log** no menu do usuário. Os eventos mais recentes aparecem primeiro, 50 por página. + +![O log de auditoria, com os eventos mais recentes primeiro](/assets/audit-log-list.png) + +Clique em um evento para ver todos os seus campos. O botão de copiar copia o evento no formato que o Semaphore +envia a um SIEM. + +![Um evento com todos os seus campos](/assets/audit-log-card.png) + +## Filtrar e exportar {#filter-export} + +Filtre por período, usuário, tipo de evento, resultado, projeto ou endereço IP. Em um evento, o usuário, o +endereço, o objeto e o projeto são links que filtram o log por eles. + +![O log filtrado pelo endereço de um evento](/assets/audit-log-filters.png) + +Quando uma combinação de filtros encontra poucos eventos, o Semaphore busca cerca de dois segundos por vez. **Older** e +**Newer** continuam buscando sozinhos até encontrar eventos, mostram até onde a busca chegou e param com **Stop**. + +**Export** salva todos os eventos que correspondem aos filtros como um arquivo CSV ou JSON Lines. Cada exportação +é registrada como um evento `audit.log/export`. + +![Exportação como CSV ou JSON Lines](/assets/audit-log-export.png) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current.json b/i18n/ru/docusaurus-plugin-content-docs/current.json index cb479cfb..416214a4 100644 --- a/i18n/ru/docusaurus-plugin-content-docs/current.json +++ b/i18n/ru/docusaurus-plugin-content-docs/current.json @@ -74,5 +74,9 @@ "sidebar.tutorialSidebar.category.FAQ": { "message": "Частые вопросы", "description": "The label for category FAQ in sidebar tutorialSidebar" + }, + "sidebar.tutorialSidebar.category.Audit log": { + "message": "Журнал аудита", + "description": "The label for category Audit log in sidebar tutorialSidebar" } } diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md b/i18n/ru/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md similarity index 97% rename from i18n/ru/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md rename to i18n/ru/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md index 4f87eb02..77300964 100644 --- a/i18n/ru/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md +++ b/i18n/ru/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md @@ -10,7 +10,7 @@ description: Включите журнал аудита, чтобы видеть получилось ли. С его помощью можно выяснить, что произошло в вашей установке, или отправлять события в SIEM, чтобы они хранились рядом с остальными журналами. -Журнал аудита есть во всех редакциях. Для отправки событий в SIEM нужен Semaphore Pro. +Журнал аудита есть во всех редакциях. Для фильтрации, экспорта в файл и отправки событий в SIEM нужен Semaphore Pro. ## Что записывается {#recorded-events} @@ -27,6 +27,7 @@ description: Включите журнал аудита, чтобы видеть завершения и удалённую историю задач; - изменения раннеров, регистрации (включая отклонённые токены регистрации), отмены регистрации и отчёты раннеров с недопустимым статусом; +- экспорт журнала аудита в файл; - каждый запуск сервера. Полный список — на странице @@ -110,7 +111,7 @@ SEMAPHORE_AUDIT_TRUSTED_PROXY_CIDRS='["10.0.0.0/8"]' ## Хранение {#storage} События хранятся в базе данных Semaphore, поэтому обычные резервные копии базы их включают. -Semaphore не показывает события аудита в интерфейсе. По умолчанию он хранит все события. Чтобы удалять старые +По умолчанию Semaphore хранит все события. Чтобы удалять старые события, задайте срок хранения в днях: ```json @@ -364,6 +365,7 @@ encoding.codec = "json" ## Что дальше {#whats-next} +- [Просмотр журнала аудита](/admin-guide/audit-log/view) — просмотр, фильтры и выгрузка событий в веб-интерфейсе. - [События аудита](/reference/audit-events) — формат событий и все записываемые события. - [Параметры конфигурации](/reference/configuration#audit-log) — все параметры `audit.*` и переменные окружения. - [Журналы](/admin-guide/logs) — серверный журнал, журнал активности и журналы задач. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md b/i18n/ru/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md new file mode 100644 index 00000000..fc511823 --- /dev/null +++ b/i18n/ru/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md @@ -0,0 +1,30 @@ +--- +title: Просмотр журнала аудита +description: "Просмотр журнала аудита в веб-интерфейсе: последние события, все поля события, а в Semaphore Pro — фильтры и выгрузка в CSV или JSON Lines." +--- + +# Просмотр журнала аудита + +Администраторы открывают **Audit log** из меню пользователя. Новые события идут первыми, по 50 на странице. + +![Журнал аудита, новые события первыми](/assets/audit-log-list.png) + +Нажмите на событие, чтобы увидеть все его поля. Кнопка копирования копирует событие в формате, в котором +Semaphore отправляет его в SIEM. + +![Событие со всеми полями](/assets/audit-log-card.png) + +## Фильтрация и экспорт {#filter-export} + +Фильтруйте по периоду, пользователю, виду события, результату, проекту или IP-адресу. В событии пользователь, +адрес, объект и проект являются ссылками, которые фильтруют журнал по ним. + +![Журнал, отфильтрованный по адресу события](/assets/audit-log-filters.png) + +Когда сочетание фильтров находит мало событий, Semaphore ищет примерно по две секунды за раз. **Older** и **Newer** +сами продолжают поиск, пока не найдут события, показывают, докуда дошёл поиск, и останавливаются кнопкой **Stop**. + +**Export** сохраняет все события, подходящие под фильтры, в файл CSV или JSON Lines. Каждый экспорт +записывается как событие `audit.log/export`. + +![Экспорт в CSV или JSON Lines](/assets/audit-log-export.png) diff --git a/i18n/sr/docusaurus-plugin-content-docs/current.json b/i18n/sr/docusaurus-plugin-content-docs/current.json index 7d264ab2..015c157e 100644 --- a/i18n/sr/docusaurus-plugin-content-docs/current.json +++ b/i18n/sr/docusaurus-plugin-content-docs/current.json @@ -74,5 +74,9 @@ "sidebar.tutorialSidebar.category.FAQ": { "message": "Česta pitanja", "description": "The label for category FAQ in sidebar tutorialSidebar" + }, + "sidebar.tutorialSidebar.category.Audit log": { + "message": "Dnevnik revizije", + "description": "The label for category Audit log in sidebar tutorialSidebar" } } diff --git a/i18n/sr/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md b/i18n/sr/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md similarity index 97% rename from i18n/sr/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md rename to i18n/sr/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md index 0768e799..db7a24ed 100644 --- a/i18n/sr/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md +++ b/i18n/sr/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md @@ -10,7 +10,7 @@ napravio API token. Svaki događaj pokazuje ko je to uradio, kada, sa koje adres Koristite ga da saznate šta se desilo u vašoj instalaciji ili šaljite događaje u svoj SIEM da budu uz ostale dnevnike. -Dnevnik revizije je dostupan u svim izdanjima. Za slanje događaja u SIEM potreban je Semaphore Pro. +Dnevnik revizije je dostupan u svim izdanjima. Za filtriranje, izvoz u datoteku i slanje događaja u SIEM potreban je Semaphore Pro. ## Šta se beleži {#recorded-events} @@ -27,6 +27,7 @@ Semaphore trenutno beleži prijave, aktivnost naloga, projekata i zadataka: završetke i obrisanu istoriju zadataka; - promene runner-a, registracije (uključujući odbijene registracione tokene), odjave i izveštaje runner-a sa nevažećim statusom; +- izvoz dnevnika revizije u datoteku; - svako pokretanje servera. Kompletna lista je na stranici @@ -110,7 +111,7 @@ povezuju vaši korisnici: bilo ko u njima mogao bi da upiše bilo koju adresu u ## Čuvanje {#storage} Događaji se čuvaju u bazi podataka Semaphore-a, pa ih vaše uobičajene rezervne kopije baze sadrže. -Semaphore ne prikazuje događaje revizije u interfejsu. Podrazumevano čuva sve događaje. Da biste brisali stare +Podrazumevano Semaphore čuva sve događaje. Da biste brisali stare događaje, podesite period čuvanja u danima: ```json @@ -367,6 +368,7 @@ Opisi šablona, prikazi, brisanje keša projekta i zakazane sinhronizacije sklad ## Šta dalje {#whats-next} +- [Pregled dnevnika revizije](/admin-guide/audit-log/view) — pregled, filtriranje i izvoz događaja u veb interfejsu. - [Događaji revizije](/reference/audit-events) — format događaja i svi događaji koji se beleže. - [Opcije konfiguracije](/reference/configuration#audit-log) — sve `audit.*` opcije i promenljive okruženja. - [Dnevnici](/admin-guide/logs) — dnevnici servera, aktivnosti i zadataka. diff --git a/i18n/sr/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md b/i18n/sr/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md new file mode 100644 index 00000000..e127e049 --- /dev/null +++ b/i18n/sr/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md @@ -0,0 +1,31 @@ +--- +title: Pregled dnevnika revizije +description: "Pregled dnevnika revizije u veb interfejsu: najnoviji događaji, sva polja događaja i, uz Semaphore Pro, filteri i izvoz u CSV ili JSON Lines." +--- + +# Pregled dnevnika revizije + +Administratori otvaraju **Audit log** iz korisničkog menija. Najnoviji događaji su prvi, po 50 na stranici. + +![Dnevnik revizije, najnoviji događaji prvi](/assets/audit-log-list.png) + +Kliknite na događaj da vidite sva njegova polja. Dugme za kopiranje kopira događaj u formatu u kojem ga +Semaphore šalje u SIEM. + +![Događaj sa svim svojim poljima](/assets/audit-log-card.png) + +## Filtriranje i izvoz {#filter-export} + +Filtrirajte po periodu, korisniku, vrsti događaja, rezultatu, projektu ili IP adresi. U događaju su korisnik, +adresa, objekat i projekat veze koje filtriraju dnevnik po njima. + +![Dnevnik filtriran po adresi događaja](/assets/audit-log-filters.png) + +Kada kombinacija filtera pronađe malo događaja, Semaphore pretražuje otprilike po dve sekunde. **Older** i **Newer** +sami nastavljaju pretragu dok ne pronađu događaje, prikazuju dokle je pretraga stigla i zaustavljaju se dugmetom +**Stop**. + +**Export** čuva svaki događaj koji odgovara filterima kao CSV ili JSON Lines datoteku. Svaki izvoz se beleži kao +događaj `audit.log/export`. + +![Izvoz kao CSV ili JSON Lines](/assets/audit-log-export.png) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current.json b/i18n/zh/docusaurus-plugin-content-docs/current.json index 0f3d2390..837c2275 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current.json +++ b/i18n/zh/docusaurus-plugin-content-docs/current.json @@ -74,5 +74,9 @@ "sidebar.tutorialSidebar.category.FAQ": { "message": "常见问题", "description": "The label for category FAQ in sidebar tutorialSidebar" + }, + "sidebar.tutorialSidebar.category.Audit log": { + "message": "审计日志", + "description": "The label for category Audit log in sidebar tutorialSidebar" } } diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md b/i18n/zh/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md similarity index 97% rename from i18n/zh/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md rename to i18n/zh/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md index 60140c25..99eb0945 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/admin-guide/audit-log.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/admin-guide/audit-log/README.md @@ -7,7 +7,7 @@ description: 启用审计日志，查看谁在 Semaphore 中做了什么，并 审计日志记录 Semaphore 中的重要操作：谁登录了，谁修改了用户或角色，谁创建了 API 令牌。每个事件都会显示操作者、时间、来源地址以及操作是否成功。你可以用它来了解安装中发生了什么，也可以把事件发送到 SIEM，与其他日志放在一起。 -所有版本都提供审计日志。将事件发送到 SIEM 需要 Semaphore Pro。 +所有版本都提供审计日志。筛选、导出为文件以及将事件发送到 SIEM 需要 Semaphore Pro。 ## 记录的内容 {#recorded-events} @@ -21,6 +21,7 @@ description: 启用审计日志，查看谁在 Semaphore 中做了什么，并 - 系统设置的更改和 Pro 许可证的激活； - 任务启动及其触发方式(API、计划任务、集成、自动运行、工作流)、审批、停止、完成以及已删除的任务历史； - 运行器的更改、注册(包括被拒绝的注册令牌)、取消注册，以及状态无效的运行器报告； +- 将审计日志导出为文件； - 每次服务器启动。 完整列表请参阅 [审计事件](/reference/audit-events)。 @@ -88,7 +89,7 @@ SEMAPHORE_AUDIT_TRUSTED_PROXY_CIDRS='["10.0.0.0/8"]' ## 存储 {#storage} -事件存储在 Semaphore 数据库中，因此常规的数据库备份会包含它们。Semaphore 不会在界面中显示审计事件。默认情况下，它会保留所有事件。若要删除旧事件，请以天为单位设置保留期限： +事件存储在 Semaphore 数据库中，因此常规的数据库备份会包含它们。默认情况下，Semaphore 会保留所有事件。若要删除旧事件，请以天为单位设置保留期限： ```json { @@ -309,6 +310,7 @@ encoding.codec = "json" ## 后续步骤 {#whats-next} +- [查看审计日志](/admin-guide/audit-log/view) — 在 Web 界面中查看、筛选和导出事件。 - [审计事件](/reference/audit-events) — 事件格式以及所有记录的事件。 - [配置选项](/reference/configuration#audit-log) — 所有 `audit.*` 选项和环境变量。 - [日志](/admin-guide/logs) — 服务器日志、活动日志和任务日志。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md b/i18n/zh/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md new file mode 100644 index 00000000..e3c181f5 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/admin-guide/audit-log/view.md @@ -0,0 +1,26 @@ +--- +title: 查看审计日志 +description: "在 Web 界面中查看审计日志：最新事件、事件的全部字段，以及 Semaphore Pro 中的筛选和导出为 CSV 或 JSON Lines。" +--- + +# 查看审计日志 + +管理员从用户菜单打开 **Audit log**。最新的事件排在最前面，每页 50 条。 + +![审计日志，最新事件在前](/assets/audit-log-list.png) + +点击某个事件可查看它的所有字段。复制按钮会按 Semaphore 发送到 SIEM 的格式复制该事件。 + +![显示全部字段的事件](/assets/audit-log-card.png) + +## 筛选和导出 {#filter-export} + +可以按时间段、用户、事件类型、结果、项目或 IP 地址筛选。在事件中，用户、地址、对象和项目都是链接，点击后会按它们筛选日志。 + +![按某个事件的地址筛选的日志](/assets/audit-log-filters.png) + +当一组筛选条件找到的事件很少时，Semaphore 每次搜索大约两秒。**Older** 和 **Newer** 会自动继续搜索，直到找到事件，显示搜索进行到哪里，并可通过 **Stop** 停止。 + +**Export** 会把符合筛选条件的所有事件保存为 CSV 或 JSON Lines 文件。每次导出都会记录为一个 `audit.log/export` 事件。 + +![导出为 CSV 或 JSON Lines](/assets/audit-log-export.png) diff --git a/sidebars.js b/sidebars.js index c43ff2c4..085f67dc 100644 --- a/sidebars.js +++ b/sidebars.js @@ -130,7 +130,14 @@ const sidebars = { 'admin-guide/cicd', 'admin-guide/runners', 'admin-guide/logs', - 'admin-guide/audit-log', + { + type: 'category', + label: 'Audit log', + link: { type: 'doc', id: 'admin-guide/audit-log/README' }, + items: [ + 'admin-guide/audit-log/view', + ], + }, 'admin-guide/metrics', { type: 'doc', id: 'admin-guide/ha', customProps: { edition: 'enterprise' } }, 'admin-guide/license', diff --git a/src/data/editions.js b/src/data/editions.js index b031a322..14f9989a 100644 --- a/src/data/editions.js +++ b/src/data/editions.js @@ -134,6 +134,12 @@ const features = [ edition: 'pro', doc: '/admin-guide/audit-log#siem-export', }, + { + key: 'audit-log-filters', + name: 'Audit log filters and export', + edition: 'pro', + doc: '/admin-guide/audit-log/view#filter-export', + }, // Terraform { diff --git a/static/assets/audit-log-card.png b/static/assets/audit-log-card.png new file mode 100644 index 00000000..fde3b92b Binary files /dev/null and b/static/assets/audit-log-card.png differ diff --git a/static/assets/audit-log-export.png b/static/assets/audit-log-export.png new file mode 100644 index 00000000..7620820f Binary files /dev/null and b/static/assets/audit-log-export.png differ diff --git a/static/assets/audit-log-filters.png b/static/assets/audit-log-filters.png new file mode 100644 index 00000000..5360eb38 Binary files /dev/null and b/static/assets/audit-log-filters.png differ diff --git a/static/assets/audit-log-list.png b/static/assets/audit-log-list.png new file mode 100644 index 00000000..0ed07a5f Binary files /dev/null and b/static/assets/audit-log-list.png differ