[{"data":1,"prerenderedAt":846},["ShallowReactive",2],{"navigation_docs":3,"-docs-connect-adonis":150,"-docs-connect-adonis-surround":841},[4,23,41,99,128],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":22},"Getting started","i-lucide-rocket","\u002Fdocs\u002Fgetting-started","docs\u002F1.getting-started",[10,14,18],{"title":11,"path":12,"stem":13},"Introduction","\u002Fdocs\u002Fgetting-started\u002Fintroduction","docs\u002F1.getting-started\u002F1.introduction",{"title":15,"path":16,"stem":17},"Quickstart","\u002Fdocs\u002Fgetting-started\u002Fquickstart","docs\u002F1.getting-started\u002F2.quickstart",{"title":19,"path":20,"stem":21},"How it works","\u002Fdocs\u002Fgetting-started\u002Fhow-it-works","docs\u002F1.getting-started\u002F3.how-it-works",false,{"title":24,"icon":25,"path":26,"stem":27,"children":28,"page":22},"Connect an app","i-lucide-plug","\u002Fdocs\u002Fconnect","docs\u002F2.connect",[29,33,37],{"title":30,"path":31,"stem":32},"Adonis","\u002Fdocs\u002Fconnect\u002Fadonis","docs\u002F2.connect\u002F1.adonis",{"title":34,"path":35,"stem":36},"NestJS","\u002Fdocs\u002Fconnect\u002Fnestjs","docs\u002F2.connect\u002F2.nestjs",{"title":38,"path":39,"stem":40},"Any stack, no SDK","\u002Fdocs\u002Fconnect\u002Fany-stack","docs\u002F2.connect\u002F3.any-stack",{"title":42,"icon":43,"path":44,"stem":45,"children":46,"page":22},"Definitions","i-lucide-code","\u002Fdocs\u002Fdefinitions","docs\u002F3.definitions",[47,51,55,59,63,67,71,75,79,83,87,91,95],{"title":48,"path":49,"stem":50},"Overview","\u002Fdocs\u002Fdefinitions\u002Foverview","docs\u002F3.definitions\u002F01.overview",{"title":52,"path":53,"stem":54},"Log renderers","\u002Fdocs\u002Fdefinitions\u002Flog-renderers","docs\u002F3.definitions\u002F02.log-renderers",{"title":56,"path":57,"stem":58},"Error renderers","\u002Fdocs\u002Fdefinitions\u002Ferror-renderers","docs\u002F3.definitions\u002F03.error-renderers",{"title":60,"path":61,"stem":62},"Processes","\u002Fdocs\u002Fdefinitions\u002Fprocesses","docs\u002F3.definitions\u002F04.processes",{"title":64,"path":65,"stem":66},"Pages","\u002Fdocs\u002Fdefinitions\u002Fpages","docs\u002F3.definitions\u002F05.pages",{"title":68,"path":69,"stem":70},"Dashboards","\u002Fdocs\u002Fdefinitions\u002Fdashboards","docs\u002F3.definitions\u002F06.dashboards",{"title":72,"path":73,"stem":74},"Alerts","\u002Fdocs\u002Fdefinitions\u002Falerts","docs\u002F3.definitions\u002F07.alerts",{"title":76,"path":77,"stem":78},"Monitors","\u002Fdocs\u002Fdefinitions\u002Fmonitors","docs\u002F3.definitions\u002F08.monitors",{"title":80,"path":81,"stem":82},"Status page","\u002Fdocs\u002Fdefinitions\u002Fstatus-page","docs\u002F3.definitions\u002F09.status-page",{"title":84,"path":85,"stem":86},"Tools","\u002Fdocs\u002Fdefinitions\u002Ftools","docs\u002F3.definitions\u002F10.tools",{"title":88,"path":89,"stem":90},"Redactors","\u002Fdocs\u002Fdefinitions\u002Fredactors","docs\u002F3.definitions\u002F11.redactors",{"title":92,"path":93,"stem":94},"Catalog","\u002Fdocs\u002Fdefinitions\u002Fcatalog","docs\u002F3.definitions\u002F12.catalog",{"title":96,"path":97,"stem":98},"More definitions","\u002Fdocs\u002Fdefinitions\u002Fmore","docs\u002F3.definitions\u002F13.more",{"title":100,"icon":101,"path":102,"stem":103,"children":104,"page":22},"Features","i-lucide-layers","\u002Fdocs\u002Ffeatures","docs\u002F4.features",[105,109,112,116,120,124],{"title":106,"path":107,"stem":108},"Tasks","\u002Fdocs\u002Ffeatures\u002Ftasks","docs\u002F4.features\u002F1.tasks",{"title":80,"path":110,"stem":111},"\u002Fdocs\u002Ffeatures\u002Fstatus-page","docs\u002F4.features\u002F2.status-page",{"title":113,"path":114,"stem":115},"Alerts and notifications","\u002Fdocs\u002Ffeatures\u002Falerts","docs\u002F4.features\u002F3.alerts",{"title":117,"path":118,"stem":119},"MCP","\u002Fdocs\u002Ffeatures\u002Fmcp","docs\u002F4.features\u002F4.mcp",{"title":121,"path":122,"stem":123},"Releases","\u002Fdocs\u002Ffeatures\u002Freleases","docs\u002F4.features\u002F5.releases",{"title":125,"path":126,"stem":127},"Ask Vigie","\u002Fdocs\u002Ffeatures\u002Fask-vigie","docs\u002F4.features\u002F6.ask-vigie",{"title":129,"icon":130,"path":131,"stem":132,"children":133,"page":22},"Self-hosting","i-lucide-server","\u002Fdocs\u002Fself-hosting","docs\u002F5.self-hosting",[134,138,142,146],{"title":135,"path":136,"stem":137},"Deploy","\u002Fdocs\u002Fself-hosting\u002Fdeploy","docs\u002F5.self-hosting\u002F1.deploy",{"title":139,"path":140,"stem":141},"Configuration","\u002Fdocs\u002Fself-hosting\u002Fconfiguration","docs\u002F5.self-hosting\u002F2.configuration",{"title":143,"path":144,"stem":145},"Security","\u002Fdocs\u002Fself-hosting\u002Fsecurity","docs\u002F5.self-hosting\u002F3.security",{"title":147,"path":148,"stem":149},"Backups and retention","\u002Fdocs\u002Fself-hosting\u002Fbackups","docs\u002F5.self-hosting\u002F4.backups",{"id":151,"title":30,"body":152,"description":835,"extension":836,"links":837,"meta":838,"navigation":510,"path":31,"seo":839,"stem":32,"__hash__":840},"docs\u002Fdocs\u002F2.connect\u002F1.adonis.md",{"type":153,"value":154,"toc":830},"minimark",[155,184,188,227,230,253,258,265,439,459,463,477,694,700,704,710,816,823,826],[156,157,162],"pre",{"className":158,"code":159,"language":160,"meta":161,"style":161},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","node ace add @vigiejs\u002Fadonis\n","bash","",[163,164,165],"code",{"__ignoreMap":161},[166,167,170,174,178,181],"span",{"class":168,"line":169},"line",1,[166,171,173],{"class":172},"sBMFI","node",[166,175,177],{"class":176},"sfazB"," ace",[166,179,180],{"class":176}," add",[166,182,183],{"class":176}," @vigiejs\u002Fadonis\n",[185,186,187],"p",{},"That is the whole setup. The installer:",[189,190,191,199,202,221,224],"ul",{},[192,193,194,195,198],"li",{},"installs the official ",[163,196,197],{},"@adonisjs\u002Fotel"," for traces and points it at Vigie;",[192,200,201],{},"registers a server middleware that turns every request into one wide event, 404s included;",[192,203,204,205,208,209,212,213,216,217,220],{},"writes ",[163,206,207],{},"VIGIE_URL"," and ",[163,210,211],{},"VIGIE_KEY"," to ",[163,214,215],{},".env"," and validates them in ",[163,218,219],{},"start\u002Fenv.ts",";",[192,222,223],{},"with a Vigie on a server, opens a page where someone signed in allows the app, so nobody copies a key;",[192,225,226],{},"sends one test event, and says so only once Vigie accepted it.",[185,228,229],{},"In CI, or anywhere without a browser:",[156,231,233],{"className":158,"code":232,"language":160,"meta":161,"style":161},"node ace configure @vigiejs\u002Fadonis --url=https:\u002F\u002Fvigie.acme.dev --key=vk_…\n",[163,234,235],{"__ignoreMap":161},[166,236,237,239,241,244,247,250],{"class":168,"line":169},[166,238,173],{"class":172},[166,240,177],{"class":176},[166,242,243],{"class":176}," configure",[166,245,246],{"class":176}," @vigiejs\u002Fadonis",[166,248,249],{"class":176}," --url=https:\u002F\u002Fvigie.acme.dev",[166,251,252],{"class":176}," --key=vk_…\n",[254,255,257],"h2",{"id":256},"add-your-own-fields","Add your own fields",[185,259,260,261,264],{},"Each request's event is ",[163,262,263],{},"ctx.log",". Add what matters to you, nested as you like:",[156,266,271],{"className":267,"code":268,"filename":269,"language":270,"meta":161,"style":161},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","router.post('\u002Forders', async ({ request, log }) => {\n  const order = await Order.create(request.all())\n  log.set({ order: { id: order.id, total: order.total } })\n  return order\n})\n","start\u002Froutes.ts","ts",[163,272,273,326,364,422,431],{"__ignoreMap":161},[166,274,275,279,283,287,290,293,296,298,301,305,308,312,314,317,320,323],{"class":168,"line":169},[166,276,278],{"class":277},"sTEyZ","router",[166,280,282],{"class":281},"sMK4o",".",[166,284,286],{"class":285},"s2Zo4","post",[166,288,289],{"class":277},"(",[166,291,292],{"class":281},"'",[166,294,295],{"class":176},"\u002Forders",[166,297,292],{"class":281},[166,299,300],{"class":281},",",[166,302,304],{"class":303},"spNyl"," async",[166,306,307],{"class":281}," ({",[166,309,311],{"class":310},"sHdIc"," request",[166,313,300],{"class":281},[166,315,316],{"class":310}," log",[166,318,319],{"class":281}," })",[166,321,322],{"class":303}," =>",[166,324,325],{"class":281}," {\n",[166,327,329,332,335,338,342,345,347,350,353,356,358,361],{"class":168,"line":328},2,[166,330,331],{"class":303},"  const",[166,333,334],{"class":277}," order",[166,336,337],{"class":281}," =",[166,339,341],{"class":340},"s7zQu"," await",[166,343,344],{"class":277}," Order",[166,346,282],{"class":281},[166,348,349],{"class":285},"create",[166,351,289],{"class":352},"swJcz",[166,354,355],{"class":277},"request",[166,357,282],{"class":281},[166,359,360],{"class":285},"all",[166,362,363],{"class":352},"())\n",[166,365,367,370,372,375,377,380,382,385,388,391,393,395,397,400,402,405,407,409,411,414,417,419],{"class":168,"line":366},3,[166,368,369],{"class":277},"  log",[166,371,282],{"class":281},[166,373,374],{"class":285},"set",[166,376,289],{"class":352},[166,378,379],{"class":281},"{",[166,381,334],{"class":352},[166,383,384],{"class":281},":",[166,386,387],{"class":281}," {",[166,389,390],{"class":352}," id",[166,392,384],{"class":281},[166,394,334],{"class":277},[166,396,282],{"class":281},[166,398,399],{"class":277},"id",[166,401,300],{"class":281},[166,403,404],{"class":352}," total",[166,406,384],{"class":281},[166,408,334],{"class":277},[166,410,282],{"class":281},[166,412,413],{"class":277},"total",[166,415,416],{"class":281}," }",[166,418,416],{"class":281},[166,420,421],{"class":352},")\n",[166,423,425,428],{"class":168,"line":424},4,[166,426,427],{"class":340},"  return",[166,429,430],{"class":277}," order\n",[166,432,434,437],{"class":168,"line":433},5,[166,435,436],{"class":281},"}",[166,438,421],{"class":277},[185,440,441,442,445,446,449,450,454,455,282],{},"The fields show up flattened (",[163,443,444],{},"order.id",", ",[163,447,448],{},"order.total","), searchable on ",[451,452,453],"strong",{},"Logs",", and drawn by your ",[456,457,458],"a",{"href":53},"log renderers",[254,460,462],{"id":461},"background-tasks","Background tasks",[185,464,465,466,469,470,208,473,476],{},"Wrap each attempt of a job in ",[163,467,468],{},"task()",". Throwing marks it failed; ",[163,471,472],{},"skip()",[163,474,475],{},"retry()"," say why it did not run:",[156,478,480],{"className":267,"code":479,"language":270,"meta":161,"style":161},"import { task } from '@vigiejs\u002Fadonis'\n\nawait task({ kind: 'invoices.sync', id: job.id, attempt: job.attempts, integration: 'invoxa' }, async ({ log, skip }) => {\n  if (!account.invoxaId) return skip('NO_INVOXA_ACCOUNT')\n  const synced = await invoxa.sync(account)\n  log.set({ invoices: { synced } })\n})\n",[163,481,482,506,512,596,634,659,687],{"__ignoreMap":161},[166,483,484,487,489,492,494,497,500,503],{"class":168,"line":169},[166,485,486],{"class":340},"import",[166,488,387],{"class":281},[166,490,491],{"class":277}," task",[166,493,416],{"class":281},[166,495,496],{"class":340}," from",[166,498,499],{"class":281}," '",[166,501,502],{"class":176},"@vigiejs\u002Fadonis",[166,504,505],{"class":281},"'\n",[166,507,508],{"class":168,"line":328},[166,509,511],{"emptyLinePlaceholder":510},true,"\n",[166,513,514,517,519,521,523,526,528,530,533,535,537,539,541,544,546,548,550,553,555,557,559,562,564,567,569,571,574,576,579,581,583,585,587,590,592,594],{"class":168,"line":366},[166,515,516],{"class":340},"await",[166,518,491],{"class":285},[166,520,289],{"class":277},[166,522,379],{"class":281},[166,524,525],{"class":352}," kind",[166,527,384],{"class":281},[166,529,499],{"class":281},[166,531,532],{"class":176},"invoices.sync",[166,534,292],{"class":281},[166,536,300],{"class":281},[166,538,390],{"class":352},[166,540,384],{"class":281},[166,542,543],{"class":277}," job",[166,545,282],{"class":281},[166,547,399],{"class":277},[166,549,300],{"class":281},[166,551,552],{"class":352}," attempt",[166,554,384],{"class":281},[166,556,543],{"class":277},[166,558,282],{"class":281},[166,560,561],{"class":277},"attempts",[166,563,300],{"class":281},[166,565,566],{"class":352}," integration",[166,568,384],{"class":281},[166,570,499],{"class":281},[166,572,573],{"class":176},"invoxa",[166,575,292],{"class":281},[166,577,578],{"class":281}," },",[166,580,304],{"class":303},[166,582,307],{"class":281},[166,584,316],{"class":310},[166,586,300],{"class":281},[166,588,589],{"class":310}," skip",[166,591,319],{"class":281},[166,593,322],{"class":303},[166,595,325],{"class":281},[166,597,598,601,604,607,610,612,615,618,621,623,625,627,630,632],{"class":168,"line":424},[166,599,600],{"class":340},"  if",[166,602,603],{"class":352}," (",[166,605,606],{"class":281},"!",[166,608,609],{"class":277},"account",[166,611,282],{"class":281},[166,613,614],{"class":277},"invoxaId",[166,616,617],{"class":352},") ",[166,619,620],{"class":340},"return",[166,622,589],{"class":285},[166,624,289],{"class":352},[166,626,292],{"class":281},[166,628,629],{"class":176},"NO_INVOXA_ACCOUNT",[166,631,292],{"class":281},[166,633,421],{"class":352},[166,635,636,638,641,643,645,648,650,653,655,657],{"class":168,"line":433},[166,637,331],{"class":303},[166,639,640],{"class":277}," synced",[166,642,337],{"class":281},[166,644,341],{"class":340},[166,646,647],{"class":277}," invoxa",[166,649,282],{"class":281},[166,651,652],{"class":285},"sync",[166,654,289],{"class":352},[166,656,609],{"class":277},[166,658,421],{"class":352},[166,660,662,664,666,668,670,672,675,677,679,681,683,685],{"class":168,"line":661},6,[166,663,369],{"class":277},[166,665,282],{"class":281},[166,667,374],{"class":285},[166,669,289],{"class":352},[166,671,379],{"class":281},[166,673,674],{"class":352}," invoices",[166,676,384],{"class":281},[166,678,387],{"class":281},[166,680,640],{"class":277},[166,682,416],{"class":281},[166,684,416],{"class":281},[166,686,421],{"class":352},[166,688,690,692],{"class":168,"line":689},7,[166,691,436],{"class":281},[166,693,421],{"class":277},[185,695,696,697,282],{},"Anything else, a script or a cron, can be one wide event with ",[163,698,699],{},"runWithWideEvent({ operation: 'reports.nightly' }, async (log) => …)",[254,701,703],{"id":702},"config","Config",[185,705,706,709],{},[163,707,708],{},"config\u002Fvigie.ts",", written by the installer:",[711,712,713,726],"table",{},[714,715,716],"thead",{},[717,718,719,723],"tr",{},[720,721,722],"th",{},"Option",[720,724,725],{},"What it does",[727,728,729,740,750,775,788,806],"tbody",{},[717,730,731,737],{},[732,733,734],"td",{},[163,735,736],{},"url",[732,738,739],{},"Where Vigie runs. Empty sends nothing, as in tests.",[717,741,742,747],{},[732,743,744],{},[163,745,746],{},"key",[732,748,749],{},"The ingest key. A Vigie on your machine needs none.",[717,751,752,763],{},[732,753,754,445,757,445,760],{},[163,755,756],{},"service",[163,758,759],{},"environment",[163,761,762],{},"version",[732,764,765,766,445,769,445,772,282],{},"How the app appears in Vigie. Read from ",[163,767,768],{},"APP_NAME",[163,770,771],{},"APP_ENV",[163,773,774],{},"APP_VERSION",[717,776,777,782],{},[732,778,779],{},[163,780,781],{},"ignorePaths",[732,783,784,785,282],{},"Requests to skip, such as ",[163,786,787],{},"\u002Fhealth",[717,789,790,795],{},[732,791,792],{},[163,793,794],{},"secretPaths",[732,796,797,798,801,802,805],{},"Path segments followed by a secret, such as ",[163,799,800],{},"webhooks"," for ",[163,803,804],{},"\u002Fwebhooks\u002F:token",". Masked before anything leaves the app.",[717,807,808,813],{},[732,809,810],{},[163,811,812],{},"pretty",[732,814,815],{},"Print each event in the terminal too. On outside production.",[185,817,818,819,822],{},"If ",[163,820,821],{},"config\u002Fotel.ts"," already existed, the installer leaves it alone and prints the destination to add.",[185,824,825],{},"Requires Adonis 6 or 7 and Node 22 or later.",[827,828,829],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sHdIc, html code.shiki .sHdIc{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#EEFFFF;--shiki-default-font-style:italic;--shiki-dark:#BABED8;--shiki-dark-font-style:italic}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}",{"title":161,"searchDepth":328,"depth":328,"links":831},[832,833,834],{"id":256,"depth":328,"text":257},{"id":461,"depth":328,"text":462},{"id":702,"depth":328,"text":703},"Send an Adonis app's requests, errors, traces and background tasks to Vigie with one command.","md",null,{},{"title":30,"description":835},"H28q-n41nTVjrQW158CR5nGxvfgnzUJJgbpUrbaJANE",[842,844],{"title":19,"path":20,"stem":21,"description":843,"children":-1},"Wide events, traces and metrics, stored in ClickHouse and read through your definitions.",{"title":34,"path":35,"stem":36,"description":845,"children":-1},"Send a NestJS app's requests, errors, traces and background jobs to Vigie with one command.",1795043962290]