Nightingale 开源项目使用教程

Nightingale 开源项目使用教程

nightingaleAn all-in-one observability solution which aims to combine the advantages of Prometheus and Grafana. It manages alert rules and visualizes metrics, logs, traces in a beautiful web UI.项目地址:https://gitcode.com/gh_mirrors/nightingale/nightingale

1. 项目的目录结构及介绍

Nightingale 项目的目录结构如下：

nightingale/
├── api
├── backend
├── bin
├── configs
├── console
├── docs
├── frontend
├── scripts
├── sql
├── storage
├── tests
├── webapi
├── Dockerfile
├── Makefile
├── README.md

目录介绍

• api: 包含项目的 API 接口定义。
• backend: 包含项目的后端代码。
• bin: 包含可执行文件。
• configs: 包含项目的配置文件。
• console: 包含控制台相关的代码。
• docs: 包含项目的文档。
• frontend: 包含项目的前端代码。
• scripts: 包含各种脚本文件。
• sql: 包含数据库相关的 SQL 文件。
• storage: 包含存储相关的代码。
• tests: 包含测试代码。
• webapi: 包含 Web API 相关的代码。
• Dockerfile: 用于构建 Docker 镜像的文件。
• Makefile: 包含项目的构建指令。
• README.md: 项目的主文档。

2. 项目的启动文件介绍

Nightingale 项目的启动文件主要位于 bin 目录下。以下是主要的启动文件：

• n9e-agent: 用于启动代理服务的可执行文件。
• n9e-server: 用于启动服务器服务的可执行文件。
• n9e-webapi: 用于启动 Web API 服务的可执行文件。

启动命令示例

./bin/n9e-agent
./bin/n9e-server
./bin/n9e-webapi

3. 项目的配置文件介绍

Nightingale 项目的配置文件主要位于 configs 目录下。以下是主要的配置文件：

• agent.yml: 代理服务的配置文件。
• server.yml: 服务器服务的配置文件。
• webapi.yml: Web API 服务的配置文件。

配置文件示例

# agent.yml
listen: ":20000"
heartbeat:
  enabled: true
  interval: 10

# server.yml
listen: ":19000"
database:
  host: "localhost"
  port: 3306
  user: "root"
  password: "password"

# webapi.yml
listen: ":18000"
auth:
  enabled: true
  secret: "secret_key"

以上是 Nightingale 开源项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。

nightingaleAn all-in-one observability solution which aims to combine the advantages of Prometheus and Grafana. It manages alert rules and visualizes metrics, logs, traces in a beautiful web UI.项目地址:https://gitcode.com/gh_mirrors/nightingale/nightingale