{"id":29840575,"url":"https://github.com/graphform/munin","last_synced_at":"2026-01-24T04:36:27.025Z","repository":{"id":97910092,"uuid":"546985640","full_name":"graphform/munin","owner":"graphform","description":"A continuous analyzer of r/WhatsThisBird activity","archived":false,"fork":false,"pushed_at":"2024-09-01T18:18:44.000Z","size":885,"stargazers_count":1,"open_issues_count":2,"forks_count":2,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-07-29T14:59:21.925Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","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/graphform.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":"2022-10-07T00:57:27.000Z","updated_at":"2025-06-20T22:17:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"1631c3d5-2fe6-45c4-818f-f7d4bd652caf","html_url":"https://github.com/graphform/munin","commit_stats":null,"previous_names":["graphform/munin"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/graphform/munin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fmunin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fmunin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fmunin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fmunin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/graphform","download_url":"https://codeload.github.com/graphform/munin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fmunin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28711672,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T23:51:44.727Z","status":"online","status_checked_at":"2026-01-24T02:00:06.909Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-07-29T14:16:42.415Z","updated_at":"2026-01-24T04:36:26.995Z","avatar_url":"https://github.com/graphform.png","language":"Java","readme":"# munin\n\nA _stateful_, _distributable_, _real-time_ (aside from some mandated polling),\n_highly observable_ data-streaming web service that _continuously_ analyzes\nr/WhatsThisBird activity. `munin`'s primary responsibility within the overall\n`FileTheseBirds` application is to generate community-vouched deductions to be\npersisted to a database, but it also doubles as a [Reddit bot that leaves a\ncomment trail](https://reddit.com/user/FileTheseBirdsBot/comments) of its\ninternal state.\n\n`munin`'s runtime is a [Swim server](https://github.com/swimos/swim), and we\nrely entirely on the Swim platform to achieve the italicized properties. The\nsource code and documentation here is mostly driver- and \"business\nlogic\"-focused; refer to Swim's guides if you wish to learn more about the\nruntime.\n\nA public instance of `munin` is available at `munin.swim.services` over both\nthe secure `warps` and the `warp` protocols.\n\n## Prerequisites\n\n1. JDK 11+\n2. A Reddit account with access to a\n[script-type application](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example#first-steps)\n3. A `src/main/resources/reddit-config.properties` file that looks like:\n    ```text\n    clientId=p-jcoLKBynTLew\n    clientSecret=gko_LXELoV07ZBNUXrvWZfzE3aI\n    redditUser=reddit_bot\n    redditPass=snoo\n    userAgent=FileTheseBirds/0.1.0 by reddit_bot\n    ```\n    All credentials above are fake, copied from the linked tutorial. \n4. A 2-column `src/main/resources/ebird-taxa.csv` file, where each row's first\ncolumn indicates an eBird taxonomy code, and the second column is the desired\ncommon name for that code. If we use US-locale English common names, then the\nfirst several rows will look like:\n    ```\n    ostric2,Common Ostrich\n    ostric3,Somali Ostrich\n    y00934,Common/Somali Ostrich\n    grerhe1,Greater Rhea\n    lesrhe2,Lesser Rhea\n    ```\n5. A `src/main/resources/reviewers.txt` file containing the _lowercase_\nusernames of reviewer-privileged Reddit accounts\n6. A `src/main/resources/nonparticipants.txt` file containing the _lowercase_\nusernames of accounts whose posts/comments should never be analyzed\n\nTODO:\n- Offer alternative config options to resource files\n- We may eventually offer a `readonly` mode that hits `www.reddit.com` instead of\n`oauth.reddit.com`. Such a mode doesn't require prerequisites 2 and 3 but has\ntwo restrictions:\n    - No ability to post Reddit comments\n    - Far stricter rate limitations.\n\n## Build Instructions\n\n[Gradle](https://gradle.org/) 7+ is required to build `munin` from source. You\nmay  use the provided wrapper scripts to circumvent manually installing Gradle\non your machine, e.g.\n```text\n./gradlew build\n```\non Unix-like systems, and\n```text\n.\\gradlew.bat build\n```\non default Windows shells.\n\n## Run Instructions\n\n### Option 1: `gradle run`\n\nor `./gradlew run` / `.\\gradlew.bat run` if using the wrapper scripts. Incurs\noverhead due to management by a Gradle daemon.\n\n### Option 2: `gradle build` with command line runner\n\nPrerequisite: a way to either untar or unzip an archive\n\n1. Run one of the aforementioned `build` commands\n2. Unpack your distributable of choice from `build/distributions`, (either the\ntarball or the .zip)\n3. Run the appropriate script for your device from `$UNPACK-DIR/bin`.\n\n### Option 3: journaled service (Linux only)\n\nPrerequisites: `dpkg`, `service`\n\n1. `gradle packageDeb` (or a wrapper script variant)\n2. `sudo dpkg -i build/distributions/munin-$VERSION_all.deb`\n3. `sudo service munin start`\n\n### Configurations\n\nTODO as this project matures\n\n## Available WARP APIs\n\n`munin` exposes several streaming endpoints via its Web Agents. Below, we list\nthe ones that you are most likely to find useful. `munin` delivers only the last\n36 hours worth of r/WhatsThisBird activity in all of these APIs, but will be\nprocessing far more than that under the hood.\n\nWe use `swim-cli` commands in the following examples for simplicity; these may\njust as easily be translated into downlinks. Be sure to replace\n`warps://munin.swim.services` with the host under which your `munin` instance\nruns, e.g. `warp://localhost:9001`.\n\n### Statuses of all posts\n\nIn the context of this API, the \"status\" of a submission is defined to be a\nflattened union of its info and (if it's nonempty) in-progress answer.\n\n```\n% swim-cli sync -h warps://munin.swim.services -n /submissions -l statuses\n\n@update(key:\"/submission/xwgwh6\")@status{id:xwgwh6,title:\"What species are these? In eastern washingon and I saw one jump\",location:\"north america\",thumbnail:\"https://b.thumbs.redditmedia.com/svwmIdeX0vhhgUT_sYSXc1SJ-jMizyMUJEr7hg9HFGE.jpg\",createdUtc:1664991193,karma:8,commentCount:5,taxa:{bkbmag1},reviewers:{brohitbrose}}\n@update(key:\"/submission/xwgwj0\")@status{id:xwgwj0,title:\"Anyone know what this feather could belong to? West Michigan, USA.\",location:\"north america\",thumbnail:\"https://a.thumbs.redditmedia.com/_gmhGQJpMM7R04UigBVFsVkXY7h7fh0dPhT_CtnvHo8.jpg\",createdUtc:1664991196,karma:14,commentCount:5,taxa:{wiltur},reviewers:{tinylongwing}}\n@update(key:\"/submission/xwgz1y\")@status{id:xwgz1y,title:\"Bird found in Tom Green County\",location:\"north america\",thumbnail:\"https://a.thumbs.redditmedia.com/C8f_G4ZEs2pDdWQRA8MmKOjnTb24kYRUi5M6E2vJ2w8.jpg\",createdUtc:1664991356,karma:8,commentCount:3,taxa:{sora},reviewers:}\n...\n```\n\n### Unanswered(/answered/unreviewed/reviewed) submission statuses\n\n```\n% swim-cli sync -h warps://munin.swim.services -n /submissions -l unanswered\n\n@update(key:xwaj1m)@status{id:xwaj1m,title:\"Can anyone ID this strange bird sound?\",location:unknown,thumbnail:\"https://b.thumbs.redditmedia.com/xhMyBWKfdQzhWKITLRHHYlLF_wQAqHkFGPBtHwSVvjo.jpg\",createdUtc:1664976070,karma:7,commentCount:3,taxa:,reviewers:}\n@update(key:xwxh4k)@status{id:xwxh4k,title:\"Not a usual bird we see in the city. Location: Philippines\",location:\"southeast asia\",thumbnail:\"https://b.thumbs.redditmedia.com/zpt1ueqL9S1N6Pb-e2x0ImGNUrh8f-Z5wzVp-mb2z0A.jpg\",createdUtc:1665035125,karma:13,commentCount:11,taxa:,reviewers:}\n@update(key:xx19q7)@status{id:xx19q7,title:\"ID request: Eastern Alps in Switzerland, dropped out of the sky\",location:europe,thumbnail:\"https://b.thumbs.redditmedia.com/LG8Rr7xkdLEiFg5FwGTNtU2hV2OQ5IRbZcH6_IlKlcw.jpg\",createdUtc:1665049854,karma:15,commentCount:0,taxa:,reviewers:}\n...\n```\n\nThe `answered`, `unreviewed`, and `reviewed` lanes are similarly available.\n\n### Just answers (including empty ones) for all submissions\n\n```\n% swim-cli sync -h warps://munin.swim.services -n /submissions -l answers\n\n@update(key:\"/submission/xxkv53\")@answer{taxa:{comyel}}\n@update(key:\"/submission/xxkwcq\")\n@update(key:\"/submission/xxldl3\")@answer{taxa:{grbher,bcnher,greegr}}\n@update(key:\"/submission/xxlwlz\")@answer{taxa:{babwar},reviewers:{broken_faaace}}\n...\n```\n\n---\n\n**NOTE:** All subsequent commands will return _nothing_ if the submission being inspected\nis over 36 hours old.\n\n### Info about one submission\n\n```\n% swim-cli sync -h warps://munin.swim.services -n /submission/y0drr3 -l info\n\n@submission{id:y0drr3,title:\"Bird ID help! Northern Illinois\",location:\"north america\",thumbnail:\"https://b.thumbs.redditmedia.com/dlK6Ls1MWwjBIYsfby4T4vXbw7cVj0oXAbJW9EkO2Ac.jpg\",createdUtc:1665405563,karma:32,commentCount:8}\n```\n\n### Answer for one submission\n\n```\n% swim-cli sync -h warps://munin.swim.services -n /submission/y0drr3 -l answer\n\n@answer{taxa:{eursta,rebwoo}}\n```\n\n### Status of one submission\n\n```\n% swim-cli sync -h warps://munin.swim.services -n /submission/y0drr3 -l status\n\n@status{id:y0drr3,title:\"Bird ID help! Northern Illinois\",location:\"north america\",thumbnail:\"https://b.thumbs.redditmedia.com/dlK6Ls1MWwjBIYsfby4T4vXbw7cVj0oXAbJW9EkO2Ac.jpg\",createdUtc:1665405563,karma:31,commentCount:8,taxa:{eursta,rebwoo},reviewers:}\n```\n\n### Nonempty motions (i.e. answer contributors) for a submission\n\n```\n% swim-cli sync -h warps://munin.swim.services -n /submission/xvtxqc -l motions\n\n@update(key:{1664927079,ir33kwk})@review(brohitbrose){plusTaxa:{leasan,y00496}}\n@update(key:{1664997555,ir6sjgg})@review(haematopuspalliatus)\n@update(key:{1664997652,ir6ssw9})@review(brohitbrose)\n@update(key:{1665007491,ir7i1d4})@review(haematopuspalliatus){overrideTaxa:{leasan,semsan}}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphform%2Fmunin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgraphform%2Fmunin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphform%2Fmunin/lists"}