{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/275", "result": {"data":{"issuesJson":{"id":"1aba2d50-1c04-5e9d-9276-9b838f3712f1","title":"prymitive/karma: 一款展示 AlertManager 告警信息的面板，可用于投屏","number":275,"bodyHTML":"

\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Repos	prymitive/karma
Views	$\"views\"$
Stars	$\"stars\"$
Forks	$\"forks\"$
License	$\"license\"$
UpdatedAt	$\"last-commit\"$
CreatedAt	$\"create-at\"$

\n\n

\n

\n

\n

karma

\n

Alert dashboard for
\nPrometheus Alertmanager.

\n

\n

Alertmanager >=0.22.0 is required.

\n

\n

See GitHub Releases for release
\nchangelog.

\n

Feature overview

\n

Alertmanager UI is useful for browsing alerts and managing silences, but it's
\nlacking as a dashboard tool - karma aims to fill this gap.

\n

Alert aggregation and deduplication

\n

Starting with the 0.7.0 release it can aggregate alerts from multiple
\nAlertmanager instances, running either in HA mode or separate. Unique alerts are
\ndisplayed by filtering duplicates. Each alert is tagged with the names of all
\nAlertmanager instances it was found at and can be filtered based on those tags
\n(@alertmanager). Note that @alertmanager tags will be visible only if karma
\nis configured with multiple Alertmanager instances.
\nIf alertmanger is configured to use
\nHA clusters
\nthen @cluster will be available as well, to set a custom name for each cluster
\nsee CONFIGURATION.md.

\n

$\"Screenshot\"$

\n

Alert visualization

\n

Alert groups

\n

Alerts are displayed grouped preserving
\ngroup_by
\nconfiguration option in Alertmanager.
\nNote that a unique alert group will be created for each receiver it uses in
\nalertmanager as they can have different group_by settings.
\nIf a group contains multiple alerts only
\nthe first few alerts will be presented. Alerts are expanded or hidden
\nusing - / + buttons. The default number of alerts can be configured in the UI
\nsettings module.
\nEach group can be collapsed to only show the title bar using top right toggle
\nicon.
\nEach individual alert will show unique labels and annotations. Labels
\nand annotations that are shared between all alerts are moved to the footer.

\n

Active alerts will show recently expired silences, to allow re-silincing
\nif needed.
\nThis is controlled via silences:expired setting. 10m value would show
\nsilences expired in the last 10 minutes but only for alerts that started firing
\nmore than 10 minutes ago.

\n

\n

Alert history

\n

Alertmanager doesn't currently provide any long term storage of alert events
\nor a way to query for historical alerts, but each Prometheus server sending
\nalerts stores metrics related to triggered alerts.
\nWhen history:enabled is true karma will use source fields from each alert
\nto try querying alert related metrics on remote Prometheus servers.
\nThe result is the number of times given alert group triggered an alert per hour
\nin the last 24h, displayed as 24 blocks. The darker the color the more alerts
\nwere triggered in that hour, as compared by all other hours.

\n

\n

For this feature to work karma must be able to connect to all Prometheus servers
\nsending alerts. Be sure to set --web.external-url Prometheus flag to a publicly
\nreachable URL of each server.

\n

Inhibited alerts

\n

Inhibited alerts (suppressed by other alerts,
\nsee Alertmanager docs)
\nwill have a \"muted\" button.

\n

\n

Clicking on that button will bring a modal with a list of inhibiting alerts.

\n

\n

Silence deduplication

\n

If all alerts in a group were suppressed by the same silence then, to save
\nscreen space, the silence will also be moved to the footer.

\n

$\"Deduplicated$

\n

Label based multi-grid

\n

To help separate alerts from different environments or with different level of
\nseverity multi-grid mode can be enabled, which adds another layer of visually
\ngrouping alert groups.
\nTo enable this mode go to the configuration modal and select a label name, all
\nalerts will be grouped by that label, each label value will have a dedicated
\ngrid, including an extra grid for alerts without that label present.

\n

\n

Silence management

\n

Silence modal allows to create new silences and manage all silences already
\npresent in Alertmanager.
\nSilence ACL rules can be used to control silence creation and editing, see
\nACLs docs for more details.

\n

\n

Alert overview

\n

Clicking on the alert counter in the top left corner will open the overview
\nmodal, which allows to quickly get an overview of the top label values for
\nall current alerts.

\n

\n

Alert acknowledgement

\n

Starting with v0.50 karma can create short lived silences to acknowledge
\nalerts with a single button click. To create silences that will resolve itself
\nonly after all alerts are resolved you can use
\nkthxbye.
\nSee configuration docs for
\ndetails.

\n

Dead Man’s Switch support

\n

Starting with v0.78 karma can be configured to check for
\nDead Man’s Switch
\nstyle alerts (alert that is always firing). If no alert is found in given
\nalertmanager karma will show an error in the UI.
\nSee healthcheck:filters option on configuration docs
\nfor details.

\n

Dark mode

\n

Starting with v0.52 release karma includes both light and dark themes.
\nBy default it will follow browser preference using
\nprefers-color-scheme
\nmedia queries.

\n

\n

Demo

\n

Online demo is running latest main branch.
\nIt might include features that are experimental and not yet ready to be included.

\n

Release notes

\n

Release notes can be found on
\nGitHub Release Page.

\n

To get notifications about new karma releases go to
\nGitHub karma page, click Watch and
\nselect Releases only. This requires GitHub user account.
\nTo subscribe to email notifications without GitHub account you can subscribe to
\nthe RSS feed that
\nGitHub provides.
\nTo get email notifications from those feeds use one of the free services
\nproviding RSS to email notifications, like
\nBlogtrottr.

\n

History

\n

I created karma while working for Cloudflare,
\noriginally it was called unsee.
\nThis project is based on that code but the UI part was rewritten from scratch
\nusing React. New UI required changes to the backend so
\nthe API is also incompatible.
\nGiven that the React rewrite resulted in roughly 50% of new code and to avoid
\nconfusion for user I've decided to rename it to karma, especially that the
\noriginal project wasn't being maintained anymore.

\n

Supported Alertmanager versions

\n

Alertmanager's API isn't stable yet and can change between releases, see
\nVERSIONS in internal/mock/Makefile for list of all
\nAlertmanager releases that are tested and supported by karma.
\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

Security

\n

karma doesn't in any way alter alerts in any Alertmanager instance it collects
\ndata from. This is true for both the backend and the web UI.
\nThe web UI allows to manage silences by sending requests to Alertmanager
\ninstances, this can be done directly (browser to Alertmanager API) or by
\nproxying such requests via karma backend (browser to karma backend to
\nAlertmanager API) if proxy mode is enabled in karma config.

\n

If you wish to deploy karma as a read-only tool without giving users any ability
\nto modify data in Alertmanager instance, then please ensure that:

\n

the karma process is able to connect to the Alertmanager API
read-only users are able to connect to the karma web interface
read-only users are NOT able to connect to the Alertmanager API
readonly is set to true in
\nalertmanager:servers config section
\nfor all alertmanager instances, this options will disable any UI elements that
\ncould trigger updates (like silence management)

\n

To restrict some users from creating silences or enforce some matcher rules use
\nsilence ACL rules. This feature requires proxy to be enabled.

\n

Metrics

\n

karma 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

Building and running

\n

Building from source

\n

To clone git repo and build the binary yourself run:

\n

git clone https://github.com/prymitive/karma $GOPATH/src/github.com/prymitive/karma\ncd $GOPATH/src/github.com/prymitive/karma\n

\n

To finally compile karma the binary run:

\n

make\n

\n

Note that building locally from sources requires Go, nodejs and yarn.
\nSee Docker build options below for instructions on building from withing docker
\ncontainer.

\n

Running

\n

karma 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 karma to use multiple Alertmanager servers for collecting alerts.
\nTo run karma 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

ALERTMANAGER_URI=https://alertmanager.example.com karma\nkarma --alertmanager.uri https://alertmanager.example.com\n

\n

There is a make target which will compile and run a demo karma docker image:

\n

make run-demo\n

\n

By default it will listen on port 8080 and will have mock alerts.

\n

Docker

\n

Running pre-build docker image

\n

Official docker images are built and hosted on
\nGithub.

\n

Images are built automatically for:

\n

release tags in git - ghcr.io/prymitive/karma:vX.Y.Z
main branch commits - ghcr.io/prymitive/karma:latest

\n

NOTE karma uses uber-go/automaxprocs
\nto automatically adjust GOMAXPROCS to match Linux container CPU quota.

\n

Examples

\n

To start a release image run:

\n

docker run -e ALERTMANAGER_URI=https://alertmanager.example.com ghcr.io/prymitive/karma:vX.Y.Z\n

\n

Latest release details can be found on
\nGitHub.

\n

To start docker image build from lastet main branch run:

\n

docker run -e ALERTMANAGER_URI=https://alertmanager.example.com ghcr.io/prymitive/karma:latest\n

\n

Note that latest main branch might have bugs or breaking changes. Using
\nrelease images is strongly recommended for any production use.

\n

Building a Docker image

\n

make docker-image\n

\n

This will build a Docker image locally from sources.

\n

Health checks

\n

/health endpoint can be used for health check probes, it always responds with
\n200 OK code and Pong response body.

\n

Configuration

\n

Please see CONFIGURATION for full list of available
\nconfiguration options and example.yaml for a config file
\nexample.

\n

Contributing

\n

Please see CONTRIBUTING for details.

\n

License

\n

Apache License 2.0, please see LICENSE.

","updatedAt":"2025-05-21T16:05:12Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"Monitor","color":"533a1e"}},{"node":{"name":"prymitive","color":"6c2b3e"}}]},"comments":{"edges":[]}}},"pageContext":{"number":275,"previous":{"title":"karmada-io/karmada: Karmada 旨在为多云和混合云场景中的多集群应用管理提供统包自动化，具有集中式多云管理、高可用性、故障恢复和流量调度等关键功能。","number":274},"next":{"title":"KusionStack/karpor: 智能化的 Kubernetes 平台，它为 Kubernetes 带来了高级的搜索、洞察和 AI 功能，本质上是一个 Kubernetes 可视化工具。","number":276}}}, "staticQueryHashes": ["151096407","2861350382"]}