index.html 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="icon" href="../../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>Metrics - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("../..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#metrics" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. Metrics
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  72. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  106. <div class="md-tabs__inner md-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../components/" class="md-tabs__link md-tabs__link--active">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../../guides/introduction/" class="md-tabs__link">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  125. Provider
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../contributing/devguide/" class="md-tabs__link">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="../externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../pushsecret/" class="md-nav__link">
  257. PushSecret
  258. </a>
  259. </li>
  260. </ul>
  261. </nav>
  262. </li>
  263. <li class="md-nav__item md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../generator/">Generators</a>
  267. <label for="__nav_2_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. </div>
  271. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_2_3">
  273. <span class="md-nav__icon md-icon"></span>
  274. Generators
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../generator/acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../generator/ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../generator/gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../generator/vault/" class="md-nav__link">
  294. Vault Dynamic Secret
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../generator/password/" class="md-nav__link">
  299. Password
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../generator/fake/" class="md-nav__link">
  304. Fake
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" type="checkbox" id="__nav_2_4" checked>
  312. <label class="md-nav__link" for="__nav_2_4">
  313. Reference Docs
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_2_4">
  318. <span class="md-nav__icon md-icon"></span>
  319. Reference Docs
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../spec/" class="md-nav__link">
  324. API specification
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../controller-options/" class="md-nav__link">
  329. Controller Options
  330. </a>
  331. </li>
  332. <li class="md-nav__item md-nav__item--active">
  333. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  334. <label class="md-nav__link md-nav__link--active" for="__toc">
  335. Metrics
  336. <span class="md-nav__icon md-icon"></span>
  337. </label>
  338. <a href="./" class="md-nav__link md-nav__link--active">
  339. Metrics
  340. </a>
  341. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  342. <label class="md-nav__title" for="__toc">
  343. <span class="md-nav__icon md-icon"></span>
  344. Table of contents
  345. </label>
  346. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  347. <li class="md-nav__item">
  348. <a href="#external-secret-metrics" class="md-nav__link">
  349. External Secret Metrics
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="#dashboard" class="md-nav__link">
  354. Dashboard
  355. </a>
  356. </li>
  357. <li class="md-nav__item">
  358. <a href="#service-level-indicators-and-alerts" class="md-nav__link">
  359. Service Level Indicators and Alerts
  360. </a>
  361. <nav class="md-nav" aria-label="Service Level Indicators and Alerts">
  362. <ul class="md-nav__list">
  363. <li class="md-nav__item">
  364. <a href="#webhook-http-status-codes" class="md-nav__link">
  365. Webhook HTTP Status Codes
  366. </a>
  367. </li>
  368. <li class="md-nav__item">
  369. <a href="#webhook-http-request-latency" class="md-nav__link">
  370. Webhook HTTP Request Latency
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="#controller-workqueue-depth" class="md-nav__link">
  375. Controller Workqueue Depth
  376. </a>
  377. </li>
  378. <li class="md-nav__item">
  379. <a href="#controller-reconcile-latency" class="md-nav__link">
  380. Controller Reconcile Latency
  381. </a>
  382. </li>
  383. <li class="md-nav__item">
  384. <a href="#controller-reconcile-error" class="md-nav__link">
  385. Controller Reconcile Error
  386. </a>
  387. </li>
  388. </ul>
  389. </nav>
  390. </li>
  391. </ul>
  392. </nav>
  393. </li>
  394. </ul>
  395. </nav>
  396. </li>
  397. </ul>
  398. </nav>
  399. </li>
  400. <li class="md-nav__item md-nav__item--nested">
  401. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  402. <label class="md-nav__link" for="__nav_3">
  403. Guides
  404. <span class="md-nav__icon md-icon"></span>
  405. </label>
  406. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  407. <label class="md-nav__title" for="__nav_3">
  408. <span class="md-nav__icon md-icon"></span>
  409. Guides
  410. </label>
  411. <ul class="md-nav__list" data-md-scrollfix>
  412. <li class="md-nav__item">
  413. <a href="../../guides/introduction/" class="md-nav__link">
  414. Introduction
  415. </a>
  416. </li>
  417. <li class="md-nav__item md-nav__item--nested">
  418. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  419. <label class="md-nav__link" for="__nav_3_2">
  420. Advanced Templating
  421. <span class="md-nav__icon md-icon"></span>
  422. </label>
  423. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  424. <label class="md-nav__title" for="__nav_3_2">
  425. <span class="md-nav__icon md-icon"></span>
  426. Advanced Templating
  427. </label>
  428. <ul class="md-nav__list" data-md-scrollfix>
  429. <li class="md-nav__item">
  430. <a href="../../guides/templating/" class="md-nav__link">
  431. v2
  432. </a>
  433. </li>
  434. <li class="md-nav__item">
  435. <a href="../../guides/templating-v1/" class="md-nav__link">
  436. v1
  437. </a>
  438. </li>
  439. </ul>
  440. </nav>
  441. </li>
  442. <li class="md-nav__item">
  443. <a href="../../guides/generator/" class="md-nav__link">
  444. Generators
  445. </a>
  446. </li>
  447. <li class="md-nav__item">
  448. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  449. All keys, One secret
  450. </a>
  451. </li>
  452. <li class="md-nav__item">
  453. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  454. Common K8S Secret Types
  455. </a>
  456. </li>
  457. <li class="md-nav__item">
  458. <a href="../../guides/controller-class/" class="md-nav__link">
  459. Controller Classes
  460. </a>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  464. Lifecycle: ownership & deletion
  465. </a>
  466. </li>
  467. <li class="md-nav__item">
  468. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  469. Decoding Strategies
  470. </a>
  471. </li>
  472. <li class="md-nav__item">
  473. <a href="../../guides/getallsecrets/" class="md-nav__link">
  474. Getting Multiple Secrets
  475. </a>
  476. </li>
  477. <li class="md-nav__item">
  478. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  479. Multi Tenancy
  480. </a>
  481. </li>
  482. <li class="md-nav__item">
  483. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  484. Rewriting Keys
  485. </a>
  486. </li>
  487. <li class="md-nav__item">
  488. <a href="../../guides/v1beta1/" class="md-nav__link">
  489. Upgrading to v1beta1
  490. </a>
  491. </li>
  492. <li class="md-nav__item">
  493. <a href="../../guides/using-latest-image/" class="md-nav__link">
  494. Using Latest Image
  495. </a>
  496. </li>
  497. <li class="md-nav__item">
  498. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  499. Disable Cluster Features
  500. </a>
  501. </li>
  502. </ul>
  503. </nav>
  504. </li>
  505. <li class="md-nav__item md-nav__item--nested">
  506. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  507. <label class="md-nav__link" for="__nav_4">
  508. Provider
  509. <span class="md-nav__icon md-icon"></span>
  510. </label>
  511. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  512. <label class="md-nav__title" for="__nav_4">
  513. <span class="md-nav__icon md-icon"></span>
  514. Provider
  515. </label>
  516. <ul class="md-nav__list" data-md-scrollfix>
  517. <li class="md-nav__item">
  518. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  519. AWS Secrets Manager
  520. </a>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  524. AWS Parameter Store
  525. </a>
  526. </li>
  527. <li class="md-nav__item">
  528. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  529. Azure Key Vault
  530. </a>
  531. </li>
  532. <li class="md-nav__item">
  533. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  534. Google Cloud Secret Manager
  535. </a>
  536. </li>
  537. <li class="md-nav__item">
  538. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  539. IBM Secrets Manager
  540. </a>
  541. </li>
  542. <li class="md-nav__item">
  543. <a href="../../provider/akeyless/" class="md-nav__link">
  544. Akeyless
  545. </a>
  546. </li>
  547. <li class="md-nav__item">
  548. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  549. HashiCorp Vault
  550. </a>
  551. </li>
  552. <li class="md-nav__item">
  553. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  554. Yandex Certificate Manager
  555. </a>
  556. </li>
  557. <li class="md-nav__item">
  558. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  559. Yandex Lockbox
  560. </a>
  561. </li>
  562. <li class="md-nav__item">
  563. <a href="../../provider/alibaba/" class="md-nav__link">
  564. Alibaba Cloud
  565. </a>
  566. </li>
  567. <li class="md-nav__item">
  568. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  569. Gitlab Variables
  570. </a>
  571. </li>
  572. <li class="md-nav__item">
  573. <a href="../../provider/oracle-vault/" class="md-nav__link">
  574. Oracle Vault
  575. </a>
  576. </li>
  577. <li class="md-nav__item">
  578. <a href="../../provider/1password-automation/" class="md-nav__link">
  579. 1Password Secrets Automation
  580. </a>
  581. </li>
  582. <li class="md-nav__item">
  583. <a href="../../provider/webhook/" class="md-nav__link">
  584. Webhook
  585. </a>
  586. </li>
  587. <li class="md-nav__item">
  588. <a href="../../provider/fake/" class="md-nav__link">
  589. Fake
  590. </a>
  591. </li>
  592. <li class="md-nav__item">
  593. <a href="../../provider/kubernetes/" class="md-nav__link">
  594. Kubernetes
  595. </a>
  596. </li>
  597. <li class="md-nav__item">
  598. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  599. senhasegura DevOps Secrets Management (DSM)
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="../../provider/doppler/" class="md-nav__link">
  604. Doppler
  605. </a>
  606. </li>
  607. <li class="md-nav__item">
  608. <a href="../../provider/keeper-security/" class="md-nav__link">
  609. Keeper Security
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../../provider/scaleway/" class="md-nav__link">
  614. Scaleway
  615. </a>
  616. </li>
  617. </ul>
  618. </nav>
  619. </li>
  620. <li class="md-nav__item md-nav__item--nested">
  621. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  622. <label class="md-nav__link" for="__nav_5">
  623. Examples
  624. <span class="md-nav__icon md-icon"></span>
  625. </label>
  626. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  627. <label class="md-nav__title" for="__nav_5">
  628. <span class="md-nav__icon md-icon"></span>
  629. Examples
  630. </label>
  631. <ul class="md-nav__list" data-md-scrollfix>
  632. <li class="md-nav__item">
  633. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  634. FluxCD
  635. </a>
  636. </li>
  637. <li class="md-nav__item">
  638. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  639. Anchore Engine
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  644. Jenkins
  645. </a>
  646. </li>
  647. <li class="md-nav__item">
  648. <a href="../../examples/bitwarden/" class="md-nav__link">
  649. BitWarden
  650. </a>
  651. </li>
  652. </ul>
  653. </nav>
  654. </li>
  655. <li class="md-nav__item md-nav__item--nested">
  656. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  657. <label class="md-nav__link" for="__nav_6">
  658. Community
  659. <span class="md-nav__icon md-icon"></span>
  660. </label>
  661. <nav class="md-nav" aria-label="Community" data-md-level="1">
  662. <label class="md-nav__title" for="__nav_6">
  663. <span class="md-nav__icon md-icon"></span>
  664. Community
  665. </label>
  666. <ul class="md-nav__list" data-md-scrollfix>
  667. <li class="md-nav__item md-nav__item--nested">
  668. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  669. <label class="md-nav__link" for="__nav_6_1">
  670. Contributing
  671. <span class="md-nav__icon md-icon"></span>
  672. </label>
  673. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  674. <label class="md-nav__title" for="__nav_6_1">
  675. <span class="md-nav__icon md-icon"></span>
  676. Contributing
  677. </label>
  678. <ul class="md-nav__list" data-md-scrollfix>
  679. <li class="md-nav__item">
  680. <a href="../../contributing/devguide/" class="md-nav__link">
  681. Developer guide
  682. </a>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="../../contributing/process/" class="md-nav__link">
  686. Contributing Process
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../contributing/release/" class="md-nav__link">
  691. Release Process
  692. </a>
  693. </li>
  694. <li class="md-nav__item">
  695. <a href="../../contributing/coc/" class="md-nav__link">
  696. Code of Conduct
  697. </a>
  698. </li>
  699. <li class="md-nav__item">
  700. <a href="../../contributing/roadmap/" class="md-nav__link">
  701. Roadmap
  702. </a>
  703. </li>
  704. </ul>
  705. </nav>
  706. </li>
  707. <li class="md-nav__item md-nav__item--nested">
  708. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  709. <label class="md-nav__link" for="__nav_6_2">
  710. External Resources
  711. <span class="md-nav__icon md-icon"></span>
  712. </label>
  713. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  714. <label class="md-nav__title" for="__nav_6_2">
  715. <span class="md-nav__icon md-icon"></span>
  716. External Resources
  717. </label>
  718. <ul class="md-nav__list" data-md-scrollfix>
  719. <li class="md-nav__item">
  720. <a href="../../eso-talks/" class="md-nav__link">
  721. Talks
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="../../eso-demos/" class="md-nav__link">
  726. Demos
  727. </a>
  728. </li>
  729. <li class="md-nav__item">
  730. <a href="../../eso-blogs/" class="md-nav__link">
  731. Blogs
  732. </a>
  733. </li>
  734. </ul>
  735. </nav>
  736. </li>
  737. </ul>
  738. </nav>
  739. </li>
  740. </ul>
  741. </nav>
  742. </div>
  743. </div>
  744. </div>
  745. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
  746. <div class="md-sidebar__scrollwrap">
  747. <div class="md-sidebar__inner">
  748. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  749. <label class="md-nav__title" for="__toc">
  750. <span class="md-nav__icon md-icon"></span>
  751. Table of contents
  752. </label>
  753. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  754. <li class="md-nav__item">
  755. <a href="#external-secret-metrics" class="md-nav__link">
  756. External Secret Metrics
  757. </a>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="#dashboard" class="md-nav__link">
  761. Dashboard
  762. </a>
  763. </li>
  764. <li class="md-nav__item">
  765. <a href="#service-level-indicators-and-alerts" class="md-nav__link">
  766. Service Level Indicators and Alerts
  767. </a>
  768. <nav class="md-nav" aria-label="Service Level Indicators and Alerts">
  769. <ul class="md-nav__list">
  770. <li class="md-nav__item">
  771. <a href="#webhook-http-status-codes" class="md-nav__link">
  772. Webhook HTTP Status Codes
  773. </a>
  774. </li>
  775. <li class="md-nav__item">
  776. <a href="#webhook-http-request-latency" class="md-nav__link">
  777. Webhook HTTP Request Latency
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="#controller-workqueue-depth" class="md-nav__link">
  782. Controller Workqueue Depth
  783. </a>
  784. </li>
  785. <li class="md-nav__item">
  786. <a href="#controller-reconcile-latency" class="md-nav__link">
  787. Controller Reconcile Latency
  788. </a>
  789. </li>
  790. <li class="md-nav__item">
  791. <a href="#controller-reconcile-error" class="md-nav__link">
  792. Controller Reconcile Error
  793. </a>
  794. </li>
  795. </ul>
  796. </nav>
  797. </li>
  798. </ul>
  799. </nav>
  800. </div>
  801. </div>
  802. </div>
  803. <div class="md-content" data-md-component="content">
  804. <article class="md-content__inner md-typeset">
  805. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/api/metrics.md" title="Edit this page" class="md-content__button md-icon">
  806. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  807. </a>
  808. <h1 id="metrics">Metrics</h1>
  809. <p>The External Secrets Operator exposes its Prometheus metrics in the <code>/metrics</code> path. To enable it, set the <code>serviceMonitor.enabled</code> Helm flag to <code>true</code>. In addition you can also set <code>webhook.serviceMonitor.enabled=true</code> and <code>certController.serviceMonitor.enabled=true</code> to create <code>ServiceMonitor</code> resources for the other components.</p>
  810. <p>If you are using a different monitoring tool that also needs a <code>/metrics</code> endpoint, you can set the <code>metrics.service.enabled</code> Helm flag to <code>true</code>. In addition you can also set <code>webhook.metrics.service.enabled</code> and <code>certController.metrics.service.enabled</code> to scrape the other components.</p>
  811. <p>The Operator has the metrics inherited from Kubebuilder plus some custom metrics with the <code>externalsecret</code> prefix.</p>
  812. <h2 id="external-secret-metrics">External Secret Metrics</h2>
  813. <table>
  814. <thead>
  815. <tr>
  816. <th>Name</th>
  817. <th>Type</th>
  818. <th>Description</th>
  819. </tr>
  820. </thead>
  821. <tbody>
  822. <tr>
  823. <td><code>externalsecret_provider_api_calls_count</code></td>
  824. <td>Counter</td>
  825. <td>Number of API calls made to an upstream secret provider API. The metric provides a <code>provider</code>, <code>call</code> and <code>status</code> labels.</td>
  826. </tr>
  827. <tr>
  828. <td><code>externalsecret_sync_calls_total</code></td>
  829. <td>Counter</td>
  830. <td>Total number of the External Secret sync calls</td>
  831. </tr>
  832. <tr>
  833. <td><code>externalsecret_sync_calls_error</code></td>
  834. <td>Counter</td>
  835. <td>Total number of the External Secret sync errors</td>
  836. </tr>
  837. <tr>
  838. <td><code>externalsecret_status_condition</code></td>
  839. <td>Gauge</td>
  840. <td>The status condition of a specific External Secret</td>
  841. </tr>
  842. <tr>
  843. <td><code>externalsecret_reconcile_duration</code></td>
  844. <td>Gauge</td>
  845. <td>The duration time to reconcile the External Secret</td>
  846. </tr>
  847. <tr>
  848. <td><code>controller_runtime_reconcile_total</code></td>
  849. <td>Counter</td>
  850. <td>Holds the totalnumber of reconciliations per controller. It has two labels. controller label refers to the controller name and result label refers to the reconcile result i.e success, error, requeue, requeue_after.</td>
  851. </tr>
  852. <tr>
  853. <td><code>controller_runtime_reconcile_errors_total</code></td>
  854. <td>Counter</td>
  855. <td>Total number of reconcile errors per controller</td>
  856. </tr>
  857. <tr>
  858. <td><code>controller_runtime_reconcile_time_seconds</code></td>
  859. <td>Histogram</td>
  860. <td>Length of time per reconcile per controller</td>
  861. </tr>
  862. <tr>
  863. <td><code>controller_runtime_reconcile_queue_length</code></td>
  864. <td>Gauge</td>
  865. <td>Length of reconcile queue per controller</td>
  866. </tr>
  867. <tr>
  868. <td><code>controller_runtime_max_concurrent_reconciles</code></td>
  869. <td>Gauge</td>
  870. <td>Maximum number of concurrent reconciles per controller</td>
  871. </tr>
  872. <tr>
  873. <td><code>controller_runtime_active_workers</code></td>
  874. <td>Gauge</td>
  875. <td>Number of currently used workers per controller</td>
  876. </tr>
  877. </tbody>
  878. </table>
  879. <h2 id="dashboard">Dashboard</h2>
  880. <p>We provide a <a href="https://raw.githubusercontent.com/external-secrets/external-secrets/main/docs/snippets/dashboard.json">Grafana Dashboard</a> that gives you an overview of External Secrets Operator:</p>
  881. <p><img alt="ESO Dashboard" src="../../pictures/eso-dashboard-1.png" />
  882. <img alt="ESO Dashboard" src="../../pictures/eso-dashboard-2.png" /></p>
  883. <h2 id="service-level-indicators-and-alerts">Service Level Indicators and Alerts</h2>
  884. <p>We find the following Service Level Indicators (SLIs) useful when operating ESO. They should give you a good starting point and hints to develop your own Service Level Objectives (SLOs).</p>
  885. <h4 id="webhook-http-status-codes">Webhook HTTP Status Codes</h4>
  886. <p>The webhook HTTP status code indicates that a HTTP Request was answered successfully or not.
  887. If the Webhook pod is not able to serve the requests properly then that failure may cascade down to the controller or any other user of <code>kube-apiserver</code>.</p>
  888. <p>SLI Example: request error percentage.
  889. <div class="highlight"><pre><span></span><code>sum(increase(controller_runtime_webhook_requests_total{service=~&quot;external-secrets.*&quot;,code=&quot;500&quot;}[1m]))
  890. /
  891. sum(increase(controller_runtime_webhook_requests_total{service=~&quot;external-secrets.*&quot;}[1m]))
  892. </code></pre></div></p>
  893. <h4 id="webhook-http-request-latency">Webhook HTTP Request Latency</h4>
  894. <p>If the webhook server is not able to respond in time then that may cause a timeout at the client.
  895. This failure may cascade down to the controller or any other user of <code>kube-apiserver</code>.</p>
  896. <p>SLI Example: p99 across all webhook requests.
  897. <div class="highlight"><pre><span></span><code>histogram_quantile(0.99,
  898. sum(rate(controller_runtime_webhook_latency_seconds_bucket{service=~&quot;external-secrets.*&quot;}[5m])) by (le)
  899. )
  900. </code></pre></div></p>
  901. <h4 id="controller-workqueue-depth">Controller Workqueue Depth</h4>
  902. <p>If the workqueue depth is &gt; 0 for a longer period of time then this is an indicator for the controller not being able to reconcile resources in time. I.e. delivery of secret updates is delayed.</p>
  903. <p>Note: when a controller is restarted, then <code>queue length = total number of resources</code>. Make sure to measure the time it takes for the controller to fully reconcile all secrets after a restart. In large clusters this may take a while, make sure to define an acceptable timeframe to fully reconcile all resources.</p>
  904. <div class="highlight"><pre><span></span><code>sum(
  905. workqueue_depth{service=~&quot;external-secrets.*&quot;}
  906. ) by (name)
  907. </code></pre></div>
  908. <h4 id="controller-reconcile-latency">Controller Reconcile Latency</h4>
  909. <p>The controller should be able to reconcile resources within a reasonable timeframe. When latency is high secret delivery may impacted.</p>
  910. <p>SLI Example: p99 across all controllers.
  911. <div class="highlight"><pre><span></span><code>histogram_quantile(0.99,
  912. sum(rate(controller_runtime_reconcile_time_seconds_bucket{service=~&quot;external-secrets.*&quot;}[5m])) by (le)
  913. )
  914. </code></pre></div></p>
  915. <h4 id="controller-reconcile-error">Controller Reconcile Error</h4>
  916. <p>The controller should be able to reconcile resources without errors. When errors occurr secret delivery may be impacted which could cascade down to the secret consuming applications.</p>
  917. <div class="highlight"><pre><span></span><code>sum(increase(
  918. controller_runtime_reconcile_total{service=~&quot;external-secrets.*&quot;,controller=~&quot;$controller&quot;}[1m])
  919. ) by (result)
  920. </code></pre></div>
  921. </article>
  922. </div>
  923. </div>
  924. </main>
  925. <footer class="md-footer">
  926. <nav class="md-footer__inner md-grid" aria-label="Footer">
  927. <a href="../controller-options/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Controller Options" rel="prev">
  928. <div class="md-footer__button md-icon">
  929. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  930. </div>
  931. <div class="md-footer__title">
  932. <div class="md-ellipsis">
  933. <span class="md-footer__direction">
  934. Previous
  935. </span>
  936. Controller Options
  937. </div>
  938. </div>
  939. </a>
  940. <a href="../../guides/introduction/" class="md-footer__link md-footer__link--next" aria-label="Next: Introduction" rel="next">
  941. <div class="md-footer__title">
  942. <div class="md-ellipsis">
  943. <span class="md-footer__direction">
  944. Next
  945. </span>
  946. Introduction
  947. </div>
  948. </div>
  949. <div class="md-footer__button md-icon">
  950. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  951. </div>
  952. </a>
  953. </nav>
  954. <div class="md-footer-meta md-typeset">
  955. <div class="md-footer-meta__inner md-grid">
  956. <div class="md-copyright">
  957. <div class="md-copyright__highlight">
  958. &copy; 2023 The external-secrets Authors.<br/>
  959. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  960. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  961. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  962. </div>
  963. Made with
  964. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  965. Material for MkDocs
  966. </a>
  967. </div>
  968. </div>
  969. </div>
  970. </footer>
  971. </div>
  972. <div class="md-dialog" data-md-component="dialog">
  973. <div class="md-dialog__inner md-typeset"></div>
  974. </div>
  975. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  976. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  977. </body>
  978. </html>