OpenCensus Erlang 项目教程

OpenCensus Erlang 项目教程

opencensus-erlang A stats collection and distributed tracing framework 项目地址: https://gitcode.com/gh_mirrors/op/opencensus-erlang

1. 项目目录结构及介绍

OpenCensus Erlang 项目的目录结构如下：

opencensus-erlang/
├── circleci/
├── doc/
├── examples/
│   └── helloworld/
├── include/
├── src/
├── test/
├── .dir-locals.el
├── .gitignore
├── AUTHORS
├── LICENSE
├── README.md
├── elvis.config
├── rebar.config
├── rebar.lock

目录结构介绍

• circleci/: 包含 CircleCI 配置文件，用于持续集成。
• doc/: 包含项目的文档文件。
• examples/: 包含示例项目，如 helloworld。
• include/: 包含项目的头文件。
• src/: 包含项目的源代码文件。
• test/: 包含项目的测试代码文件。
• .dir-locals.el: Emacs 配置文件。
• .gitignore: Git 忽略文件配置。
• AUTHORS: 项目作者列表。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• elvis.config: Elvis 代码风格检查配置文件。
• rebar.config: Rebar3 项目配置文件。
• rebar.lock: Rebar3 锁定文件，包含依赖项的版本信息。

2. 项目启动文件介绍

OpenCensus Erlang 项目的启动文件主要位于 src/ 目录下。以下是一些关键的启动文件：

• src/ocp.erl: 这是 OpenCensus 的主要模块之一，提供了创建和管理 Span 的功能。
• src/oc_trace.erl: 这个模块负责跟踪和管理 Span 的生命周期。
• src/oc_span.erl: 这个模块定义了 Span 的数据结构和相关操作。

启动流程

1. 初始化: 在启动项目时，首先需要初始化 OpenCensus 的配置，包括设置采样器、报告器等。
2. 创建 Span: 使用 ocp:with_child_span/1 或 oc_trace:with_child_span/2 创建新的 Span。
3. 记录数据: 使用 ocp:record 记录测量数据。
4. 结束 Span: 在操作完成后，结束 Span 并将其数据发送给报告器。

3. 项目的配置文件介绍

OpenCensus Erlang 项目的配置文件主要包括 rebar.config 和 sys.config。

rebar.config

rebar.config 是 Rebar3 项目的配置文件，定义了项目的依赖项、编译选项等。以下是一个示例配置：

{deps, [
    {opencensus, {git, "https://github.com/census-instrumentation/opencensus-erlang.git", {branch, "master"}}}
]}.

sys.config

sys.config 是 Erlang 系统的配置文件，用于配置 OpenCensus 的各种参数，如 Span 清理策略、日志记录等。以下是一个示例配置：

[
    {sweeper, [
        {interval, 300000},
        {strategy, drop},
        {span_ttl, 300000}
    ]},
    {logger_formatter, [
        {template, [
            time, " ", pid, " ",
            [[span_ctx, trace_id], ["trace_id=", [span_ctx, trace_id], " "], []],
            [[span_ctx, span_id], ["span_id=", [span_ctx, span_id], " "], []],
            [[span_ctx, trace_options], ["trace_options=", [span_ctx, trace_options], " "], []],
            msg, "\n"
        ]}
    ]}
].

配置文件介绍

• sweeper: 配置 Span 清理策略，包括清理间隔 (interval)、清理策略 (strategy) 和 Span 的生存时间 (span_ttl)。
• logger_formatter: 配置日志格式化模板，包括 trace_id、span_id 和 trace_options 的显示格式。

通过这些配置文件，可以灵活地调整 OpenCensus Erlang 项目的行为，以满足不同的需求。

opencensus-erlang A stats collection and distributed tracing framework 项目地址: https://gitcode.com/gh_mirrors/op/opencensus-erlang