云端

Axiom 适配器

将广泛事件发送到 Axiom，以进行强大的查询、仪表板和告警。零配置设置，使用环境变量和自动批处理。

Axiom 是一个具有强大查询能力的云原生日志平台。evlog Axiom 适配器会将你的广泛事件直接发送到 Axiom 数据集。

添加 Axiom 排水适配器

安装

Axiom 适配器随 evlog 一起打包提供：

src/index.ts

import { createAxiomDrain } from 'evlog/axiom'

快速开始

1. 获取你的 Axiom 凭证

创建一个 Axiom 账户
创建一个用于日志的数据集
生成一个具有写入权限的 API 令牌

2. 设置环境变量

.env

AXIOM_API_KEY=xaat-your-token-here
AXIOM_DATASET=your-dataset-name

在 Axiom 的仪表板中，这个凭证称为 API token（xaat-...）。evlog 将配置字段命名为 apiKey，以便在各个适配器之间保持一致。旧的 token / AXIOM_TOKEN 仍然可用，直到下一个主要版本发布。

3. 将 drain 接入你的框架

// server/plugins/evlog-drain.ts
import { createAxiomDrain } from 'evlog/axiom'

export default defineNitroPlugin((nitroApp) => {
  nitroApp.hooks.hook('evlog:drain', createAxiomDrain())
})

// lib/evlog.ts
import { createEvlog } from 'evlog/next'
import { createAxiomDrain } from 'evlog/axiom'

export const { withEvlog, useLogger, log, createError } = createEvlog({
  service: 'my-app',
  drain: createAxiomDrain(),
})

import { createAxiomDrain } from 'evlog/axiom'

app.use(evlog({ drain: createAxiomDrain() }))

import { createAxiomDrain } from 'evlog/axiom'

app.use(evlog({ drain: createAxiomDrain() }))

import { createAxiomDrain } from 'evlog/axiom'

await app.register(evlog, { drain: createAxiomDrain() })

import { createAxiomDrain } from 'evlog/axiom'

app.use(evlog({ drain: createAxiomDrain() }))

import { createAxiomDrain } from 'evlog/axiom'

EvlogModule.forRoot({ drain: createAxiomDrain() })

import { createAxiomDrain } from 'evlog/axiom'

initLogger({ drain: createAxiomDrain() })

就是这样！你的日志现在会显示在 Axiom 中。

配置

该适配器从多个来源读取配置（优先级从高到低）：

传递给 createAxiomDrain() 的 覆盖项
运行时配置 在 runtimeConfig.axiom（仅限 Nuxt/Nitro）
环境变量（AXIOM_* 或 NUXT_AXIOM_*）

环境变量

Variable	Nuxt alias	Description
`AXIOM_API_KEY`	`NUXT_AXIOM_API_KEY`	具有摄取权限的 Axiom API token
`AXIOM_DATASET`	`NUXT_AXIOM_DATASET`	要将日志摄取到其中的数据集名称
`AXIOM_ORG_ID`	`NUXT_AXIOM_ORG_ID`	组织 ID（个人访问令牌需要）
`AXIOM_EDGE_URL`	`NUXT_AXIOM_EDGE_URL`	摄取/查询的 Edge 基础 URL（适用于 edge 部署）
`AXIOM_URL`	`NUXT_AXIOM_URL`	API 基础 URL（旧版/默认摄取端点）

在 Nuxt/Nitro 中，请使用 NUXT_ 前缀，以便通过 useRuntimeConfig() 获取这些值。在其他所有框架中，请使用无前缀的变量。

运行时配置（仅限 Nuxt）

通过 nuxt.config.ts 进行类型安全的配置：

nuxt.config.ts

export default defineNuxtConfig({
  runtimeConfig: {
    axiom: {
      apiKey: '', // 通过 NUXT_AXIOM_API_KEY 设置
      dataset: '', // 通过 NUXT_AXIOM_DATASET 设置
    },
  },
})

覆盖选项

直接传递选项以覆盖任何配置：

server/plugins/evlog-drain.ts

const drain = createAxiomDrain({
  dataset: 'production-logs',
  timeout: 10000,
})

完整配置参考

Option	Type	Default	Description
`apiKey`	`string`	-	Axiom API token（必需）
`token`	`string`	-	已弃用。请改用 `apiKey`
`dataset`	`string`	-	数据集名称（必需）
`orgId`	`string`	-	组织 ID（适用于 PAT 令牌）
`edgeUrl`	`string`	-	用于摄取的 Edge URL。如果未提供路径，则使用 `/v1/ingest/{dataset}`；自定义路径将按原样使用（会去除末尾斜杠）。与 `baseUrl` 互斥
`baseUrl`	`string`	`https://api.axiom.co`	API 基础 URL（`/v1/datasets/{dataset}/ingest`），与 `edgeUrl` 互斥
`timeout`	`number`	`5000`	请求超时时间，单位为毫秒

在 Axiom 中查询日志

evlog 发送结构化广泛事件，非常适合 Axiom 的 APL 查询语言：

Axiom APL 查询

// 查找慢速请求
['your-dataset']
| where duration > 1000
| project timestamp, path, duration, status

// 按端点统计错误率
['your-dataset']
| where level == "error"
| summarize count() by path
| order by count_ desc

// 随时间统计请求量
['your-dataset']
| summarize count() by bin(timestamp, 1h)
| render timechart

故障排除

Missing dataset or apiKey error

Console

[evlog/axiom] Missing dataset or apiKey. Set NUXT_AXIOM_API_KEY/NUXT_AXIOM_DATASET env vars or pass to createAxiomDrain()

请确保已设置环境变量并在添加后重新启动服务器。

401 未授权

你的令牌可能无效或已过期。在 Axiom 仪表板中生成一个具有写入权限的新令牌。

403 禁止（使用个人访问令牌）

个人访问令牌需要组织 ID：

.env

AXIOM_ORG_ID=your-org-id

直接 API 使用

对于高级用例，你可以使用更低层级的函数：

server/utils/axiom.ts

import { sendToAxiom, sendBatchToAxiom } from 'evlog/axiom'

// 发送单个事件
await sendToAxiom(event, {
  apiKey: 'xaat-xxx',
  dataset: 'logs',
})

// 批量发送多个事件
await sendBatchToAxiom(events, {
  apiKey: 'xaat-xxx',
  dataset: 'logs',
})

下一步

OTLP Adapter - 通过 OpenTelemetry Protocol 发送日志
PostHog Adapter - 将日志发送到 PostHog
Custom Adapters - 构建你自己的适配器
Best Practices - 安全和生产建议

Edit this pageorReport an issue

概述

使用 evlog 适配器将日志发送到外部服务。内置对流行可观测性平台和自定义目标的支持。

OTLP

通过 OpenTelemetry Protocol (OTLP) 向 Grafana、Datadog、Honeycomb 以及任何兼容的后端发送日志。支持 gRPC 和 HTTP 传输。