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/
├── AUTHORS
├── LICENSE
├── README.md
├── dir-locals.el
├── gitignore
├── rebar.config
├── rebar.lock
└── sys.config

目录介绍

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

2. 项目启动文件介绍

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

• src/oc_trace.erl: 这是 OpenCensus 的核心模块之一，负责跟踪和处理分布式跟踪数据。
• src/ocp.erl: 提供用于创建和管理跟踪上下文的 API。
• src/oc_span.erl: 处理跟踪中的 Span 数据。

启动流程

1. 加载配置文件: 项目启动时会加载 sys.config 文件中的配置。
2. 初始化跟踪上下文: 使用 ocp 模块初始化跟踪上下文。
3. 启动跟踪: 使用 oc_trace 模块启动跟踪，并根据配置进行数据收集和处理。

3. 项目的配置文件介绍

OpenCensus Erlang 项目的主要配置文件是 sys.config。以下是该文件的一些关键配置项：

[
  {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_ttl 表示 Span 的存活时间。
• logger_formatter: 配置日志格式化模板，包含跟踪 ID、Span ID 和跟踪选项。

通过这些配置项，可以灵活地调整 OpenCensus Erlang 项目的运行行为。

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