{"id":13588356,"url":"https://github.com/ricoberger/Alertmanager","last_synced_at":"2025-04-08T03:33:46.101Z","repository":{"id":55845918,"uuid":"216880158","full_name":"ricoberger/Alertmanager","owner":"ricoberger","description":"Alertmanager for macOS.","archived":true,"fork":false,"pushed_at":"2020-12-11T09:52:02.000Z","size":2220,"stargazers_count":48,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-02T16:10:27.042Z","etag":null,"topics":["alerting","alertmanager","alerts","macos","prometheus","swift"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ricoberger.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":"2019-10-22T18:13:48.000Z","updated_at":"2023-05-24T10:54:38.000Z","dependencies_parsed_at":"2022-08-15T07:50:33.321Z","dependency_job_id":null,"html_url":"https://github.com/ricoberger/Alertmanager","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricoberger%2FAlertmanager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricoberger%2FAlertmanager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricoberger%2FAlertmanager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricoberger%2FAlertmanager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ricoberger","download_url":"https://codeload.github.com/ricoberger/Alertmanager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223300742,"owners_count":17122680,"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","alerts","macos","prometheus","swift"],"created_at":"2024-08-01T15:06:39.710Z","updated_at":"2024-11-06T07:31:28.063Z","avatar_url":"https://github.com/ricoberger.png","language":"Swift","funding_links":[],"categories":["Swift","Swift (22)"],"sub_categories":[],"readme":"# Alertmanager for macOS\n\n![Alertmanager](assets/screenshot.png)\n\nThe **Alertmanager for macOS** is a small macOS application which shows alerts from [Prometheus Alertmanagers](https://github.com/prometheus/alertmanager). You can setup multiple Alertmanager instances to retrive alerts from. The alerts are grouped by the specified settings in you Alertmanager configuration.\n\n## Usage\n\nDownload the latest release of the Alertmanager for macOS from the [releases](https://github.com/ricoberger/Alertmanager/releases) page. Unpack the downloaded ZIP file and start the app.\n\nDuring the first start a file called `.alertmanager.json` will be created in you home directory. Right click on the symbol of the Alertmanager for macOS in the status bar and choose `Open Configuration`. This will open the configuration file in your default editor. After you have adjusted the configuration right click on the symbol again and choose `Reload Configuration`.\n\nAn example configuration can be found in the following code block. For all available options take a look at the [configuration](#configuration) section.\n\n```json\n{\n  \"refreshInterval\": 60,\n  \"severityLabel\": \"severity\",\n  \"severityInfo\": \"info\",\n  \"severityWarning\": \"warning\",\n  \"severityError\": \"error\",\n  \"severityCritical\": \"critical\",\n  \"titleTemplate\": \"[{{ name | uppercase }}] [{{ labels['cluster'] | uppercase }}] {{ labels['alertname'] }}\",\n  \"alertTemplate\": \"{{ annotations['message'] }}\",\n\n  \"alertmanagers\": [\n    {\n      \"name\": \"PROD\",\n      \"url\": \"http://localhost:9093\"\n    }\n  ]\n}\n```\n\n## Configuration\n\nYou can configure the following values for the Alertmanager app:\n\n### General\n\n| Value | Description | Default |\n| ----- | ----------- | ------- |\n| `refreshInterval` | The interval in which the alerts are retrieved. | `60` |\n| `severityLabel` | The name of the label for the severity of an alert. | |\n| `severityInfo` | Value of the severity label for an info alert. | `info` |\n| `severityWarning` | Value of the severity label for an warning alert. | `warning` |\n| `severityError` | Value of the severity label for an error alert. | `error` |\n| `severityCritical` | Value of the severity label for an critical alert. | `critical` |\n| `titleTemplate` | Template for the title. The template can use the name of the Alertmanager and the group labels. (see [Templates](#templates)) | `[{{ name }}] {% for key, value in labels %} {{ key }}: {{ value }} {% endfor %}` |\n| `alertTemplate` | Template for a single alert. The template can use the annotations and labels of the alert. (see [Templates](#templates)) | `{% for key, value in annotations %} {{ key }}: {{ value }} {% endfor %}` |\n| `themeBg` | Background color. | `#2E3440` |\n| `themeBgLight` | Light background color. | `#3B4252` |\n| `themeFg` | Foreground color. | `#ECEFF4` |\n| `themeInfo` | Info color. | `#5E81AC` |\n| `themeWarning` | Warning color. | `#EBCB8B` |\n| `themeError` | Error color. | `#D08770` |\n| `themeCritical` | Critical color. | `#BF616A` |\n| `alertmanagers` | List of Alertmanagers (see [Alertmanager](#alertmanager)). | **Required** |\n\n### Alertmanager\n\n| Value | Description | Default |\n| ----- | ----------- | ------- |\n| `name` | Name of the Alertmanager. | **Required** |\n| `url` | URL of the Alertmanager. | **Required** |\n| `silenced` | Show silenced alerts. Must be `true` or `false` as *string*. | `false` |\n| `inhibited` | Show inhibited alerts. Must be `true` or `false` as *string*. | `false` |\n| `authType` | Authentication method which should be used to retrieve alerts. Possible values are `basic` and `token`. If not authentication is required omit this field. | |\n| `authUsername` | If basic auth is used this is the username which should be used. | |\n| `authPassword` | If basic auth is used this is the password which should be used. | |\n| `authToken` | If token auth is used this is the token which should be used. | |\n\n### Templates\n\nWe are using [the Stencil template language](https://stencil.fuller.li/en/latest/) to render the alerts. You can use all built in [tags](https://stencil.fuller.li/en/latest/builtins.html#built-in-tags) and [filters](https://stencil.fuller.li/en/latest/builtins.html#built-in-filters) for your templates.\n\n#### titleTemplate\n\nThe `titleTemplate` is used to render the alert group title. The following variables are available in `titleTemplate`:\n\n- `name`: Name of the Alertmanager from the configuration file.\n- `url`: URL of the Alertmanager from the configuration file.\n- `labels`: Labels which indicates the alert group. This is configured in your Alertmanager with the `group_by` option.\n\n```json\n{\n  \"titleTemplate\": \"\u003ca href='{{ url }}'\u003e[{{ name | uppercase }}] {{ labels['alertname'] }}\u003c/a\u003e\"\n}\n```\n\n#### alertTemplate\n\nThe `alertTemplate` is used to render a single alert in the list of alerts. The following variables are available in `alertTemplate`:\n\n- `annotations`: Configured annotations for the alert.\n- `labels`: Labels of the alert.\n- `generatorURL`: Identifies the entity that caused the alert. \n\n```json\n{\n  \"alertTemplate\": \"\u003ca href='{{ generatorURL }}'\u003e{{ annotations['message'] }}\u003c/a\u003e\"\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fricoberger%2FAlertmanager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fricoberger%2FAlertmanager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fricoberger%2FAlertmanager/lists"}