@civitai/next-axiom

中文文档
0.17.0发布于 2024/09/18MITTypeScriptCommonJS近 30 天下载 1.2万

下一轴0.17分叉

中文使用文档
文档目录7 节
  1. 安装
  2. 使用 Vercel 集成
  3. 使用任何其它平台
  4. 使用量
  5. 网络维度
  6. 日志级别
  7. 获取服务软件

next-axiom: The official Next.js library for Axiom next-axiom: The official Next.js library for Axiom

build Latest release License

轴 解锁任何尺度的可观察性.

  • 轻而易举地储存: Axiom 的下一代数据存储器能够以最高效率摄取多字节的数据。 出自库贝内特斯,AWS,Azure,Google Cloud,DigitalOcean,Nomad等地的船舶日志.
  • 询问一切,所有的时间: 无论是DevOps, SecOps, 还是EverythingOps, 都查询您的所有数据, 不管它的年龄大小 。 不提供数据,不将数据从冷藏/存档转移到“热”上,也不担心询问缓慢。 所有你的数据,所有。 时间.
  • 强力仪表板,用于持续可观察性: 建立仪表板来收集相关查询,并给出您和您的团队可以快速和轻松地消化的信息. Dashboards可以保持私有或与他人共享,是汇集不同来源数据的完美方法.

详情请查看 正式文件。 。 。 .

安装

使用 Vercel 集成

确保你有 Axiom Vercel 集成系统 已安装。 完成后,采取以下步骤:

  • 在您的 Next.js 工程中, 运行安装 next-axiom 内容如下:
npm install --save next-axiom
  • 在那个 next.config.js 文件,将您的 Next.js 配置包入 withAxiom 内容如下:
const { withAxiom } = require('next-axiom');

module.exports = withAxiom({
  // ... your existing config
});

使用任何其它平台

在其中创建 API 令牌 轴设置 并导出为 AXIOM_TOKEN,以及 Axiom 数据集名称为 AXIOM_DATASET完成后,采取以下步骤:

  • 在您的 Next.js 工程中, 运行安装 next-axiom 内容如下:
npm install --save next-axiom
  • 在那个 next.config.js 文件,将您的 Next.js 配置包入 withAxiom 内容如下:
const { withAxiom } = require('next-axiom');

module.exports = withAxiom({
  // ... your existing config
});

: 警告: next-axiom 仍然对非Vercel平台进行实验,并可能有所改变.

使用量

网络维度

:警告:Next.js 13及以上版本尚未支持Web-Vitals. 请使用Next.js 12或以下.

转到 pages/_app.js 或者说 pages/_app.ts 并添加以下一行以报告网络生命值:

export { reportWebVitals } from 'next-axiom';

说明: WebVitals只从生产部署发送.

将处理器包入 withAxiom 将做 req.log 可用和日志 例外情况:

: 警告: Nextjs 13.x 服务器侧组件尚未支持.

import { withAxiom, AxiomAPIRequest } from 'next-axiom';

async function handler(req: AxiomAPIRequest, res: NextApiResponse) {
  req.log.info('Login function called');

  // You can create intermediate loggers
  const log = req.log.with({ scope: 'user' });
  log.info('User logged in', { userId: 42 });

  res.status(200).text('hi');
}

export default withAxiom(handler);

进口和使用 log 在前端像这样:

import { log } from `next-axiom`;

// pages/index.js
function home() {
    ...
    log.debug('User logged in', { userId: 42 })
    ...
}

日志级别

日志级别定义发送到 Axiom 的最低日志级别 . 默认是调试, 导致所有日志被发送 . 可用水平(从最低到最高): debug, (中文(简体) ), info, (中文(简体) ), warn, (中文(简体) ), error

例如, 如果您不想调试日志被发送到 Axiom :

export AXIOM_LOG_LEVEL=info

您也可以通过设置日志级别来完全禁用日志 off数字 :

export AXIOM_LOG_LEVEL=off

获取服务软件

能够使用下一条轴 getServerSideProps 您需要用 withAxiomGetServerSideProps不存在 如果使用 ServerSideProps , 此时可自动检测.

import { withAxiomGetServerSideProps } from 'next-axiom'
export const getServerSideProps = withAxiomGetServerSideProps(async ({ req, log })  => {
  log.info('Hello, world!');
  return {
    props: {
    },
  }
});


### License

Distributed under the [MIT License](LICENSE).

版本与发布记录

@civitai/next-axiom 共发布 1 个版本,首次发布于 2024/09/18;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.17.0latest2024/09/182 年前

关于 @civitai/next-axiom 的常见问题

@civitai/next-axiom 是什么?

下一轴0.17分叉

如何安装 @civitai/next-axiom?

在项目目录运行 npm install @civitai/next-axiom,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:next(^12.1.4 || ^13 || ^14)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@civitai/next-axiom 支持 TypeScript 吗?

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

@civitai/next-axiom 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@civitai/next-axiom 需要什么版本的 Node.js?

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

@civitai/next-axiom 可以商用吗?

@civitai/next-axiom 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@civitai/next-axiom 的下载量有多少?

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

@civitai/next-axiom 还在维护吗?

最新版本 0.17.0 发布于 2024/09/18(2 年前);至今共发布 1 个版本,其中过去 12 个月发布了 0 个;首次发布于 2024/09/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。