{"id":13832184,"url":"https://github.com/coreos/mayday","last_synced_at":"2025-07-09T16:34:36.847Z","repository":{"id":20139348,"uuid":"23409569","full_name":"coreos/mayday","owner":"coreos","description":"A diagnostics tool for capturing system state.","archived":true,"fork":false,"pushed_at":"2018-03-14T09:29:30.000Z","size":7994,"stargazers_count":80,"open_issues_count":13,"forks_count":27,"subscribers_count":25,"default_branch":"master","last_synced_at":"2024-08-05T10:20:36.927Z","etag":null,"topics":["diagnostics","go","sosreport","sysreport","troubleshooting"],"latest_commit_sha":null,"homepage":"","language":"Go","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/coreos.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-08-28T00:07:15.000Z","updated_at":"2024-02-25T22:51:05.000Z","dependencies_parsed_at":"2022-09-07T13:51:32.217Z","dependency_job_id":null,"html_url":"https://github.com/coreos/mayday","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/coreos%2Fmayday","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fmayday/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fmayday/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coreos%2Fmayday/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coreos","download_url":"https://codeload.github.com/coreos/mayday/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225575239,"owners_count":17490727,"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":["diagnostics","go","sosreport","sysreport","troubleshooting"],"created_at":"2024-08-04T10:01:53.918Z","updated_at":"2024-11-20T14:30:35.789Z","avatar_url":"https://github.com/coreos.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# mayday [![Build Status](https://travis-ci.org/coreos/mayday.png?branch=master)](https://travis-ci.org/coreos/mayday)\n\n...man overboard!\n\n```\n\n\n     ___ ___   ____  __ __  ___     ____  __ __\n    |   |   | /    ||  |  ||   \\   /    ||  |  |\n    | _   _ ||  o  ||  |  ||    \\ |  o  ||  |  |\n    |  \\_/  ||     ||  ~  ||  D  ||     ||  ~  |\n    |   |   ||  _  ||___, ||     ||  _  ||___, |\n    |   |   ||  |  ||     ||     ||  |  ||     |\n    |___|___||__|__||____/ |_____||__|__||____/\n\n\n\n\n~~~~~~~~~~~~~~~~~~~~~~~~~\\o/~~~~~~~~~~~~~~~~~~~~~~~~\n\n                                   \u003e\u003c\u003e\n               \u003c\u003e\u003c  \n```\n\n## overview\nMayday is a tool to simplify gathering support information.  It is built in the\nspirit of sysreport, son of sysreport (sosreport), and similar support tools.  \nMayday gathers information about the configuration, hardware, and running state\nof a system.\n\n\n## goals\nThe goals of mayday are:\n  * simplify gathering information about a running system into a single command\n  * collect information into one single file to be transferred to support staff\n  * when possible the file should be small enough to be sent via email (\u003c10MB)\n  * *not* collect sensitive information like crypto keys, password hashes, etc\n  * extensible through plugin system\n\n## usage\nIn it's most simplistic form, all a user needs to do is run `mayday`:\n\n```\n$ mayday\n```\n\nThis will collect a basic set of data and emit it in a tar archive for\ntransmission to a systems administrator, site reliability engineer, or support\ntechnician for further troubleshooting.\n\nIn addition, more data can be collected by running as the superuser:\n\n```\n$ sudo mayday\n```\nEven more data can be collected by adding the `--danger` flag:\n\n```\n$ sudo mayday --danger\n```\n\n## what's collected\n\nBy default, mayday operates in a \"safe\" mode. No sensitive information is\ncollected -- only information that support might need. This includes things like:\n\n* network connections, firewall rules, and hostname\n* information about currently running processes, including open files and ports\n* log files from systemd services\n* filesystem and memory usage information\n* information about docker and rkt containers, including network and state but NOT logs\n\nThe following is collected only if the `--danger` flag is activated:\n\n* logs and environment variables of docker and rkt containers\n\nThe following information is **never** collected:\n\n* private keys\n* passwords\n\n## integration\n\n### about\nMayday can be integrated into other projects by defining a default configuration\nfile at either the location `/etc/mayday/default.json` or\n`/usr/share/mayday/default.json`. Through the use of [viper](https://github.com/spf13/viper)\nYAML and TOML are now supported as well, though [CoreOS](https://coreos.com)\nwill continue to use JSON as the mechanism of choice.  If multiple products are\nto be supported specialized configurations can be provided as \"profiles\" located\nin the above directories (e.g. `/etc/mayday/quay.json`) and the referenced via:\n\n```\n$ mayday -p quay\n```\n\n### configuration syntax\n\nThe configuration file is comprised of objects (As of 1.0.0 valid objects are\n\"files\" and \"commands\").  A example of the syntax can be seen in the file\n[default.json](https://github.com/coreos/mayday/blob/master/default.json).\nEach top level object contains an array of the relevant items to collect.\nOptionally items can be annotated with a \"link\" which will provide an easy to\nlocate pointer for commonly accessed data.\n\n### collection\nFiles are directly retrieved. Commands are executed and the results of standard\noutput (`stdout`) are collected. Assets are placed into a Go \"tarable\"\ninterface and then gzipped and serialized out to a file on disk.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoreos%2Fmayday","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoreos%2Fmayday","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoreos%2Fmayday/lists"}