OpenTelemetry Go Extra 项目教程

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

OpenTelemetry Go Extra 项目的目录结构如下：

opentelemetry-go-extra/
├── database/
│   ├── README.md
│   └── otelsql/
│       └── otelsql.go
├── gorm/
│   ├── README.md
│   └── otelgorm/
│       └── otelgorm.go
├── LICENSE
├── README.md
└── go.mod

目录介绍

• database/: 包含针对 database/sql 包的 OpenTelemetry 插桩。
  • otelsql/: 具体的插桩实现。
• gorm/: 包含针对 GORM 的 OpenTelemetry 插桩。
  • otelgorm/: 具体的插桩实现。
• LICENSE: 项目的许可证文件。
• README.md: 项目的主 README 文件，包含项目的基本信息和使用说明。
• go.mod: Go 模块文件，定义了项目的依赖关系。

2. 项目的启动文件介绍

项目的启动文件主要是 database/otelsql/otelsql.go 和 gorm/otelgorm/otelgorm.go。

database/otelsql/otelsql.go

该文件包含了针对 database/sql 包的 OpenTelemetry 插桩实现。主要功能是记录数据库查询并报告 DBStats 指标。

gorm/otelgorm/otelgorm.go

该文件包含了针对 GORM 的 OpenTelemetry 插桩实现。主要功能是记录数据库查询并报告 DBStats 指标。

3. 项目的配置文件介绍

项目没有明确的配置文件，但可以通过代码中的选项进行配置。

database/otelsql/otelsql.go

在 otelsql.go 中，可以通过以下方式进行配置：

import (
    "github.com/uptrace/opentelemetry-go-extra/otelsql"
    semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
)

db, err := otelsql.Open("sqlite", "file::memory:?cache=shared", otelsql.WithAttributes(semconv.DBSystemSqlite))

gorm/otelgorm/otelgorm.go

在 otelgorm.go 中，可以通过以下方式进行配置：

import (
    "github.com/uptrace/opentelemetry-go-extra/otelgorm"
    "gorm.io/driver/sqlite"
    "gorm.io/gorm"
)

db, err := gorm.Open(sqlite.Open("file::memory:?cache=shared"), &gorm.Config{})
if err != nil {
    panic(err)
}
if err := db.Use(otelgorm.NewPlugin()); err != nil {
    panic(err)
}

通过这些配置选项，可以自定义插桩的行为和属性。