{"id":13562120,"url":"https://github.com/cloudflare/unsee","last_synced_at":"2025-04-03T18:32:30.449Z","repository":{"id":63727487,"uuid":"83725685","full_name":"cloudflare/unsee","owner":"cloudflare","description":"Alert dashboard for Prometheus Alertmanager","archived":true,"fork":false,"pushed_at":"2020-04-29T22:55:37.000Z","size":18660,"stargazers_count":707,"open_issues_count":16,"forks_count":45,"subscribers_count":30,"default_branch":"master","last_synced_at":"2024-08-01T13:25:20.227Z","etag":null,"topics":["alerting","alertmanager","dashboard","monitoring","prometheus"],"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/cloudflare.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"docs/CODEOWNERS","security":null,"support":null}},"created_at":"2017-03-02T21:17:22.000Z","updated_at":"2024-08-01T10:04:18.000Z","dependencies_parsed_at":"2022-11-24T20:04:46.105Z","dependency_job_id":null,"html_url":"https://github.com/cloudflare/unsee","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudflare%2Funsee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudflare%2Funsee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudflare%2Funsee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudflare%2Funsee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudflare","download_url":"https://codeload.github.com/cloudflare/unsee/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223010454,"owners_count":17072988,"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":["alerting","alertmanager","dashboard","monitoring","prometheus"],"created_at":"2024-08-01T13:01:04.798Z","updated_at":"2024-11-04T14:30:44.229Z","avatar_url":"https://github.com/cloudflare.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# unsee\n\nAlert dashboard for\n[Prometheus Alertmanager](https://prometheus.io/docs/alerting/alertmanager/).\n\nAlertmanager UI is useful for browsing alerts and managing silences, but it's\nlacking as a dashboard tool - unsee aims to fill this gap.\nStarting with `0.7.0` release it can also aggregate alerts from multiple\nAlertmanager instances, running either in HA mode or separate. Duplicated alerts\nare deduplicated so only unique alerts are displayed. Each alert is tagged with\nnames of all Alertmanager instances it was found at and can be filtered based\non those tags.\n\n![Screenshot](/screenshot.png)\n\nTo get notifications about new unsee releases you can subscribe to the RSS feed\nthat [GitHub provides](https://github.com/cloudflare/unsee/releases.atom)\nTo get email notifications please use one of the free services providing\n_RSS to email_ notifications, like [Blogtrottr](https://blogtrottr.com/).\n\n## Supported Alertmanager versions\n\nAlertmanager's API isn't stable yet and can change between releases, see\n`VERSIONS` in [internal/mock/Makefile](/internal/mock/Makefile) for list of all\nAlertmanager releases that are tested and supported by unsee.\nDue to API differences between those releases some features will work\ndifferently or be missing, it's recommended to use the latest supported\nAlertmanager version.\n\n## Security\n\nThe unsee process doesn't send any API request to the Alertmanager that could\nmodify alerts or silence state, but it does provide a web interface that allows\na user to send such requests directly to the Alertmanager API.\nIf you wish to deploy unsee as a read-only tool please ensure that:\n\n* the unsee process is able to connect to the Alertmanager API\n* read-only users are able to connect to the unsee web interface\n* read-only users are NOT able to connect to the Alertmanager API\n\n## Metrics\n\nunsee process metrics are accessible under `/metrics` path by default.\nIf you set the `--listen.prefix` option a path relative to it will be\nused.\n\n## Building and running\n\n### Building from source\n\nTo clone git repo and build the binary yourself run:\n\n    git clone https://github.com/cloudflare/unsee $GOPATH/src/github.com/cloudflare/unsee\n    cd $GOPATH/src/github.com/cloudflare/unsee\n\nTo finally compile `unsee` the binary run:\n\n    make\n\nNote that building locally from sources requires Go, nodejs and npm.\nSee Docker build options below for instructions on building from withing docker\ncontainer.\n\n## Running\n\n`unsee` can be configured using config file, command line flags or environment\nvariables. Config file is the recommended method, it's also the only way to\nconfigure unsee to use multiple Alertmanager servers for collecting alerts.\nTo run unsee with a single Alertmanager server set `ALERTMANAGER_URI`\nenvironment variable or pass `--alertmanger.uri` flag on the command line, with\nAlertmanager URI as argument, example:\n\n    ALERTMANAGER_URI=https://alertmanager.example.com unsee\n    unsee --alertmanager.uri https://alertmanager.example.com\n\nThere is a make target which will compile and run unsee:\n\n    make run\n\nBy default it will listen on port `8080` and Alertmanager mock data will be\nused, to override Alertmanager URI set `ALERTMANAGER_URI` and/or `PORT` make\nvariables. Example:\n\n    make PORT=5000 ALERTMANAGER_URI=https://alertmanager.example.com run\n\n## Docker\n\n### Running pre-build docker image\n\nOfficial docker images are built and hosted on\n[hub.docker.com](https://hub.docker.com/r/cloudflare/unsee/).\n\nImages are built automatically for:\n\n* release tags in git - `cloudflare/unsee:vX.Y.Z`\n* master branch commits - `cloudflare/unsee:latest`\n\n#### Examples\n\nTo start a release image run:\n\n    docker run -e ALERTMANAGER_URI=https://alertmanager.example.com cloudflare/unsee:vX.Y.Z\n\nLatest release details can be found on\n[GitHub](https://github.com/cloudflare/unsee/releases).\n\nTo start docker image build from lastet master branch run:\n\n    docker run -e ALERTMANAGER_URI=https://alertmanager.example.com cloudflare/unsee:latest\n\nNote that latest master branch might have bugs or breaking changes. Using\nrelease images is strongly recommended for any production use.\n\n### Building a Docker image\n\n    make docker-image\n\nThis will build a Docker image from sources.\n\n### Running the Docker image\n\n    make run-docker\n\nWill run locally built Docker image. Same defaults and override variables\napply as with `make run`. Example:\n\n    make PORT=5000 ALERTMANAGER_URI=https://alertmanager.example.com run-docker\n\n## Configuration\n\nPlease see [CONFIGURATION](/docs/CONFIGURATION.md) for full list of available\nconfiguration options and [example.yaml](/docs/example.yaml) for a config file\nexample.\n\n## Contributing\n\nPlease see [CONTRIBUTING](/CONTRIBUTING.md) for details.\n\n## License\n\nApache License 2.0, please see [LICENSE](/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudflare%2Funsee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudflare%2Funsee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudflare%2Funsee/lists"}