Panorama项目使用指南

1. 项目目录结构及介绍

Panorama 是一个旨在增强系统在故障检测中现场观测能力的工具，其仓库的目录结构精心组织，以支持开发者快速理解和使用。下面是其主要目录结构及其简介：

• bin: 编译后可执行文件存放位置。
• client: 包含客户端相关的代码和逻辑。
• cmd: 主要命令行工具入口。
• conf: 配置文件模板或示例，用于服务配置。
• decision: 决策逻辑相关代码。
• exchange: 实现数据交换的部分。
• idl: 接口定义语言文件，用于gRPC通信的定义。
• plugin: 可插拔组件，允许扩展功能。
• sample/zookeeper: 特定场景或服务的示例，如与ZooKeeper集成的样例。
• service: 系统服务的核心实现。
• store: 数据存储相关的实现。
• types: 定义系统内部使用的数据类型。
• util: 辅助工具函数集合。
• vendor: 依赖包，确保项目的环境一致性。

每个子目录下都包含了特定功能的源码文件，使得开发和维护更有序。

2. 项目的启动文件介绍

项目的主要启动流程通过命令行工具进行。关键的启动脚本或命令位于编译后的bin目录，或者直接通过Makefile构建并运行。例如，启动一个Panorama服务器实例通常使用以下命令模式：

$ hview-server -addr <hostname>:<port> <instance-id>

其中，hview-server是启动服务器的关键脚本，<hostname>和<port>指定了服务监听地址，<instance-id>是实例的唯一标识。

对于开发环境，可以直接通过Makefile来编译和准备必要的工具，如：

$ make

以及安装额外的工具依赖：

$ make tool-deps

3. 项目的配置文件介绍

Panorama允许通过配置文件定制服务的行为。配置文件（如由hview-mkrc脚本生成的）是JSON格式，它包括了以下几个关键部分：

• Addr: 服务监听的地址。
• Id: 实例的ID，需唯一。
• Subjects: 观测过滤所关注的主题列表。
• Peers: 参与的其他Panorama服务实例地址，用于分布式部署。
• FilterSubmission: 是否基于主题过滤观测报告。
• LogLevel: 日志级别设定。
• DBFile: 数据库文件路径，用于持久化数据。

创建配置文件的一个例子是使用hview-mkrc命令，它允许指定服务器数量、地址模式、实例名称等参数，生成适合集群部署的配置。

$ hview-mkrc -fix_port 6688 -nserver 10 -addressp razor%d -namep pano%d -id pano0 -filter -subjects nn1 dn1 dn2 dn3

此命令将生成一个含有10个实例的配置，每个实例监听不同的地址，并且配置了观测过滤规则。

综上，通过合理的目录组织、明确的启动机制以及灵活的配置管理，Panorama提供了强大的系统观测和故障检测能力，开发者可以根据上述指导进行项目的部署和使用。