# @arizeai/phoenix-config 中文文档

规范地址：https://npmcn.com/package/%40arizeai/phoenix-config/

版本：0\.5\.1
npm 元数据更新时间：2026-10-21T16:07:27.714Z
中文译文更新时间：2026-11-06T19:19:49.617Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40arizeai/phoenix-config
原文对照：https://npmcn.com/package/%40arizeai/phoenix-config/?lang=original
项目主页：https://github.com/Arize-ai/phoenix/tree/main/js/packages/phoenix-config
源码仓库：https://github.com/Arize-ai/phoenix

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：979 kB，152 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2025-12-18T20:26:34.453Z
- 最新版本发布：2026-10-21T16:07:27.289Z
- 近 30 天下载量：269697（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

凤凰城中央配置

## 安装

```sh
npm install @arizeai/phoenix-config
```

也可以使用：`pnpm add @arizeai/phoenix-config`、`yarn add @arizeai/phoenix-config`、`bun add @arizeai/phoenix-config`

## README

# 

[![Arize Phoenix logo](https://raw.githubusercontent.com/Arize-ai/phoenix-assets/refs/heads/main/logos/Phoenix/phoenix.svg)](https://phoenix.arize.com/?utm_medium=github&utm_content=header_img&utm_campaign=phoenix-config)  
@arizeai/凤凰-配置

 [![NPM Version](https://img.shields.io/npm/v/%40arizeai%2Fphoenix-config)](https://www.npmjs.com/package/@arizeai/phoenix-config)[![Documentation](https://img.shields.io/badge/docs-blue?logo=typescript&logoColor=white)](https://arize-ai.github.io/phoenix/)

共享配置解析全局使用的公用设施 `@arizeai/phoenix-otel` 财务报告和审定财务报表 `@arizeai/phoenix-client`。为阅读凤凰城环境变量提供输入的帮助.

## 安装

```bash
npm install @arizeai/phoenix-config
```

## 环境变量

| 变量 | 常数 | 说明 |
| --- | --- | --- |
| `PHOENIX_ENDPOINT` | `ENV_PHOENIX_ENDPOINT` | API 访问的凤凰基地 URL |
| `PHOENIX_HOST` | `ENV_PHOENIX_HOST` | Phoenix 服务器绑定主机; 仅读作 API 基础 URL 的后退 |
| `PHOENIX_API_KEY` | `ENV_PHOENIX_API_KEY` | 凤凰城认证的 API 密钥 |
| `PHOENIX_CLIENT_HEADERS` | `ENV_PHOENIX_CLIENT_HEADERS` | JSON 客户端请求的自定义头 |
| `PHOENIX_COLLECTOR_ENDPOINT` | `ENV_PHOENIX_COLLECTOR_ENDPOINT` | OTel 收藏器端点 URL |
| `PHOENIX_PORT` | `ENV_PHOENIX_PORT` | Phoenix HTTP 端口( 整数) |
| `PHOENIX_GRPC_PORT` | `ENV_PHOENIX_GRPC_PORT` | 凤凰GRPC 端口用于 OpenTeleometry (整数) |
| `PHOENIX_PROJECT` | `ENV_PHOENIX_PROJECT` | 项目范围操作的默认项目名称( canonical) |
| `PHOENIX_PROJECT_NAME` | `ENV_PHOENIX_PROJECT_NAME` | 支持的别名 `PHOENIX_PROJECT` |
| `PHOENIX_LOG_LEVEL` | `ENV_PHOENIX_LOG_LEVEL` | 日志动词 : `debug`, (中文(简体) ), `info`, (中文(简体) ), `warn`, (中文(简体) ), `error`,或 `silent` |
| `PHOENIX_DISCOVER_CONFIG` | `ENV_PHOENIX_DISCOVER_CONFIG` | 设定为 `false` 无法禁用 `.env.phoenix` 文件发现 |

## 证书文件发现( I)`.env.phoenix`(中文(简体) )

当进程环境中没有设置凤凰城设置时, 帮助者会查看 (单位:千美元) `.env.phoenix` 当前工作目录中的文件——向上走 文件系统根并停止在第一次匹配中——并读取 `PHOENIX_`\- 其前缀密钥( dotenv格式) :

添加 `.env.phoenix` 在存储证书之前忽略规则 在此文件中(凤凰城寄存器已忽略它) .

```bash
# .env.phoenix
PHOENIX_COLLECTOR_ENDPOINT=http://localhost:6006
PHOENIX_API_KEY=your-api-key
```

进程环境变量总是优先——文件从不覆盖 任何已设置的键 `PHOENIX_` 前缀被忽略。 相关 设置按组解决:当任何证书时(`PHOENIX_API_KEY`, (中文(简体) ), `PHOENIX_CLIENT_HEADERS`) 设置在进程环境中,文件被忽略 用于整个证书组,所以程序和文件证书从来不是混合的. 设定 `PHOENIX_DISCOVER_CONFIG=false` 完全禁用发现.

一个终点从 `.env.phoenix` 仍可结合提供全权证书 明确或通过过程环境。 消费者发出一次性警告 指定证书来源、端点变量和已发现文件的大小写; 认证值从未被记录 。 了解来源的消费者应使用 `getStrFromEnvironmentWithSource()` 财务报告和审定财务报表 `getCredentialsFromEnvironmentWithSource()` 而不是重建 源层本身.

发现结果被缓存到每个工作目录中 进程(包括没有文件)。 创建长期运行的进程 第一个配置搜索后的文件可以调用 `clearEnvFileCache()` 改为 重新发现它.

## 使用量

### 读取全部配置

```typescript
import { getEnvironmentConfig } from "@arizeai/phoenix-config";

const config = getEnvironmentConfig();
// Returns a typed object with all recognized Phoenix env vars:
// {
//   PHOENIX_HOST: "http://localhost:6006",
//   PHOENIX_API_KEY: "my-key",
//   PHOENIX_CLIENT_HEADERS: { "X-Custom": "value" },
//   PHOENIX_COLLECTOR_ENDPOINT: "http://localhost:6006",
//   PHOENIX_PORT: 6006,
//   PHOENIX_GRPC_PORT: 4317,
//   PHOENIX_LOG_LEVEL: "info",
//   PHOENIX_PROJECT: "my-project",
// }
```

### 解决工程名称

`PHOENIX_PROJECT` 是条形工程名称变量; `PHOENIX_PROJECT_NAME` 是一个支持的别名。 使用 `getProjectFromEnvironment()` 以 正确的优先级(`PHOENIX_PROJECT` 赢; 如果 两者被设定为相互冲突的价值观:

```typescript
import { getProjectFromEnvironment } from "@arizeai/phoenix-config";

const project = getProjectFromEnvironment();
// Reads PHOENIX_PROJECT, then PHOENIX_PROJECT_NAME, or undefined if neither is set
```

### 读取个人价值

```typescript
import {
  getStrFromEnvironment,
  getIntFromEnvironment,
  getHeadersFromEnvironment,
  ENV_PHOENIX_ENDPOINT,
  ENV_PHOENIX_PORT,
  ENV_PHOENIX_CLIENT_HEADERS,
} from "@arizeai/phoenix-config";

// Read a string environment variable
const endpoint = getStrFromEnvironment(ENV_PHOENIX_ENDPOINT);
// Returns "http://localhost:6006" or undefined

// Read an integer environment variable
const port = getIntFromEnvironment(ENV_PHOENIX_PORT);
// Returns 6006 or undefined

// Read and parse a JSON-encoded headers object
const headers = getHeadersFromEnvironment(ENV_PHOENIX_CLIENT_HEADERS);
// Returns { "Authorization": "Bearer token" } or undefined
```

### 使用常数

```typescript
import {
  ENV_PHOENIX_ENDPOINT,
  ENV_PHOENIX_HOST,
  ENV_PHOENIX_API_KEY,
  ENV_PHOENIX_CLIENT_HEADERS,
  ENV_PHOENIX_COLLECTOR_ENDPOINT,
  ENV_PHOENIX_PORT,
  ENV_PHOENIX_GRPC_PORT,
  ENV_PHOENIX_PROJECT_NAME,
  ENV_PHOENIX_PROJECT,
  ENV_PHOENIX_LOG_LEVEL,
} from "@arizeai/phoenix-config";

// Use constants instead of raw strings to avoid typos
const apiKey = process.env[ENV_PHOENIX_API_KEY];
```

## 类型

```typescript
import type { EnvironmentConfig } from "@arizeai/phoenix-config";
// Inferred return type of getEnvironmentConfig()
```

## 社区

加入我们的社区,与成千上万的人工智能建设者建立联系:

-   加入我们的行列 [黑社会](https://join.slack.com/t/arize-ai/shared_invite/zt-3r07iavnk-ammtATWSlF0pSrd1DsMW7g)。 。 。 .
-   读取 [凤凰网文献](https://arize.com/docs/phoenix)。 。 。 .
-   \* 提问并提供反馈 _#凤凰支持 #_ 频道.
-   留下一颗星星在我们身上 [GitHub 图像](https://github.com/Arize-ai/phoenix)。 。 。 .
-   报告错误 [GitHub 问题](https://github.com/Arize-ai/phoenix/issues)。 。 。 .
-   X 跟着我们 [页:1](https://twitter.com/ArizePhoenix)。 。 。 .
-   跟着我们 [链接](https://www.linkedin.com/showcase/113218220)。 。 。 .

## 常见问题

### @arizeai/phoenix-config 是什么？

凤凰城中央配置

### 如何安装 @arizeai/phoenix-config？

在项目目录运行 npm install @arizeai/phoenix-config，或使用 pnpm add / yarn add / bun add。

### @arizeai/phoenix-config 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @arizeai/phoenix-config 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @arizeai/phoenix-config 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @arizeai/phoenix-config 可以商用吗？

@arizeai/phoenix-config 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @arizeai/phoenix-config 的下载量有多少？

根据 npm 官方下载统计，@arizeai/phoenix-config 在 2026/10/07 – 2026/11/05 这 30 天内被下载 269,697 次，日均约 8,990 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @arizeai/phoenix-config 还在维护吗？

最新版本 0\.5\.1 发布于 2026/10/22（17 天前）；至今共发布 11 个版本，其中过去 12 个月发布了 11 个；首次发布于 2025/12/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。