Telemetry Poller 项目教程

Telemetry Poller 项目教程

telemetry_pollerPeriodically gather measurements and publish them as Telemetry events项目地址:https://gitcode.com/gh_mirrors/te/telemetry_poller

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

Telemetry Poller 项目的目录结构如下：

telemetry_poller/
├── github/
│   └── workflows/
├── examples/
├── src/
├── test/
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── codecov.yml
├── LICENSE
├── NOTICE
├── README.md
├── rebar.config
└── rebar.lock

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• examples/: 包含项目的示例代码。
• src/: 包含项目的源代码。
• test/: 包含项目的测试代码。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• CODE_OF_CONDUCT.md: 项目行为准则。
• codecov.yml: Codecov 配置文件。
• LICENSE: 项目许可证。
• NOTICE: 项目通知文件。
• README.md: 项目说明文档。
• rebar.config: Rebar3 配置文件。
• rebar.lock: Rebar3 锁定文件。

2. 项目的启动文件介绍

Telemetry Poller 项目的启动文件位于 src/ 目录下，主要文件包括：

• telemetry_poller.erl: 主模块文件，包含项目的核心逻辑和启动函数。

启动 Telemetry Poller 项目的步骤如下：

1. 确保安装了 Erlang 和 Rebar3。
2. 在项目根目录下运行 rebar3 compile 编译项目。
3. 运行 rebar3 shell 启动 Erlang shell。
4. 在 Erlang shell 中启动 Telemetry Poller：

telemetry_poller:start_link().

3. 项目的配置文件介绍

Telemetry Poller 项目的配置文件主要是 rebar.config，该文件用于配置 Rebar3 构建工具。以下是 rebar.config 文件的主要内容：

{deps, [
    {telemetry, "~> 1.0"}
]}.

{profiles, [
    {test, [
        {deps, [
            {meck, "~> 0.8.13"}
        ]}
    ]}
]}.

• deps: 定义项目的依赖项，例如 telemetry。
• profiles: 定义不同的构建配置文件，例如 test 配置文件中添加了 meck 依赖。

通过这些配置，可以确保项目在不同的环境和需求下正确编译和运行。

telemetry_pollerPeriodically gather measurements and publish them as Telemetry events项目地址:https://gitcode.com/gh_mirrors/te/telemetry_poller