https://flanksource.com/assets/js/5c057e08.99ac683d.js

1"use strict";(globalThis.webpackChunkmission_control=globalThis.webpackChunkmission_control||[]).push([[3114],{53059(e,c,d){d.r(c),d.d(c,{assets:()=>h,contentTitle:()=>i,default:()=>j,frontMatter:()=>s,metadata:()=>r,toc:()=>l});const r=JSON.parse('{"id":"reference/canary-checker/check","title":"Check","description":"| Field                  | Description                                                 | Scheme                               |","source":"@site/docs/reference/canary-checker/check.md","sourceDirName":"reference/canary-checker","slug":"/reference/canary-checker/check","permalink":"/docs/reference/canary-checker/check","draft":false,"unlisted":false,"editUrl":"https://github.com/flanksource/docs/tree/main/docs/reference/canary-checker/check.md","tags":[],"version":"current","frontMatter":{"title":"Check"},"sidebar":"reference","previous":{"title":"Canary Checker","permalink":"/docs/reference/canary-checker/"},"next":{"title":"Config DB","permalink":"/docs/reference/config-db/"}}');var n=d(74848),t=d(28453);const s={title:"Check"},i=void 0,h={},l=[{value:"Auxiliary fields",id:"auxiliary-fields",level:2}];function x(e){const c={a:"a",code:"code",em:"em",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(c.table,{children:[(0,n.jsx)(c.thead,{children:(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.th,{children:"Field"}),(0,n.jsx)(c.th,{children:"Description"}),(0,n.jsx)(c.th,{children:"Scheme"})]})}),(0,n.jsxs)(c.tbody,{children:[(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"id"})}),(0,n.jsx)(c.td,{children:"ID of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"uuid"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"canary_id"})}),(0,n.jsx)(c.td,{children:"ID of the canary"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"uuid"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"agent_id"})}),(0,n.jsx)(c.td,{children:"ID of the agent"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"uuid"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"type"})}),(0,n.jsx)(c.td,{children:"The type of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"string"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"name"})}),(0,n.jsx)(c.td,{children:"The name of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"string"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"namespace"})}),(0,n.jsx)(c.td,{children:"The namespace of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"string"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"labels"})}),(0,n.jsx)(c.td,{children:"The labels of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"map[string]string"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"description"})}),(0,n.jsx)(c.td,{children:"The description of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"string"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"status"})}),(0,n.jsxs)(c.td,{children:["The status of the check ",(0,n.jsx)(c.em,{children:"(healthy/unhealthy)"})]}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"string"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"owner"})}),(0,n.jsx)(c.td,{children:"The owner of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"string"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"severity"})}),(0,n.jsxs)(c.td,{children:["The severity of the check ",(0,n.jsx)(c.em,{children:"(info/low/medium/high/critical)"})]}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"string"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"icon"})}),(0,n.jsx)(c.td,{children:"The icon of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.a,{href:"/docs/reference/types#icon",children:(0,n.jsx)(c.code,{children:"Icon"})})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"transformed"})}),(0,n.jsx)(c.td,{children:"The transformed of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"bool"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"last_runtime"})}),(0,n.jsx)(c.td,{children:"The last runtime of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"*time"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"next_runtime"})}),(0,n.jsx)(c.td,{children:"The next runtime of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"*time"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"last_transition_time"})}),(0,n.jsx)(c.td,{children:"The last transition time of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"*time"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"created_at"})}),(0,n.jsx)(c.td,{children:"The created at of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"time"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"updated_at"})}),(0,n.jsx)(c.td,{children:"The updated at of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"time"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"deleted_at"})}),(0,n.jsx)(c.td,{children:"The deleted at of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"*time"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"silenced_at"})}),(0,n.jsx)(c.td,{children:"The silenced at of the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"*time"})})]})]})]}),"\n",(0,n.jsx)(c.h2,{id:"auxiliary-fields",children:"Auxiliary fields"}),"\n",(0,n.jsx)(c.p,{children:"These are not stored on the check itself \u2014 they are computed when a check is returned."}),"\n",(0,n.jsxs)(c.table,{children:[(0,n.jsx)(c.thead,{children:(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.th,{children:"Field"}),(0,n.jsx)(c.th,{children:"Description"}),(0,n.jsx)(c.th,{children:"Scheme"})]})}),(0,n.jsxs)(c.tbody,{children:[(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"canary_name"})}),(0,n.jsx)(c.td,{children:"Name of the canary that owns the check"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"string"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"components"})}),(0,n.jsx)(c.td,{children:"IDs of the components the check is linked to"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"[]uuid"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"uptime"})}),(0,n.jsx)(c.td,{children:"Passed and failed counts over the selected range"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"Uptime"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"latency"})}),(0,n.jsx)(c.td,{children:"Latency percentiles over the selected range"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"Latency"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"display_type"})}),(0,n.jsx)(c.td,{children:"How the check is rendered on the UI"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"string"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"earliestRuntime"})}),(0,n.jsx)(c.td,{children:"Earliest run in the selected date range"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"*time"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"latestRuntime"})}),(0,n.jsx)(c.td,{children:"Latest run in the selected date range"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"*time"})})]}),(0,n.jsxs)(c.tr,{children:[(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"totalRuns"})}),(0,n.jsx)(c.td,{children:"Number of runs in the selected date range"}),(0,n.jsx)(c.td,{children:(0,n.jsx)(c.code,{children:"int"})})]})]})]})]})}function j(e={}){const{wrapper:c}={...(0,t.R)(),...e.components};return c?(0,n.jsx)(c,{...e,children:(0,n.jsx)(x,{...e})}):x(e)}},28453(e,c,d){d.d(c,{R:()=>s,x:()=>i});var r=d(96540);const n={},t=r.createContext(n);function s(e){const c=r.useContext(t);return r.useMemo(function(){return"function"==typeof e?e(c):{...c,...e}},[c,e])}function i(e){let c;return c=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),r.createElement(t.Provider,{value:c},e.children)}}}]);