index.html 50 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404
  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="prev" href="../controller-options/">
  7. <link rel="next" href="../../guides/introduction/">
  8. <link rel="icon" href="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.9">
  10. <title>Metrics - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.85bb2934.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__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>
  16. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#metrics" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <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>
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. Metrics
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <label class="md-header__button md-icon" for="__search">
  65. <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>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <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>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <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>
  74. <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>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <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>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../components/" class="md-tabs__link md-tabs__link--active">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../guides/introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. </ul>
  141. </div>
  142. </nav>
  143. <main class="md-main" data-md-component="main">
  144. <div class="md-main__inner md-grid">
  145. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  146. <div class="md-sidebar__scrollwrap">
  147. <div class="md-sidebar__inner">
  148. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  149. <label class="md-nav__title" for="__drawer">
  150. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  151. <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>
  152. </a>
  153. External Secrets Operator
  154. </label>
  155. <div class="md-nav__source">
  156. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  157. <div class="md-source__icon md-icon">
  158. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
  159. </div>
  160. <div class="md-source__repository">
  161. External Secrets Operator
  162. </div>
  163. </a>
  164. </div>
  165. <ul class="md-nav__list" data-md-scrollfix>
  166. <li class="md-nav__item md-nav__item--nested">
  167. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  168. <div class="md-nav__link md-nav__link--index ">
  169. <a href="../..">Introduction</a>
  170. <label for="__nav_1">
  171. <span class="md-nav__icon md-icon"></span>
  172. </label>
  173. </div>
  174. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  175. <label class="md-nav__title" for="__nav_1">
  176. <span class="md-nav__icon md-icon"></span>
  177. Introduction
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../../introduction/overview/" class="md-nav__link">
  182. Overview
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../../introduction/getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../../introduction/faq/" class="md-nav__link">
  192. FAQ
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/stability-support/" class="md-nav__link">
  197. Stability and Support
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  202. Deprecation Policy
  203. </a>
  204. </li>
  205. </ul>
  206. </nav>
  207. </li>
  208. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  209. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  210. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  211. API
  212. <span class="md-nav__icon md-icon"></span>
  213. </label>
  214. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  215. <label class="md-nav__title" for="__nav_2">
  216. <span class="md-nav__icon md-icon"></span>
  217. API
  218. </label>
  219. <ul class="md-nav__list" data-md-scrollfix>
  220. <li class="md-nav__item">
  221. <a href="../components/" class="md-nav__link">
  222. Components
  223. </a>
  224. </li>
  225. <li class="md-nav__item md-nav__item--nested">
  226. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  227. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  228. Core Resources
  229. <span class="md-nav__icon md-icon"></span>
  230. </label>
  231. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  232. <label class="md-nav__title" for="__nav_2_2">
  233. <span class="md-nav__icon md-icon"></span>
  234. Core Resources
  235. </label>
  236. <ul class="md-nav__list" data-md-scrollfix>
  237. <li class="md-nav__item">
  238. <a href="../externalsecret/" class="md-nav__link">
  239. ExternalSecret
  240. </a>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="../secretstore/" class="md-nav__link">
  244. SecretStore
  245. </a>
  246. </li>
  247. <li class="md-nav__item">
  248. <a href="../clustersecretstore/" class="md-nav__link">
  249. ClusterSecretStore
  250. </a>
  251. </li>
  252. <li class="md-nav__item">
  253. <a href="../clusterexternalsecret/" class="md-nav__link">
  254. ClusterExternalSecret
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="../pushsecret/" class="md-nav__link">
  259. PushSecret
  260. </a>
  261. </li>
  262. </ul>
  263. </nav>
  264. </li>
  265. <li class="md-nav__item md-nav__item--nested">
  266. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  267. <div class="md-nav__link md-nav__link--index ">
  268. <a href="../generator/">Generators</a>
  269. <label for="__nav_2_3">
  270. <span class="md-nav__icon md-icon"></span>
  271. </label>
  272. </div>
  273. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  274. <label class="md-nav__title" for="__nav_2_3">
  275. <span class="md-nav__icon md-icon"></span>
  276. Generators
  277. </label>
  278. <ul class="md-nav__list" data-md-scrollfix>
  279. <li class="md-nav__item">
  280. <a href="../generator/acr/" class="md-nav__link">
  281. Azure Container Registry
  282. </a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="../generator/ecr/" class="md-nav__link">
  286. AWS Elastic Container Registry
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../generator/gcr/" class="md-nav__link">
  291. Google Container Registry
  292. </a>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="../generator/vault/" class="md-nav__link">
  296. Vault Dynamic Secret
  297. </a>
  298. </li>
  299. <li class="md-nav__item">
  300. <a href="../generator/password/" class="md-nav__link">
  301. Password
  302. </a>
  303. </li>
  304. <li class="md-nav__item">
  305. <a href="../generator/fake/" class="md-nav__link">
  306. Fake
  307. </a>
  308. </li>
  309. </ul>
  310. </nav>
  311. </li>
  312. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  313. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" checked>
  314. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  315. Reference Docs
  316. <span class="md-nav__icon md-icon"></span>
  317. </label>
  318. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="true">
  319. <label class="md-nav__title" for="__nav_2_4">
  320. <span class="md-nav__icon md-icon"></span>
  321. Reference Docs
  322. </label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="../spec/" class="md-nav__link">
  326. API specification
  327. </a>
  328. </li>
  329. <li class="md-nav__item">
  330. <a href="../controller-options/" class="md-nav__link">
  331. Controller Options
  332. </a>
  333. </li>
  334. <li class="md-nav__item md-nav__item--active">
  335. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  336. <label class="md-nav__link md-nav__link--active" for="__toc">
  337. Metrics
  338. <span class="md-nav__icon md-icon"></span>
  339. </label>
  340. <a href="./" class="md-nav__link md-nav__link--active">
  341. Metrics
  342. </a>
  343. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  344. <label class="md-nav__title" for="__toc">
  345. <span class="md-nav__icon md-icon"></span>
  346. Table of contents
  347. </label>
  348. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  349. <li class="md-nav__item">
  350. <a href="#cluster-external-secret-metrics" class="md-nav__link">
  351. Cluster External Secret Metrics
  352. </a>
  353. </li>
  354. <li class="md-nav__item">
  355. <a href="#external-secret-metrics" class="md-nav__link">
  356. External Secret Metrics
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="#cluster-secret-store-metrics" class="md-nav__link">
  361. Cluster Secret Store Metrics
  362. </a>
  363. </li>
  364. </ul>
  365. </nav>
  366. </li>
  367. </ul>
  368. </nav>
  369. </li>
  370. </ul>
  371. </nav>
  372. </li>
  373. <li class="md-nav__item md-nav__item--nested">
  374. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  375. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  376. Guides
  377. <span class="md-nav__icon md-icon"></span>
  378. </label>
  379. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  380. <label class="md-nav__title" for="__nav_3">
  381. <span class="md-nav__icon md-icon"></span>
  382. Guides
  383. </label>
  384. <ul class="md-nav__list" data-md-scrollfix>
  385. <li class="md-nav__item">
  386. <a href="../../guides/introduction/" class="md-nav__link">
  387. Introduction
  388. </a>
  389. </li>
  390. <li class="md-nav__item md-nav__item--nested">
  391. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  392. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  393. External Secrets
  394. <span class="md-nav__icon md-icon"></span>
  395. </label>
  396. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  397. <label class="md-nav__title" for="__nav_3_2">
  398. <span class="md-nav__icon md-icon"></span>
  399. External Secrets
  400. </label>
  401. <ul class="md-nav__list" data-md-scrollfix>
  402. <li class="md-nav__item">
  403. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  404. Extract structured data
  405. </a>
  406. </li>
  407. <li class="md-nav__item">
  408. <a href="../../guides/getallsecrets/" class="md-nav__link">
  409. Find Secrets by Name or Metadata
  410. </a>
  411. </li>
  412. <li class="md-nav__item">
  413. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  414. Rewriting Keys
  415. </a>
  416. </li>
  417. <li class="md-nav__item md-nav__item--nested">
  418. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  419. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  420. Advanced Templating
  421. <span class="md-nav__icon md-icon"></span>
  422. </label>
  423. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  424. <label class="md-nav__title" for="__nav_3_2_4">
  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/common-k8s-secret-types/" class="md-nav__link">
  444. Kubernetes Secret Types
  445. </a>
  446. </li>
  447. <li class="md-nav__item">
  448. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  449. Lifecycle: ownership & deletion
  450. </a>
  451. </li>
  452. <li class="md-nav__item">
  453. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  454. Decoding Strategies
  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. </ul>
  463. </nav>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../../guides/generator/" class="md-nav__link">
  467. Generators
  468. </a>
  469. </li>
  470. <li class="md-nav__item md-nav__item--nested">
  471. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
  472. <label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
  473. Operations
  474. <span class="md-nav__icon md-icon"></span>
  475. </label>
  476. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
  477. <label class="md-nav__title" for="__nav_3_4">
  478. <span class="md-nav__icon md-icon"></span>
  479. Operations
  480. </label>
  481. <ul class="md-nav__list" data-md-scrollfix>
  482. <li class="md-nav__item">
  483. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  484. Multi Tenancy
  485. </a>
  486. </li>
  487. <li class="md-nav__item">
  488. <a href="../../guides/security-best-practices/" class="md-nav__link">
  489. Security Best Practices
  490. </a>
  491. </li>
  492. <li class="md-nav__item">
  493. <a href="../../guides/threat-model/" class="md-nav__link">
  494. Threat Model
  495. </a>
  496. </li>
  497. <li class="md-nav__item">
  498. <a href="../../guides/v1beta1/" class="md-nav__link">
  499. Upgrading to v1beta1
  500. </a>
  501. </li>
  502. <li class="md-nav__item">
  503. <a href="../../guides/using-latest-image/" class="md-nav__link">
  504. Using Latest Image
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  509. Disable Cluster Features
  510. </a>
  511. </li>
  512. </ul>
  513. </nav>
  514. </li>
  515. </ul>
  516. </nav>
  517. </li>
  518. <li class="md-nav__item md-nav__item--nested">
  519. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  520. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  521. Provider
  522. <span class="md-nav__icon md-icon"></span>
  523. </label>
  524. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  525. <label class="md-nav__title" for="__nav_4">
  526. <span class="md-nav__icon md-icon"></span>
  527. Provider
  528. </label>
  529. <ul class="md-nav__list" data-md-scrollfix>
  530. <li class="md-nav__item">
  531. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  532. AWS Secrets Manager
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  537. AWS Parameter Store
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  542. Azure Key Vault
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../../provider/conjur/" class="md-nav__link">
  547. CyberArk Conjur
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  552. Google Cloud Secret Manager
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  557. HashiCorp Vault
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../../provider/kubernetes/" class="md-nav__link">
  562. Kubernetes
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  567. IBM Secrets Manager
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="../../provider/akeyless/" class="md-nav__link">
  572. Akeyless
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  577. Yandex Certificate Manager
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  582. Yandex Lockbox
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="../../provider/alibaba/" class="md-nav__link">
  587. Alibaba Cloud
  588. </a>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  592. GitLab Variables
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../../provider/oracle-vault/" class="md-nav__link">
  597. Oracle Vault
  598. </a>
  599. </li>
  600. <li class="md-nav__item">
  601. <a href="../../provider/1password-automation/" class="md-nav__link">
  602. 1Password Secrets Automation
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../../provider/webhook/" class="md-nav__link">
  607. Webhook
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="../../provider/fake/" class="md-nav__link">
  612. Fake
  613. </a>
  614. </li>
  615. <li class="md-nav__item">
  616. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  617. senhasegura DevOps Secrets Management (DSM)
  618. </a>
  619. </li>
  620. <li class="md-nav__item">
  621. <a href="../../provider/doppler/" class="md-nav__link">
  622. Doppler
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="../../provider/keeper-security/" class="md-nav__link">
  627. Keeper Security
  628. </a>
  629. </li>
  630. <li class="md-nav__item">
  631. <a href="../../provider/cloak/" class="md-nav__link">
  632. Cloak End 2 End Encrypted Secrets
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../../provider/scaleway/" class="md-nav__link">
  637. Scaleway
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../provider/delinea/" class="md-nav__link">
  642. Delinea
  643. </a>
  644. </li>
  645. </ul>
  646. </nav>
  647. </li>
  648. <li class="md-nav__item md-nav__item--nested">
  649. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  650. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  651. Examples
  652. <span class="md-nav__icon md-icon"></span>
  653. </label>
  654. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  655. <label class="md-nav__title" for="__nav_5">
  656. <span class="md-nav__icon md-icon"></span>
  657. Examples
  658. </label>
  659. <ul class="md-nav__list" data-md-scrollfix>
  660. <li class="md-nav__item">
  661. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  662. FluxCD
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  667. Anchore Engine
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  672. Jenkins
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../examples/bitwarden/" class="md-nav__link">
  677. BitWarden
  678. </a>
  679. </li>
  680. </ul>
  681. </nav>
  682. </li>
  683. <li class="md-nav__item md-nav__item--nested">
  684. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  685. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  686. Community
  687. <span class="md-nav__icon md-icon"></span>
  688. </label>
  689. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  690. <label class="md-nav__title" for="__nav_6">
  691. <span class="md-nav__icon md-icon"></span>
  692. Community
  693. </label>
  694. <ul class="md-nav__list" data-md-scrollfix>
  695. <li class="md-nav__item md-nav__item--nested">
  696. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  697. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  698. Contributing
  699. <span class="md-nav__icon md-icon"></span>
  700. </label>
  701. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  702. <label class="md-nav__title" for="__nav_6_1">
  703. <span class="md-nav__icon md-icon"></span>
  704. Contributing
  705. </label>
  706. <ul class="md-nav__list" data-md-scrollfix>
  707. <li class="md-nav__item">
  708. <a href="../../contributing/devguide/" class="md-nav__link">
  709. Developer guide
  710. </a>
  711. </li>
  712. <li class="md-nav__item">
  713. <a href="../../contributing/process/" class="md-nav__link">
  714. Contributing Process
  715. </a>
  716. </li>
  717. <li class="md-nav__item">
  718. <a href="../../contributing/release/" class="md-nav__link">
  719. Release Process
  720. </a>
  721. </li>
  722. <li class="md-nav__item">
  723. <a href="../../contributing/coc/" class="md-nav__link">
  724. Code of Conduct
  725. </a>
  726. </li>
  727. <li class="md-nav__item">
  728. <a href="../../contributing/roadmap/" class="md-nav__link">
  729. Roadmap
  730. </a>
  731. </li>
  732. </ul>
  733. </nav>
  734. </li>
  735. <li class="md-nav__item md-nav__item--nested">
  736. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  737. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  738. External Resources
  739. <span class="md-nav__icon md-icon"></span>
  740. </label>
  741. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  742. <label class="md-nav__title" for="__nav_6_2">
  743. <span class="md-nav__icon md-icon"></span>
  744. External Resources
  745. </label>
  746. <ul class="md-nav__list" data-md-scrollfix>
  747. <li class="md-nav__item">
  748. <a href="../../eso-talks/" class="md-nav__link">
  749. Talks
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="../../eso-demos/" class="md-nav__link">
  754. Demos
  755. </a>
  756. </li>
  757. <li class="md-nav__item">
  758. <a href="../../eso-blogs/" class="md-nav__link">
  759. Blogs
  760. </a>
  761. </li>
  762. </ul>
  763. </nav>
  764. </li>
  765. </ul>
  766. </nav>
  767. </li>
  768. </ul>
  769. </nav>
  770. </div>
  771. </div>
  772. </div>
  773. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
  774. <div class="md-sidebar__scrollwrap">
  775. <div class="md-sidebar__inner">
  776. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  777. <label class="md-nav__title" for="__toc">
  778. <span class="md-nav__icon md-icon"></span>
  779. Table of contents
  780. </label>
  781. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  782. <li class="md-nav__item">
  783. <a href="#cluster-external-secret-metrics" class="md-nav__link">
  784. Cluster External Secret Metrics
  785. </a>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="#external-secret-metrics" class="md-nav__link">
  789. External Secret Metrics
  790. </a>
  791. </li>
  792. <li class="md-nav__item">
  793. <a href="#cluster-secret-store-metrics" class="md-nav__link">
  794. Cluster Secret Store Metrics
  795. </a>
  796. </li>
  797. </ul>
  798. </nav>
  799. </div>
  800. </div>
  801. </div>
  802. <div class="md-content" data-md-component="content">
  803. <article class="md-content__inner md-typeset">
  804. <h1 id="metrics">Metrics</h1>
  805. <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>.</p>
  806. <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>
  807. <p>The Operator has <a href="https://book.kubebuilder.io/reference/metrics-reference.html">the controller-runtime metrics inherited from kubebuilder</a> plus some custom metrics with a resource name prefix, such as <code>externalsecret_</code>.</p>
  808. <h2 id="cluster-external-secret-metrics">Cluster External Secret Metrics</h2>
  809. <table>
  810. <thead>
  811. <tr>
  812. <th>Name</th>
  813. <th>Type</th>
  814. <th>Description</th>
  815. </tr>
  816. </thead>
  817. <tbody>
  818. <tr>
  819. <td><code>clusterexternalsecret_status_condition</code></td>
  820. <td>Gauge</td>
  821. <td>The status condition of a specific Cluster External Secret</td>
  822. </tr>
  823. <tr>
  824. <td><code>clusterexternalsecret_reconcile_duration</code></td>
  825. <td>Gauge</td>
  826. <td>The duration time to reconcile the Cluster External Secret</td>
  827. </tr>
  828. </tbody>
  829. </table>
  830. <h2 id="external-secret-metrics">External Secret Metrics</h2>
  831. <table>
  832. <thead>
  833. <tr>
  834. <th>Name</th>
  835. <th>Type</th>
  836. <th>Description</th>
  837. </tr>
  838. </thead>
  839. <tbody>
  840. <tr>
  841. <td><code>externalsecret_provider_api_calls_count</code></td>
  842. <td>Counter</td>
  843. <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>
  844. </tr>
  845. <tr>
  846. <td><code>externalsecret_sync_calls_total</code></td>
  847. <td>Counter</td>
  848. <td>Total number of the External Secret sync calls</td>
  849. </tr>
  850. <tr>
  851. <td><code>externalsecret_sync_calls_error</code></td>
  852. <td>Counter</td>
  853. <td>Total number of the External Secret sync errors</td>
  854. </tr>
  855. <tr>
  856. <td><code>externalsecret_status_condition</code></td>
  857. <td>Gauge</td>
  858. <td>The status condition of a specific External Secret</td>
  859. </tr>
  860. <tr>
  861. <td><code>externalsecret_reconcile_duration</code></td>
  862. <td>Gauge</td>
  863. <td>The duration time to reconcile the External Secret</td>
  864. </tr>
  865. </tbody>
  866. </table>
  867. <h2 id="cluster-secret-store-metrics">Cluster Secret Store Metrics</h2>
  868. <table>
  869. <thead>
  870. <tr>
  871. <th>Name</th>
  872. <th>Type</th>
  873. <th>Description</th>
  874. </tr>
  875. </thead>
  876. <tbody>
  877. <tr>
  878. <td><code>clustersecretstore_status_condition</code></td>
  879. <td>Gauge</td>
  880. <td>The status condition of a specific Cluster Secret Store</td>
  881. </tr>
  882. <tr>
  883. <td><code>clustersecretstore_reconcile_duration</code></td>
  884. <td>Gauge</td>
  885. <td>The duration time to reconcile the Cluster Secret Store</td>
  886. </tr>
  887. </tbody>
  888. </table>
  889. <h1 id="secret-store-metrics">Secret Store Metrics</h1>
  890. <table>
  891. <thead>
  892. <tr>
  893. <th>Name</th>
  894. <th>Type</th>
  895. <th>Description</th>
  896. </tr>
  897. </thead>
  898. <tbody>
  899. <tr>
  900. <td><code>secretstore_status_condition</code></td>
  901. <td>Gauge</td>
  902. <td>The status condition of a specific Secret Store</td>
  903. </tr>
  904. <tr>
  905. <td><code>secretstore_reconcile_duration</code></td>
  906. <td>Gauge</td>
  907. <td>The duration time to reconcile the Secret Store</td>
  908. </tr>
  909. </tbody>
  910. </table>
  911. <h2 id="controller-runtime-metrics">Controller Runtime Metrics</h2>
  912. <p>See <a href="https://book.kubebuilder.io/reference/metrics-reference.html">the kubebuilder documentation</a> on the default exported metrics by controller-runtime.</p>
  913. <h2 id="dashboard">Dashboard</h2>
  914. <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>
  915. <p><img alt="ESO Dashboard" src="../../pictures/eso-dashboard-1.png" />
  916. <img alt="ESO Dashboard" src="../../pictures/eso-dashboard-2.png" /></p>
  917. <h2 id="service-level-indicators-and-alerts">Service Level Indicators and Alerts</h2>
  918. <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>
  919. <h4 id="webhook-http-status-codes">Webhook HTTP Status Codes</h4>
  920. <p>The webhook HTTP status code indicates that a HTTP Request was answered successfully or not.
  921. 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>
  922. <p>SLI Example: request error percentage.
  923. <div class="highlight"><pre><span></span><code>sum(increase(controller_runtime_webhook_requests_total{service=~&quot;external-secrets.*&quot;,code=&quot;500&quot;}[1m]))
  924. /
  925. sum(increase(controller_runtime_webhook_requests_total{service=~&quot;external-secrets.*&quot;}[1m]))
  926. </code></pre></div></p>
  927. <h4 id="webhook-http-request-latency">Webhook HTTP Request Latency</h4>
  928. <p>If the webhook server is not able to respond in time then that may cause a timeout at the client.
  929. This failure may cascade down to the controller or any other user of <code>kube-apiserver</code>.</p>
  930. <p>SLI Example: p99 across all webhook requests.
  931. <div class="highlight"><pre><span></span><code>histogram_quantile(0.99,
  932. sum(rate(controller_runtime_webhook_latency_seconds_bucket{service=~&quot;external-secrets.*&quot;}[5m])) by (le)
  933. )
  934. </code></pre></div></p>
  935. <h4 id="controller-workqueue-depth">Controller Workqueue Depth</h4>
  936. <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>
  937. <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>
  938. <div class="highlight"><pre><span></span><code>sum(
  939. workqueue_depth{service=~&quot;external-secrets.*&quot;}
  940. ) by (name)
  941. </code></pre></div>
  942. <h4 id="controller-reconcile-latency">Controller Reconcile Latency</h4>
  943. <p>The controller should be able to reconcile resources within a reasonable timeframe. When latency is high secret delivery may impacted.</p>
  944. <p>SLI Example: p99 across all controllers.
  945. <div class="highlight"><pre><span></span><code>histogram_quantile(0.99,
  946. sum(rate(controller_runtime_reconcile_time_seconds_bucket{service=~&quot;external-secrets.*&quot;}[5m])) by (le)
  947. )
  948. </code></pre></div></p>
  949. <h4 id="controller-reconcile-error">Controller Reconcile Error</h4>
  950. <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>
  951. <div class="highlight"><pre><span></span><code>sum(increase(
  952. controller_runtime_reconcile_total{service=~&quot;external-secrets.*&quot;,controller=~&quot;$controller&quot;}[1m])
  953. ) by (result)
  954. </code></pre></div>
  955. </article>
  956. </div>
  957. </div>
  958. </main>
  959. <footer class="md-footer">
  960. <div class="md-footer-meta md-typeset">
  961. <div class="md-footer-meta__inner md-grid">
  962. <div class="md-copyright">
  963. <div class="md-copyright__highlight">
  964. &copy; 2023 The external-secrets Authors.<br/>
  965. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  966. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  967. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  968. </div>
  969. Made with
  970. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  971. Material for MkDocs
  972. </a>
  973. </div>
  974. </div>
  975. </div>
  976. </footer>
  977. </div>
  978. <div class="md-dialog" data-md-component="dialog">
  979. <div class="md-dialog__inner md-typeset"></div>
  980. </div>
  981. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  982. <script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
  983. </body>
  984. </html>