Definitions
More definitions
Saved views, notification channels, enrichers, health rules and people.
Views
import { defineView } from 'vigie/sdk'
export const failedCheckouts = defineView({
id: 'failed-checkouts',
name: 'Failed checkouts',
scope: 'logs',
filter: JSON.stringify({ q: 'checkout', kind: 'request', level: 'error' }),
})
Shows up beside the views people save in the app. filter is the same JSON the Logs screen saves.
Channels
import { defineChannel } from 'vigie/sdk'
export const pager = defineChannel({
name: 'pager',
send: async ({ title, text }) => {
await fetch('https://pager.acme.dev/hooks/vigie', { method: 'POST', body: JSON.stringify({ title, text }) })
},
})
A notification channel of your own. Alerts reach it like Slack or email; notify: 'pager' targets it.
Enrichers
import { defineEnricher } from 'vigie/sdk'
const plans = new Map([['acc_1', 'enterprise']])
export const plan = defineEnricher({
name: 'Account plan',
signal: 'logs',
enrich: (attrs) => (attrs['account.id'] ? { 'account.plan': plans.get(attrs['account.id']) ?? 'free' } : undefined),
})
Adds fields at ingest, before storage. Keep it fast: it runs on every row.
Health rules
import { defineHealthRule } from 'vigie/sdk'
export const backlog = defineHealthRule({
name: 'Backlog over 500',
card: 'flow',
check: (facts) => (facts.due > 500 ? 'bad' : facts.due > 100 ? 'warn' : undefined),
})
Turns a card on Tasks red or amber. facts has oldestDue, due, scheduled, failedShare, attempts, workers and lost.
People
import { defineIdentity } from 'vigie/sdk'
export const people = defineIdentity({
name: 'Acme users',
people: async () => (await fetch('https://api.acme.dev/internal/users')).json(),
})
Turns user.id into names on every screen.