{"id":20504106,"url":"https://github.com/icinga/icingaweb2-module-audit","last_synced_at":"2025-04-13T20:48:01.850Z","repository":{"id":44986109,"uuid":"129900243","full_name":"Icinga/icingaweb2-module-audit","owner":"Icinga","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-15T08:57:34.000Z","size":33,"stargazers_count":11,"open_issues_count":9,"forks_count":6,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-13T20:47:50.325Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Icinga.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-17T12:21:00.000Z","updated_at":"2022-07-13T06:59:07.000Z","dependencies_parsed_at":"2024-11-15T19:36:38.146Z","dependency_job_id":"6b558e89-dcac-4ab0-931e-c2284fab8d1f","html_url":"https://github.com/Icinga/icingaweb2-module-audit","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icinga%2Ficingaweb2-module-audit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icinga%2Ficingaweb2-module-audit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icinga%2Ficingaweb2-module-audit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icinga%2Ficingaweb2-module-audit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Icinga","download_url":"https://codeload.github.com/Icinga/icingaweb2-module-audit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248782279,"owners_count":21160716,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T19:36:27.619Z","updated_at":"2025-04-13T20:48:01.844Z","avatar_url":"https://github.com/Icinga.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Audit module for Icinga Web 2\n\n#### Table of Contents\n\n1. [About](#about)\n2. [License](#license)\n3. [Support](#support)\n4. [Requirements](#requirements)\n5. [Installation](#installation)\n6. [Configuration](#configuration)\n\n## About\n\n## License\n\nIcinga Web 2 and this Icinga Web 2 module are licensed under the terms of the GNU General Public License Version 2,\nyou will find a copy of this license in the LICENSE file included in the source package.\n\n## Support\n\nJoin the [Icinga community channels](https://www.icinga.com/community/get-involved/) for questions.\n\n## Requirements\n\n* [Icinga Web 2](https://www.icinga.com/products/icinga-web-2/) (\u003e= 2.6.0)\n\n## Installation\n\nExtract this module to your Icinga Web 2 modules directory as `audit` directory.\n\nGit clone:\n\n    cd /usr/share/icingaweb2/modules\n    git clone https://github.com/Icinga/icingaweb2-module-audit.git audit\n\nTarball download (latest [release](https://github.com/Icinga/icingaweb2-module-audit/releases/latest)):\n\n    cd /usr/share/icingaweb2/modules\n    wget https://github.com/Icinga/icingaweb2-module-audit/archive/v1.0.0.zip\n    unzip v1.0.0.zip\n    mv icingaweb2-module-audit-1.0.0 audit\n\n### Enable Icinga Web 2 module\n\nEnable the module in the Icinga Web 2 frontend in `Configuration -\u003e Modules -\u003e audit -\u003e enable`.\nYou can also enable the module by using the `icingacli` command:\n\n    icingacli module enable audit\n\n## Configuration\n\nBy default the audit module does not log anything. Its logging facilities need to be configured first.\n\nThere are currently two choices:\n\n* Standard Log\n* JSON Log\n\n### Standard Log\n\nThe standard log is a normal log with human readable messages. It's possible to log to a file and to syslog.\nThe configuration view in the frontend is located here: `Configuration -\u003e Modules -\u003e audit -\u003e Configuration`\n\n\u003e **Note**\n\u003e\n\u003e When logging to a file and with the proper permission, this can be viewed in the frontend under `Reporting -\u003e Audit Log`\n\n### JSON Log\n\nThe JSON log is supposed to be consumed by other applications. It writes one JSON object per line to a file.\n\nThese objects have the following properties:\n\n* `activity_time`  \n    A unix timestamp specifying when the activity occurred.\n* `activity`  \n    An arbitrary identifier specifying the type of activity.\n* `identity`  \n    An arbitrary name identifying the responsible subject.\n* `message`  \n    A human readable message. This is the same that appears in the standard log.\n* `data` *(may be absent)*  \n    An arbitrary number of additional properties dependent on the type of activity.\n\nPlease see the documentation of the type of activity for more details. ([Icinga Web 2 activities](https://www.icinga.com/docs/icingaweb2/latest/doc/15-Auditing/))\n\nAn example for *Filebeat* how this log may be consumed can be found [here](https://www.elastic.co/blog/structured-logging-filebeat).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficinga%2Ficingaweb2-module-audit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficinga%2Ficingaweb2-module-audit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficinga%2Ficingaweb2-module-audit/lists"}