酒店中间件

写作 社区

技能解读

当前原文的自动摘译,尚未人工审校。

必需品

导入路径必须包含/v2:github.com/adlandh/echo-otel-middleware/v2。别名示例为echootelmiddleware,以匹配包名称和自述文件。该中间件以 Echo v5 为目标:使用 github.com/labstack/echo/v5 并使用 *echo.Context 处理程序签名。 Middleware() 使用全局 OpenTelemetry 跟踪器提供程序和传播器;当应用程序拥有显式 OTel 设置时,请使用MiddlewareWithConfig。

基本用法

当应用程序构建跟踪器提供程序或传播器时,使用显式配置:

配置默认值

TracerProvider:otel.GetTracerProvider()。 Propagator:otel.GetTextMapPropagator()。 Skipper:回声middleware.DefaultSkipper。 BodySkipper:无操作,返回false, false。 AreHeadersDump:true。

安全倾倒尸体

身体转储是IsBodyDump: true 的选择,因为它可以捕获 PII、令牌和秘密。首选BodySkipper排除敏感端点、压缩体、上传、身份验证有效负载或大型响应。 BodySkipper仅在IsBodyDump为真时运行并返回(skipReqBody, skipRespBody)。

属性限制

LimitNameSize和LimitValueSize是基于字节的,而不是基于符文的。截断保留有效的 UTF-8;超过限制且大于 10 的值会得到尾随 ...。 RemoveNewLines 用字符串属性中的空格替换 \n,对于 Sentry 等后端很有用。

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
写作
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@tomevault-io · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
即装即用
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

作者说明文件(原文) SKILL.md

# Skill: golang-echo-otel-middleware

Use this skill when adding or configuring `github.com/adlandh/echo-otel-middleware/v2` in a Go Echo application, or when writing examples for this middleware.

## Essentials

- Import path must include `/v2`: `github.com/adlandh/echo-otel-middleware/v2`.
- Alias examples as `echootelmiddleware` to match the package name and README.
- This middleware targets Echo v5: use `github.com/labstack/echo/v5` and handler signatures with `*echo.Context`.
- `Middleware()` uses global OpenTelemetry tracer provider and propagator; use `MiddlewareWithConfig` when the app owns explicit OTel setup.

## Basic Usage

```go
app := echo.New()
app.Use(echootelmiddleware.Middleware())
```

Use explicit config when a tracer provider or propagator is constructed by the application:

```go
app.Use(echootelmiddleware.MiddlewareWithConfig(echootelmiddleware.OtelConfig{
	TracerProvider: tp,
	Propagator:     otel.GetTextMapPropagator(),
}))
```

## Config Defaults

- `TracerProvider`: `otel.GetTracerProvider()`.
- `Propagator`: `otel.GetTextMapPropagator()`.
- `Skipper`: Echo `middleware.DefaultSkipper`.
- `BodySkipper`: no-op, returns `false, false`.
- `AreHeadersDump`: `true`.
- `IsBodyDump`: `false`.
- `RemoveNewLines`: `false`.
- `LimitNameSize` and `LimitValueSize`: `0`, meaning unlimited.

## Safe Body Dumping

- Body dumping is opt-in with `IsBodyDump: true` because it can capture PII, tokens, and secrets.
- Prefer `BodySkipper` to exclude sensitive endpoints, compressed bodies, uploads, auth payloads, or large responses.
- `BodySkipper` only runs when `IsBodyDump` is true and returns `(skipReqBody, skipRespBody)`.

```go
BodySkipper: func(c *echo.Context) (bool, bool) {
	if c.Request().Header.Get("Content-Encoding") == "gzip" {
		return true, true
	}
	return false, false
},
```

## Attribute Limits

- `LimitNameSize` and `LimitValueSize` are byte-based, not rune-based.
- Truncation preserves valid UTF-8; values over a limit greater than 10 get a trailing `...`.
- `RemoveNewLines` replaces `\n` with spaces in string attributes, useful for backends such as Sentry.

## Do Not Assume

- Metrics are not implemented in this middleware; do not add or document metrics unless explicitly requested.
- Echo v4 examples are wrong for this package because context types and imports differ.

---
> Source: [adlandh/echo-otel-middleware](https://github.com/adlandh/echo-otel-middleware) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-05-23 -->

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。