Skip to content

Commit df03f71

Browse files
committed
add en doc
1 parent a51300c commit df03f71

8 files changed

Lines changed: 51 additions & 10 deletions

File tree

assets/scss/common/_global.scss

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
.content img {
1313
max-width: 100%;
14-
margin-bottom: 20px;
14+
margin-bottom: 8px;
1515
border-radius: 8px;
1616
}
1717

@@ -74,6 +74,10 @@ body.docs {
7474
font-size: calc(1.875rem + 1.5vw);
7575
}
7676

77+
.mb20 {
78+
margin-bottom: 20px;
79+
}
80+
7781
a:hover,
7882
a:focus {
7983
text-decoration: underline;

assets/scss/components/_images.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
figure {
2-
margin: 2rem 0;
2+
margin: 0.2rem 0;
33
}
44

55
.figure-caption {
326 KB
Loading
223 KB
Loading
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: "How to import Prometheus rules?"
3+
description: "How to import Prometheus alert rules into Nightingale?"
4+
date: 2025-08-04T12:23:56.834+08:00
5+
lastmod: 2025-08-04T12:23:56.834+08:00
6+
draft: false
7+
images: ["import.png", "batch.png", "notify-rules.png"]
8+
menu:
9+
docs:
10+
parent: "faq"
11+
weight: 25250
12+
toc: true
13+
---
14+
15+
Many people in the Prometheus ecosystem have shared alerting rules, such as this project:
16+
17+
- [https://github.com/samber/awesome-prometheus-alerts/tree/master/dist/rules](https://github.com/samber/awesome-prometheus-alerts/tree/master/dist/rules)
18+
19+
Each directory contains alerting rules in YAML format. For example, the `host-and-hardware` directory includes common alerting rules for node-exporter. Want to directly import these rules into Nightingale? Please refer to the following steps.
20+
21+
## Version
22+
23+
Please use Nightingale version 8.2.0 or later.
24+
25+
## Import Steps
26+
27+
![Import Prometheus Alerting Rules](import.png)
28+
29+
As shown in the screenshot above, go to the alerting rules page and select import to import Prometheus-format alerting rules. Note that the YAML-formatted rule content starts with `groups`, which contains multiple `group` entries. Each `group` has a `name` and `rules`, where `rules` is an array of specific alerting rules. Nightingale will ignore the `group`'s `name` during processing and directly import the content in `rules`.
30+
31+
After the import is complete, you usually need to associate notification rules to enable alert notifications. The method is: select the alerting rules in batches, then click "More Operations" in the upper right corner to batch update the alerting rules:
32+
33+
![Batch Update Alerting Rules](batch.png)
34+
35+
In the batch update pop-up, select "Notification rule" as the field, then choose the corresponding notification rule and click "Confirm". The screenshot is as follows:
36+
37+
![Batch Update Notification Rules](notify-rules.png)
265 KB
Loading

content/en/docs/prologue/introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,27 +52,27 @@ Then Nightingale may not be suitable. We recommend using **[FlashDuty](https://f
5252

5353
## Key Capabilities
5454

55-
<img src="/img/prologue/intro/alert-rules.png" alt="Nightingale Alert Rules" />
55+
<img class="mb20" src="/img/prologue/intro/alert-rules.png" alt="Nightingale Alert Rules" />
5656

5757
- Nightingale supports alert rules, muting rules, subscription rules, and notification rules. It natively integrates 20 notification channels and allows customization of message templates.
5858
- Nightingale supports event pipelines to process alert events and integrate with third-party systems. For example, it can perform operations like relabeling, filtering, and enriching on events.
5959
- Nightingale supports the concept of business groups and introduces a permission system to manage various rules in a categorized manner.
6060
- Many databases and middleware have built-in alert rules that can be directly imported for use, and Prometheus alert rules can also be directly imported.
6161
- Nightingale supports alert self-healing, which means that after an alert is triggered, a script is automatically executed to perform some predefined logic, such as cleaning up the disk or capturing the on-site situation.
6262

63-
<img src="/img/prologue/intro/feat2.png" alt="Nightingale Event Dashboard"/>
63+
<img class="mb20" src="/img/prologue/intro/feat2.png" alt="Nightingale Event Dashboard"/>
6464

6565
- Nightingale archives historical alert events and supports multi-dimensional querying and statistics.
6666
- It allows flexible aggregation and grouping, making it easy to get a clear overview of the distribution of the company's alert events at a glance.
6767

68-
<img src="/img/prologue/intro/feat3.png" alt="Nightingale Integration Center"/>
68+
<img class="mb20" src="/img/prologue/intro/feat3.png" alt="Nightingale Integration Center"/>
6969

7070
- Nightingale has built-in metric explanations, dashboards, and alert rules for common operating systems, middleware, and databases. However, these are all contributed by the community, and their overall quality varies.
7171
- Nightingale directly receives data from multiple protocols such as Remote Write, OpenTSDB, Datadog, and Falcon, thus enabling integration with various types of agents.
7272
- Nightingale supports multiple data sources including Prometheus, ElasticSearch, Loki, and TDEngine, and can perform alerting based on the data from them.
7373
- Nightingale can be easily embedded into internal enterprise systems, such as Grafana and CMDB. It even allows configuring the menu visibility of these embedded systems.
7474

75-
<img src="/img/prologue/intro/feat4.png" alt="Nightingale Dashboard"/>
75+
<img class="mb20" src="/img/prologue/intro/feat4.png" alt="Nightingale Dashboard"/>
7676

7777
- Nightingale supports dashboard functionality, featuring common chart types and some built-in dashboards. The image above is a screenshot of one of these dashboards.
7878
- If you're already accustomed to Grafana, it's recommended to continue using Grafana for viewing charts, as Grafana has more profound expertise in this area.

content/zh/docs/prologue/introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,28 +58,28 @@ toc: true
5858

5959
## 关键特性简介
6060

61-
<img src="/img/prologue/intro/feat1.png" alt="夜莺告警规则"/>
61+
<img class="mb20" src="/img/prologue/intro/feat1.png" alt="夜莺告警规则"/>
6262

6363
- 夜莺支持告警规则、屏蔽规则、订阅规则、通知规则,内置支持 20 种通知媒介,支持消息模板自定义
6464
- 支持事件管道,对告警事件做 Pipeline 处理,方便和自有系统做自动化整合,比如给告警事件附加一些元信息,对事件做 relabel
6565
- 支持业务组概念,引入权限体系,分门别类管理各类规则
6666
- 很多数据库、中间件内置了告警规则,可以直接导入使用,也可以直接导入 Prometheus 的告警规则
6767
- 支持告警自愈,即告警之后自动触发一个脚本执行一些预定义的逻辑,比如清理一下磁盘、抓一下现场等
6868

69-
<img src="/img/prologue/intro/feat2.png" alt="夜莺事件大盘"/>
69+
<img class="mb20" src="/img/prologue/intro/feat2.png" alt="夜莺事件大盘"/>
7070

7171
- 夜莺存档了历史告警事件,支持多维度的查询和统计
7272
- 支持灵活的聚合分组,一目了然看到公司的告警事件分布情况
7373

74-
<img src="/img/prologue/intro/feat3.png" alt="夜莺集成中心"/>
74+
<img class="mb20" src="/img/prologue/intro/feat3.png" alt="夜莺集成中心"/>
7575

7676
- 夜莺内置常用操作系统、中间件、数据库的的指标说明、仪表盘、告警规则,不过都是社区贡献的,整体也是参差不齐
7777
- 夜莺直接接收 Remote Write、OpenTSDB、Datadog、Falcon 等多种协议的数据,故而可以和各类 Agent 对接
7878
- 夜莺支持 Prometheus、ElasticSearch、Loki、TDEngine 等多种数据源,可以对其中的数据做告警
7979
- 夜莺可以很方便内嵌企业内部系统,比如 Grafana、CMDB 等,甚至可以配置这些内嵌系统的菜单可见性
8080

8181

82-
<img src="/img/prologue/intro/feat4.png" alt="夜莺仪表盘"/>
82+
<img class="mb20" src="/img/prologue/intro/feat4.png" alt="夜莺仪表盘"/>
8383

8484
- 夜莺支持仪表盘功能,支持常见的图表类型,也内置了一些仪表盘,上图是其中一个仪表盘的截图。
8585
- 如果你已经习惯了 Grafana,建议仍然使用 Grafana 看图。Grafana 在看图方面道行更深。

0 commit comments

Comments
 (0)