{"id":13579346,"url":"https://github.com/rflament/loggedfs","last_synced_at":"2025-04-05T20:33:56.159Z","repository":{"id":11413591,"uuid":"69596777","full_name":"rflament/loggedfs","owner":"rflament","description":"LoggedFS - Filesystem monitoring with Fuse","archived":false,"fork":false,"pushed_at":"2022-12-30T00:37:36.000Z","size":831,"stargazers_count":123,"open_issues_count":7,"forks_count":28,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-11-05T17:49:36.313Z","etag":null,"topics":["filesystem","filesystem-monitoring","fuse","loggedfs","logging","monitoring"],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rflament.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}},"created_at":"2016-09-29T18:38:56.000Z","updated_at":"2024-11-03T03:38:45.000Z","dependencies_parsed_at":"2023-01-11T18:06:22.804Z","dependency_job_id":null,"html_url":"https://github.com/rflament/loggedfs","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rflament%2Floggedfs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rflament%2Floggedfs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rflament%2Floggedfs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rflament%2Floggedfs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rflament","download_url":"https://codeload.github.com/rflament/loggedfs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247399876,"owners_count":20932876,"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":["filesystem","filesystem-monitoring","fuse","loggedfs","logging","monitoring"],"created_at":"2024-08-01T15:01:38.533Z","updated_at":"2025-04-05T20:33:51.144Z","avatar_url":"https://github.com/rflament.png","language":"C++","funding_links":[],"categories":["\u003ca name=\"cpp\"\u003e\u003c/a\u003eC++"],"sub_categories":[],"readme":"# LoggedFS - Filesystem monitoring with Fuse\n\n[![Build Status](https://travis-ci.org/rflament/loggedfs.svg?branch=feature%2Feasylogging%2B%2B)](https://travis-ci.org/rflament/loggedfs)\n\nDonate Ethereum: 0xd13338639d2d3eCeBea0B53C8E4C9085aa21Ccb2\n\n## Description\n\nLoggedFS is a [FUSE](https://en.wikipedia.org/wiki/Filesystem_in_Userspace)-based filesystem which can log every operations that happens in it.\n\n### How does it work ?\n\nFUSE does almost everything. LoggedFS only sends a message to syslog when called by FUSE and then let the real filesystem do the rest of the job.\n\n## Installation\n\nIf LoggedFS 0.9 is included in your distribution you can just install with your package manager:\n\n    sudo apt-get install loggedfs\n\n## Simplest usage\n\nTo record access to `/tmp/TEST` into `~/log.txt`, just do:\n\n    loggedfs -l ~/log.txt /tmp/TEST\n\nTo stop recording, just `unmount` as usual:\n\n    sudo umount /tmp/TEST\n\nThe `~/log.txt` file will need to be changed to readable by setting permissions:\n\n    chmod 0666 ~/log.txt\n\n## Installation from source\n\nFirst you have to make sure that FUSE is installed on your computer.\nIf you have a recent distribution it should be. FUSE can be downloaded here: [github.com/libfuse/libfuse](https://github.com/libfuse/libfuse).\n\nThen you should download the LoggedFS source code archive and install it with the `make` command:\n\n    sudo apt-get install libfuse-dev libxml2-dev libpcre2-dev\n    wget https://github.com/rflament/loggedfs/archive/loggedfs-0.X.tar.gz\n    tar xfz loggedfs-0.X.tar.gz\n    cd loggedfs-loggedfs-0.X\n    make\n    make install\n\nLoggedFS has the following dependencies:\n\n    fuse\n    pcre2\n    libxml2\n\n## Configuration\n\nLoggedFS can use an XML configuration file if you want it to log operations only for certain files, for certain users, or for certain operations.\n\nHere is a sample configuration file :\n\n    \u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n\n    \u003cloggedFS logEnabled=\"true\" printProcessName=\"true\"\u003e\n      \u003cincludes\u003e\n        \u003cinclude extension=\".*\" uid=\"*\" action=\".*\" retname=\".*\"/\u003e\n      \u003c/includes\u003e\n      \u003cexcludes\u003e\n        \u003cexclude extension=\".*\\.bak$\" uid=\"*\" action=\".*\" retname=\"SUCCESS\"/\u003e\n        \u003cexclude extension=\".*\" uid=\"1000\" action=\".*\" retname=\"FAILURE\"/\u003e\n        \u003cexclude extension=\".*\" uid=\"*\" action=\"getattr\" retname=\".*\"/\u003e\n      \u003c/excludes\u003e\n    \u003c/loggedFS\u003e\n\nThis configuration can be used to log everything except it if concerns a `*.bak` file, or if the uid is 1000, or if the operation is `getattr`.\n\n## Launching LoggedFS\n\nIf you just want to test LoggedFS you don't need any configuration file.\n\nJust use that command:\n\n    loggedfs -f -p /var\n\nYou should see logs like these :\n\n    tail -f /var/log/syslog\n    2018-03-21 15:32:14,095 INFO [default] LoggedFS not running as a daemon\n    2018-03-21 15:32:14,095 INFO [default] LoggedFS running as a public filesystem\n    2018-03-21 15:32:14,095 INFO [default] LoggedFS starting at /var.\n    2018-03-21 15:32:14,095 INFO [default] chdir to /var\n    2018-03-21 15:32:15,375 INFO [default] getattr /var/ {SUCCESS} [ pid = 934 /usr/sbin/VBoxService uid = 0 ]\n    2018-03-21 15:32:15,375 INFO [default] getattr /var/run {SUCCESS} [ pid = 934 /usr/sbin/VBoxService uid = 0 ]\n    2018-03-21 15:32:15,376 INFO [default] readlink /var/run {SUCCESS} [ pid = 934 /usr/sbin/VBoxService uid = 0 ]\n    2018-03-21 15:32:15,376 INFO [default] readlink /var/run {SUCCESS} [ pid = 934 /usr/sbin/VBoxService uid = 0 ]\n    2018-03-21 15:32:15,890 INFO [default] getattr /var/cache {SUCCESS} [ pid = 1539 update-notifier uid = 1000 ]\n    2018-03-21 15:32:15,891 INFO [default] getattr /var/cache/apt {SUCCESS} [ pid = 1539 update-notifier uid = 1000 ]\n    2018-03-21 15:32:15,891 INFO [default] getattr /var/cache/apt/archives {SUCCESS} [ pid = 1539 update-notifier uid = 1000 ]\n    2018-03-21 15:32:15,891 INFO [default] getattr /var/cache/apt/archives/partial {SUCCESS} [ pid = 1539 update-notifier uid = 1000 ]\n    2018-03-21 15:32:15,891 INFO [default] getattr /var/cache/apt/archives/partial {SUCCESS} [ pid = 1539 update-notifier uid = 1000 ]\n    2018-03-21 15:32:15,892 INFO [default] getattr /var/lib {SUCCESS} [ pid = 1539 update-notifier uid = 1000 ]\n    2018-03-21 15:32:15,892 INFO [default] getattr /var/lib/apt {SUCCESS} [ pid = 1539 update-notifier uid = 1000 ]\n    2018-03-21 15:32:15,892 INFO [default] getattr /var/lib/apt/lists {SUCCESS} [ pid = 1539 update-notifier uid = 1000 ]\n    2018-03-21 15:32:15,892 INFO [default] getattr /var/lib/apt/lists/partial {SUCCESS} [ pid = 1539 update-notifier uid = 1000 ]\n    2018-03-21 15:32:15,892 INFO [default] getattr /var/lib/apt/lists/partial {SUCCESS} [ pid = 1539 update-notifier uid = 1000 ]\n    2018-03-21 15:32:17,873 INFO [default] LoggedFS closing.\n\nIf you have a configuration file to use you should use this command:\n\n    ./loggedfs -c loggedfs.xml -p /var\n\nIf you want to log what other users do on your filesystem, you should use the `-p` option to allow them to see your mounted files. For a complete documentation see the manual page.\n\nRémi Flament - remipouak at gmail.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frflament%2Floggedfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frflament%2Floggedfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frflament%2Floggedfs/lists"}