gNMIc 项目教程

gNMIc 项目教程

gnmicgNMIc is a gNMI CLI client and collector项目地址:https://gitcode.com/gh_mirrors/gn/gnmic

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

gNMIc 项目的目录结构如下：

gnmic/
├── cmd/
│   ├── gnmic-collector/
│   ├── gnmic-create/
│   ├── gnmic-delete/
│   ├── gnmic-get/
│   ├── gnmic-listen/
│   ├── gnmic-load/
│   ├── gnmic-prompt/
│   ├── gnmic-set/
│   ├── gnmic-subscribe/
│   └── gnmic/
├── config/
│   ├── config.go
│   └── config_test.go
├── docs/
│   ├── examples/
│   ├── images/
│   └── README.md
├── internal/
│   ├── collector/
│   ├── config/
│   ├── gnmic/
│   ├── outputs/
│   ├── processors/
│   ├── prometheus/
│   ├── proto/
│   ├── service/
│   ├── targets/
│   ├── telemetry/
│   └── utils/
├── pkg/
│   ├── collector/
│   ├── config/
│   ├── gnmic/
│   ├── outputs/
│   ├── processors/
│   ├── prometheus/
│   ├── proto/
│   ├── service/
│   ├── targets/
│   ├── telemetry/
│   └── utils/
├── scripts/
│   ├── build.sh
│   ├── install.sh
│   └── release.sh
├── vendor/
├── .gitignore
├── .golangci.yml
├── .travis.yml
├── Dockerfile
├── go.mod
├── go.sum
├── LICENSE
└── README.md

目录结构介绍

• cmd/: 包含所有可执行命令的源代码，每个子目录对应一个命令。
• config/: 包含配置文件相关的代码。
• docs/: 包含项目的文档，包括示例和图片。
• internal/: 包含项目的内部代码，通常不对外公开。
• pkg/: 包含项目的公共代码，可以被其他项目引用。
• scripts/: 包含项目的构建、安装和发布脚本。
• vendor/: 包含项目的依赖库。
• .gitignore: Git 忽略文件列表。
• .golangci.yml: GolangCI-Lint 配置文件。
• .travis.yml: Travis CI 配置文件。
• Dockerfile: Docker 构建文件。
• go.mod: Go 模块文件。
• go.sum: Go 模块依赖文件。
• LICENSE: 项目许可证。
• README.md: 项目介绍文件。

2. 项目的启动文件介绍

gNMIc 项目的启动文件位于 cmd/gnmic/ 目录下。主要的启动文件是 main.go，它负责初始化配置、加载插件、启动服务等。

启动文件介绍

• main.go: 主程序入口，负责初始化和启动 gNMIc 服务。
• cmd/gnmic/: 包含所有与 gNMIc 命令相关的代码。

3. 项目的配置文件介绍

gNMIc 项目的配置文件通常是一个 YAML 文件，用于配置 gNMIc 的行为。配置文件的示例如下：

targets:
  - name: router1
    address: 192.168.1.1:57400
    username: admin
    password: admin
    skip-verify: true
    subscriptions:
      - name: interface_stats
        paths:
          - /interfaces/interface/state/counters
        mode: stream
        encoding: json
outputs:
  - name: file
    file:
      path: /var/log/gnmic.log

配置文件介绍

• targets: 定义 gNMI 目标设备的信息，包括名称、地址、用户名、密码等。
• subscriptions: 定义订阅信息，包括订阅名称、路径、模式和编码方式。
• outputs: 定义输出配置，例如输出到文件。

通过以上配置文件，gNMIc 可以连接到目标设备并收集指定的数据，然后将数据输出到指定的位置。

gnmicgNMIc is a gNMI CLI client and collector项目地址:https://gitcode.com/gh_mirrors/gn/gnmic