Argus

Hızlı başlangıç

Üç adım: paketi kur, anahtarı ver, ilk isteği at. SDK sıfır bağımlılıkla gelir, gövde okumaz, arızasında sizi düşürmez.

API anahtarını panelden alırsınız: Ayarlar → Yeni anahtar. Düz metin yalnızca oluşturulduğu anda bir kez gösterilir; Argus veritabanında yalnızca SHA-256 özeti durur. Anahtar sunucu tarafında, ARGUS_API_KEY gibi herkese açık öneksiz bir ortam değişkeninde kalmalı.

Paketi kur

Node 18 ve üzeri gerekir. Paket Express, NestJS ve çıplak http ile aynı şekilde çalışır.

Terminal

npm install @argus/node

Middleware'i ekle

Middleware'i mümkün olduğunca erken kaydedin ki her isteği görsün. endpoint Argus backend'inizin adresidir; her örnekte açıkça verin. Seçeneğin varsayılanı https://api.argus.dev'dir ama barındırılan Argus henüz hizmette değil: bugün kendi Argus backend'inizin adresini yazarsınız. ignorePaths sağlık ucu gibi gürültüyü dışarıda tutar.

Kurulum

import express from 'express'
import { argus } from '@argus/node'

const app = express()

app.use(
  argus({
    apiKey: process.env.ARGUS_API_KEY,
    endpoint: 'https://argus.sirketiniz.com', // Argus backend'iniz; yerelde http://localhost:3004
    ignorePaths: ['/health'],
  }),
)

app.get('/users/:id', (req, res) => res.json({ id: req.params.id }))
app.listen(3000)

apiKey eksikse SDK bir kez uyarı yazar ve isteği olduğu gibi geçiren boş bir middleware döner; açılışta asla throw etmez.

İlk isteği at

Uygulamanıza herhangi bir istek gönderin. Olaylar 50 tane birikince ya da en geç 5 saniyede bir gönderilir; panelin Canlı akış ekranında en geç birkaç saniye içinde belirir.

Terminal

curl http://localhost:3000/users/42

Panelde /users/42 değil /users/:id görürsünüz. Gerçek kimlikler süreçten çıkmaz; bu bir ayar değil, değişmez ilke.

Bütün seçenekler

Deploy hattını koru

@argus/ci build'den sonra koşar, bundle'da sızmış anahtar ve lockfile'da değişen hash ararken deploy'u kırabilir. Üç adım yeter:

.github/workflows/ci.yml

- uses: actions/checkout@v4
  with:
    fetch-depth: 0 # lockfile karşılaştırması için temel commit gerekir
- run: npm ci && npm run build
- run: npx argus-ci
  env:
    ARGUS_CI_BASE_REF: ${{ github.event.pull_request.base.sha || github.event.before }}
@argus/ci belgesi

Sırada ne var