Typescript SDK | Alephant Documentation

官方 Alephant Analytics TypeScript SDK 让 TypeScript 和 Node.js 应用程序能够访问 Alephant Analytics API。它让您可以查询遥测数据、获取每日用量序列，并检索用于 FinOps 仪表板的实时汇总统计信息。

安装

通过 npm、yarn 或 pnpm 安装 SDK：

$ npm install @alephantai/logs-collector-analytics

初始化

导入并初始化客户端。默认环境为开发环境（https://analytics-dev.alephant.io）。仅在生产 Analytics 服务已部署后使用生产环境。

1 import {
2   LogsCollectorAnalyticsClient,
3   LogsCollectorAnalyticsEnvironment,
4 } from "@alephantai/logs-collector-analytics";
5 
6 const client = new LogsCollectorAnalyticsClient({
7   environment: LogsCollectorAnalyticsEnvironment.Development,
8 });

使用示例

冒烟测试

使用公开 health 端点验证 SDK 能否连接到 Analytics 开发服务。

1 const health = await client.analyticsAtomic.getHealth();
2 console.log(health.data.status);

实时 24 小时面板

获取滚动实时 24 小时仪表板面板。经过身份验证的 SaaS analytics 路由接受作为请求字段的 Authorization 和 X-Workspace-Id 请求头。

1 async function fetchLivePanel() {
2   try {
3     const response = await client.analyticsSaas.getSaasLive24H({
4       limit: 5,
5       Authorization: `Bearer ${process.env.ALEPHANT_API_TOKEN}`,
6       "X-Workspace-Id": process.env.ALEPHANT_WORKSPACE_ID,
7     });
8 
9     console.log(response.data);
10   } catch (error) {
11     console.error("Failed to fetch live panel:", error);
12   }
13 }

获取用量序列

获取指定日期范围内的每日用量指标。

1 async function fetchCostTimeseries() {
2   const response = await client.analyticsSaas.getSaasUsage({
3     dateFrom: "2026-03-01",
4     dateTo: "2026-03-31",
5     Authorization: `Bearer ${process.env.ALEPHANT_API_TOKEN}`,
6     "X-Workspace-Id": process.env.ALEPHANT_WORKSPACE_ID,
7   });
8 
9   console.log(response.data);
10 }

错误处理

SDK 会针对非 2xx API 响应抛出结构化错误，让您能够以编程方式妥善处理身份验证、速率限制或验证错误。