Skip to content

安装

选择适合你工作流的安装方式。

方式 1:Claude Code 插件(推荐)

Kafka Log Analyzer 设计为 Claude Code Plugin,提供无缝集成体验。

方法 A:插件市场

bash
# 在 Claude Code 中运行:
/plugin marketplace add saqqdy/kafka-log-analyzer
/plugin install kafka-log-analyzer

方法 B:本地安装

bash
# 1. 进入你的项目
cd your-project

# 2. 安装 npm 包
pnpm add -D kafka-log-analyzer

# 3. 复制技能文件
mkdir -p .claude/skills
cp -r node_modules/kafka-log-analyzer/.claude/skills/kafka-log-analyzer .claude/skills/

安装完成后,在 Claude Code 中使用 /kafka-analyze 命令。

方式 2:NPM 包

在 Node.js/TypeScript 项目中编程使用:

bash
pnpm add kafka-log-analyzer
typescript
import { analyzeLog } from 'kafka-log-analyzer'

const result = await analyzeLog({
  source: 'file',
  path: '/var/log/kafka/server.log',
  focus: ['producer', 'error'],
  timeline: '1h'
})

console.log(`总事件数: ${result.summary.total}`)
console.log(`P0: ${result.summary.byPriority.P0}`)

方式 3:CLI(零安装)

直接使用 npx 运行,无需安装:

bash
# 在任意目录
npx kafka-log-analyze --source file --path /var/log/kafka/server.log
npx kafka-log-analyze --source paste <<EOF
[2024-01-15 10:00:01] ERROR [producer] Failed to send record
EOF

方式 4:克隆并探索

用于开发或探索示例:

bash
git clone https://github.com/saqqdy/kafka-log-analyzer.git
cd kafka-log-analyzer
pnpm install

# 构建并运行
pnpm run build
node dist/cli.js --source file --path tests/fixtures/sample-kafka-log.txt

验证

验证安装是否成功:

bash
# CLI
npx kafka-log-analyze --help

# Node.js
node -e "console.log(require('kafka-log-analyzer').version)"

下一步

基于 MIT 许可发布