Pydantic/Logfire 项目：如何创建和使用写入令牌

Pydantic/Logfire 项目：如何创建和使用写入令牌

什么是 Logfire 写入令牌

在 Pydantic 的 Logfire 项目中，写入令牌（Write Token）是一个关键的安全凭证，它允许你将日志和监控数据发送到特定的 Logfire 项目。这个令牌相当于一个数字钥匙，确保只有授权的应用程序才能向你的项目发送数据。

为什么需要写入令牌

1. 身份验证：确保只有你授权的应用可以发送数据
2. 项目隔离：每个令牌对应一个特定项目，防止数据混淆
3. 安全控制：可以随时撤销或创建新令牌，而不影响其他应用

如何创建写入令牌

步骤详解

1. 访问 Logfire 控制台：打开 Logfire 的 Web 界面
2. 选择目标项目：在左侧导航栏中找到并选择你要配置的项目
3. 进入设置页面：点击右上角的齿轮图标（⚙️）进入设置
4. 选择写入令牌标签：在左侧菜单中选择 {} Write tokens 选项
5. 创建新令牌：点击 Create write token 按钮生成新令牌

重要注意事项

• 令牌生成后会立即显示，请立即复制并妥善保存
• 出于安全考虑，令牌只会显示一次，之后无法再次查看
• 建议为不同环境（开发、测试、生产）创建不同的令牌

如何使用写入令牌

基本使用方法

创建令牌后，你有两种主要方式来使用它：

1. 环境变量方式（推荐）：

   export LOGFIRE_TOKEN='你的令牌值'
   

   然后在代码中无需显式指定令牌，Logfire 会自动从环境变量中读取

2. 代码显式指定：

   import logfire
   
   logfire.configure(token='你的令牌值')
   

生产环境最佳实践

对于生产环境，我们强烈建议：

• 使用环境变量而非硬编码令牌
• 通过配置管理系统或容器编排工具管理敏感信息
• 定期轮换（更换）令牌以提高安全性

高级配置选项

条件性发送数据

Logfire 提供了灵活的配置选项，允许你根据环境决定是否发送数据：

logfire.configure(
    send_to_logfire='if-token-present',
    # 其他配置...
)

这个配置表示：

• 如果检测到有效的 LOGFIRE_TOKEN，则发送数据
• 如果没有令牌，则不发送数据

环境变量控制

你也可以通过环境变量控制这一行为：

# 强制发送数据
export LOGFIRE_SEND_TO_LOGFIRE=true

# 禁止发送数据
export LOGFIRE_SEND_TO_LOGFIRE=false

这种配置特别适合以下场景：

• 本地开发时不发送数据（设置 false）
• CI/CD 流水线中不发送测试数据（设置 false）
• 生产环境强制发送数据（设置 true）

安全建议

1. 令牌保管：将令牌视为密码，不要提交到版本控制系统
2. 最小权限：只为需要的应用创建令牌
3. 定期轮换：定期更换令牌，特别是当团队成员变动时
4. 访问监控：定期检查谁在使用哪些令牌

常见问题解答

Q：我可以在多个环境中使用同一个写入令牌吗？

A：技术上可以，但不建议。最佳实践是为每个环境（开发、测试、生产）创建单独的令牌，这样如果某个令牌泄露，你可以单独撤销它而不影响其他环境。

Q：令牌泄露了怎么办？

A：立即在 Logfire 控制台中删除泄露的令牌，然后创建一个新令牌更新所有使用它的应用。

Q：如何知道哪个应用在使用哪个令牌？

A：建议在创建令牌时添加描述性名称，如"生产后端服务-2023-11"，并在文档中记录令牌使用情况。

通过合理使用写入令牌，你可以安全高效地管理 Logfire 项目的数据收集工作，同时保持对数据流的完全控制。