Extension grafana

actions/com.steadybit.extension_grafana.alert-rule.check/description.yml

@@ -0,0 +1,12 @@
+---
+id: com.steadybit.extension_grafana.alert-rule.check
+label: alert-rule check
+description: Collects information about the alert-rule state and optionally verifies that the monitor has an expected state.
+icon: |
+  <svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <path fill-rule="evenodd" clip-rule="evenodd" d="M12 2C11.1614 2 10.4433 2.51616 10.1461 3.24812C7.17983 4.06072 5 6.77579 5 10V14.6972L3.16795 17.4453C2.96338 17.7522 2.94431 18.1467 3.11833 18.4719C3.29235 18.797 3.63121 19 4 19H8.53544C8.77806 20.6961 10.2368 22 12 22C13.7632 22 15.2219 20.6961 15.4646 19H20C20.3688 19 20.7077 18.797 20.8817 18.4719C21.0557 18.1467 21.0366 17.7522 20.832 17.4453L19 14.6972V10C19 6.77579 16.8202 4.06072 13.8539 3.24812C13.5567 2.51616 12.8386 2 12 2ZM12 20C11.3469 20 10.7913 19.5826 10.5854 19H13.4146C13.2087 19.5826 12.6531 20 12 20ZM16.7943 10.7842C16.7962 10.8002 16.7981 10.8159 16.8 10.8314L16.7557 10.9069C16.7668 11.0578 16.7668 11.1873 16.7668 11.2951C16.7668 11.3382 16.7335 11.3814 16.6892 11.3814C16.671 11.3902 16.6603 11.3845 16.6447 11.3762C16.6414 11.3744 16.6378 11.3725 16.6339 11.3706C16.6117 11.3598 16.6007 11.3382 16.6007 11.3167C16.5785 11.2088 16.5453 11.0902 16.501 10.9608C16.4862 10.9105 16.4616 10.8505 16.437 10.7906C16.4247 10.7607 16.4124 10.7307 16.4013 10.702C16.3976 10.6948 16.3927 10.6876 16.3878 10.6804C16.3779 10.666 16.3681 10.6516 16.3681 10.6373L16.3349 10.5725C16.3238 10.5402 16.3016 10.4971 16.3016 10.4971L16.2795 10.4647L16.2574 10.4324C16.1577 10.2167 16.0248 10.0118 15.8808 9.82843C15.8033 9.73137 15.7147 9.62353 15.6261 9.52647C15.6034 9.51173 15.5859 9.49195 15.57 9.47403C15.5626 9.46572 15.5556 9.45781 15.5486 9.45098C15.5335 9.42887 15.5132 9.4118 15.4948 9.39632C15.4862 9.38915 15.4781 9.38232 15.4711 9.37549C15.4559 9.35338 15.4356 9.33631 15.4172 9.32083C15.4087 9.31366 15.4006 9.30683 15.3936 9.3C15.3714 9.28921 15.3603 9.27843 15.3493 9.26765C15.3271 9.25686 15.316 9.24608 15.305 9.23529C15.0835 9.05196 14.8288 8.87941 14.5409 8.73922C14.2529 8.59902 13.9428 8.49118 13.6106 8.42647C13.5706 8.42127 13.5306 8.41545 13.4904 8.4096C13.3638 8.39119 13.2357 8.37255 13.1012 8.37255H12.8354H12.769H12.7358H12.6915H12.6139H12.5918H12.5807H12.5475H12.5032H12.4257H12.3482H12.2817L12.2485 8.38333H12.2153C12.1931 8.39412 12.171 8.39412 12.1488 8.39412C12.1267 8.4049 12.1045 8.4049 12.0824 8.4049C12.0602 8.41569 12.0381 8.41569 12.0159 8.41569L11.883 8.44804C11.8609 8.45882 11.8387 8.46961 11.8166 8.46961C11.7945 8.48039 11.7723 8.49118 11.7502 8.49118C11.6837 8.51274 11.6271 8.53431 11.5705 8.55588C11.5422 8.56667 11.5139 8.57745 11.4844 8.58823C11.465 8.6008 11.4419 8.60971 11.4172 8.61922C11.3995 8.62603 11.381 8.63315 11.3626 8.64216C11.3404 8.65294 11.321 8.66372 11.3017 8.67451C11.2823 8.68529 11.2629 8.69608 11.2407 8.70686L11.2407 8.70688C11.1632 8.75001 11.0857 8.79314 11.0082 8.84706C10.9694 8.87402 10.9334 8.90098 10.8974 8.92794C10.8615 8.9549 10.8255 8.98186 10.7867 9.00882C10.7092 9.06274 10.6427 9.12745 10.5763 9.19216C10.3105 9.45098 10.078 9.78529 9.91184 10.152C9.83432 10.3353 9.7568 10.5294 9.70143 10.7343C9.6682 10.8422 9.64606 10.9392 9.62391 11.0471C9.62071 11.0626 9.61751 11.078 9.61435 11.0931C9.5956 11.1831 9.57801 11.2675 9.56854 11.3598C9.55746 11.4676 9.54639 11.5755 9.54639 11.6725V11.7696V11.9422V11.9853C9.55746 12.1902 9.59069 12.3843 9.64606 12.5892C9.70143 12.7941 9.77895 12.9882 9.86754 13.1716C9.95613 13.3549 10.0669 13.5382 10.1998 13.7C10.4655 14.0235 10.7978 14.2931 11.1632 14.498C11.3515 14.5951 11.5508 14.6814 11.7502 14.7353C11.9495 14.7892 12.1599 14.8324 12.3703 14.8431H12.5253H12.6804C12.7801 14.8431 12.8797 14.8324 12.9794 14.8108C13.1787 14.7784 13.367 14.7245 13.5442 14.6382C13.9096 14.4765 14.2197 14.2176 14.4523 13.8941C14.5741 13.7324 14.6627 13.5598 14.7402 13.3765C14.7734 13.2902 14.8066 13.1931 14.8288 13.0961C14.832 13.0835 14.8362 13.07 14.8405 13.0561C14.8509 13.0224 14.862 12.9864 14.862 12.9559C14.8731 12.9127 14.8842 12.8588 14.8842 12.8157C14.8952 12.7618 14.8952 12.7078 14.8952 12.6647V12.5892V12.4598V12.4274V12.3951C14.8952 12.3666 14.8921 12.3412 14.8892 12.3171C14.8866 12.2956 14.8842 12.2753 14.8842 12.2549C14.8509 12.0824 14.7956 11.9098 14.718 11.748C14.5519 11.4353 14.2972 11.1657 13.9871 10.9931C13.8321 10.9069 13.666 10.8422 13.4999 10.8098C13.4909 10.8076 13.4821 10.8054 13.4733 10.8033C13.3955 10.7841 13.3248 10.7667 13.2452 10.7667H13.1234H13.0015C12.924 10.7775 12.8465 10.7882 12.769 10.8098C12.6915 10.8314 12.6139 10.8637 12.5475 10.8961C12.4811 10.9284 12.4146 10.9716 12.3482 11.0147L12.3482 11.0147C12.2928 11.0578 12.2263 11.1118 12.171 11.1657C11.9495 11.3814 11.8055 11.6618 11.7502 11.9529C11.7391 11.9853 11.7391 12.0284 11.7391 12.0608V12.0931V12.1147V12.1686C11.7391 12.201 11.7418 12.236 11.7446 12.2711C11.7474 12.3061 11.7502 12.3412 11.7502 12.3735C11.7723 12.5137 11.8166 12.6324 11.883 12.751C11.9384 12.8696 12.027 12.9667 12.1156 13.0529C12.2042 13.1392 12.3039 13.2039 12.4146 13.2578C12.5253 13.3118 12.6361 13.3441 12.7468 13.3549H12.7911H12.8133H12.8354H12.8797H12.9572H13.0015H13.0791C13.1178 13.3549 13.1511 13.3444 13.1828 13.3343C13.1964 13.33 13.2097 13.3258 13.223 13.3225C13.2673 13.3118 13.3559 13.2686 13.3559 13.2686L13.3891 13.2471C13.4445 13.2255 13.4999 13.2363 13.5331 13.2794C13.5663 13.3333 13.5552 13.398 13.511 13.4412C13.4999 13.4466 13.4916 13.4547 13.4846 13.4614C13.4777 13.4681 13.4722 13.4735 13.4667 13.4735C13.4268 13.4891 13.3926 13.5102 13.356 13.5329C13.3417 13.5417 13.3271 13.5507 13.3116 13.5598C13.2752 13.5864 13.2239 13.6057 13.1761 13.6237C13.1657 13.6276 13.1554 13.6314 13.1455 13.6353C13.1414 13.6373 13.1369 13.6397 13.1321 13.6422C13.111 13.6534 13.0839 13.6676 13.0569 13.6676C13.0458 13.6784 13.0348 13.6784 13.0126 13.6784H13.0126H12.9572H12.9351H12.924H12.9129H12.8686H12.8465H12.769C12.625 13.6784 12.4811 13.6569 12.326 13.6137C12.182 13.5598 12.027 13.4951 11.883 13.398C11.7391 13.301 11.6062 13.1716 11.4954 13.0206C11.3847 12.8696 11.2961 12.6863 11.2407 12.4922C11.2355 12.4693 11.2297 12.4465 11.2238 12.4235C11.2048 12.3488 11.1854 12.2727 11.1854 12.1902V12.1147V12.0284V11.8667C11.1964 11.651 11.2407 11.4353 11.3183 11.2304C11.3958 11.0147 11.5176 10.8098 11.6616 10.6373C11.8166 10.4539 12.0049 10.2922 12.2153 10.1627C12.4368 10.0333 12.6804 9.93627 12.9351 9.89314C13.0015 9.87157 13.068 9.86078 13.1344 9.86078H13.1898H13.3338H13.3338C13.4667 9.86078 13.5885 9.86078 13.7214 9.88235C13.9761 9.9147 14.2308 9.9902 14.4855 10.098C14.7402 10.2167 14.9727 10.3676 15.1832 10.551C15.4046 10.7343 15.5929 10.9608 15.7369 11.2088C15.8808 11.4569 16.0026 11.7373 16.0691 12.0284C16.0912 12.1039 16.1023 12.1794 16.1134 12.2549L16.1134 12.2549L16.1245 12.3088V12.3627V12.4167V12.4706V12.5353V12.6971V12.9235V13.0529H16.1355C16.2241 13.1176 16.6007 13.452 16.7114 14.1314C16.7114 14.1314 16.2574 14.5735 15.604 14.5412L15.5597 14.6167C15.3936 14.8647 15.1942 15.1127 14.9617 15.3176C14.8509 15.4255 14.7402 15.5118 14.6184 15.598V15.652C14.6184 15.7814 14.5851 16.3961 14.0093 17C14.0093 17 13.2119 16.9029 12.7468 16.2451H12.5918H12.3592C12.0602 16.2235 11.7502 16.1804 11.4512 16.1049C11.3515 16.0833 11.2518 16.051 11.1522 16.0186L11.1521 16.0186C11.0193 16.1265 10.377 16.5902 9.40242 16.5578C9.40242 16.5578 9.03698 15.7922 9.35813 14.8755C9.28061 14.8 9.20309 14.7137 9.13664 14.6274C8.97053 14.4225 8.82657 14.1961 8.69368 13.9696C8.69368 13.9696 7.67485 13.9049 6.79999 12.8912C6.79999 12.8912 7.11007 11.8235 8.16211 11.2951C8.16211 11.2735 8.16488 11.252 8.16765 11.2304C8.17042 11.2088 8.17319 11.1873 8.17319 11.1657C8.21748 10.8745 8.27286 10.5941 8.36145 10.3137C8.37252 10.276 8.38637 10.2382 8.40021 10.2005C8.41405 10.1627 8.42789 10.125 8.43897 10.0873C8.32823 9.94706 7.78559 9.18137 7.87418 7.96274C7.87418 7.96274 8.87086 7.43431 10.0115 7.88725H10.0447C10.1555 7.81176 10.2662 7.73627 10.388 7.67157C10.5098 7.60686 10.6317 7.54216 10.7535 7.48824C10.7867 7.47745 10.8172 7.46397 10.8476 7.45049C10.8781 7.43701 10.9085 7.42353 10.9417 7.41274C10.975 7.40196 11.0054 7.39118 11.0359 7.38039C11.0663 7.36961 11.0968 7.35882 11.13 7.34804C11.1521 7.34265 11.1743 7.33456 11.1964 7.32647C11.2186 7.31838 11.2407 7.31029 11.2629 7.3049V7.26176C11.2629 7.26176 11.4179 6.52843 12.2374 6C12.2374 6 12.9683 6.3451 13.223 7.16471H13.2784C13.3153 7.1719 13.3522 7.17789 13.3891 7.18388C13.463 7.19586 13.5368 7.20784 13.6106 7.22941C13.7003 7.24689 13.7828 7.27144 13.8698 7.29734C13.8901 7.30341 13.9108 7.30955 13.9318 7.31569C14.0425 7.34804 14.1422 7.38039 14.2418 7.42353C14.2492 7.42712 14.2566 7.43192 14.264 7.43671C14.2788 7.4463 14.2935 7.45588 14.3083 7.45588C14.4412 7.35882 14.8177 7.14314 15.4046 7.17549C15.4046 7.17549 15.7479 7.70392 15.5929 8.31863C15.6253 8.3537 15.6577 8.38763 15.6898 8.42117C15.7562 8.49074 15.821 8.5586 15.8808 8.63137C16.0802 8.87941 16.2574 9.14902 16.4013 9.4402C16.5231 9.67745 16.6228 9.93627 16.6892 10.1951C16.7501 10.4123 16.7738 10.6114 16.7943 10.7842Z" fill="#1D2632"/>
+  </svg>
+kind: check
+category: monitoring
+targetType: com.steadybit.extension_grafana.alert-rule
+extension: com.steadybit.extension_grafana

actions/com.steadybit.extension_grafana.alert-rule.check/previews.yml

@@ -0,0 +1,16 @@
+---
+- type: image
+  src: 1.png
+  alt: The alert rule check within the experiment editor.
+- type: image
+  src: 2.png
+  alt: The run log shows an experiment failed because of an unexpected monitor status.
+- type: image
+  src: 3.png
+  alt: Part of the run view is a visualization of the alert rule state over time.
+- type: image
+  src: 4.png
+  alt: Events are reported to Grafana as annotations to indicate when a chaos engineering experiment is executed.
+- type: image
+  src: 5.png
+  alt: Overlay the annotations to your dashboards or panels in Grafana.

actions/com.steadybit.extension_grafana.alert-rule.check/summary.mdx

@@ -0,0 +1,20 @@
+# Introduction
+
+The alert rule check step can be dragged&dropped into the experiment editor. Once done, you can use it to collect information about the state of the Grafana alert rules and, optionally, to verify that they are within the expected state.
+
+Experiments can be aborted and marked as failed when the Grafana alert rule check's actual state diverges from the expected state. This helps implement pre-/post-conditions and invariants. For example, to only start an experiment when the system is healthy.
+
+At last, to help you understand the alert rule states and how they evolved, the run view also contains a state visualization. Through this visualization, you can see what states the Alert rules had throughout the experiment execution.
+
+# Use Cases
+
+ - Pre-/postcondition or invariant for any experiment.
+ - Verify that alerts are triggered during incidents.
+
+# Parameters
+
+| Parameter | Description                           | Default |
+| --------- | ------------------------------------- | ------- |
+| Duration  | How long should the state of the alert rule be checked | 30s     |
+| Expected State  | The expected state of the alert rule. One of Inactive, Normal, Pending, Firing. |      |
+| State Check Mode | How often should the state be expected. "At least once" or "All the time" | "All the time" |

extensions/com.steadybit.extension_grafana/description.yml

@@ -0,0 +1,27 @@
+---
+id: com.steadybit.extension_grafana
+label: Grafana
+description: A Steadybit check implementation for data exposed through Grafana.
+icon: |
+  <svg fill="#000000" width="800px" height="800px" viewBox="0 0 24 24" role="img" xmlns="http://www.w3.org/2000/svg"><path d="M23.02 10.59a8.578 8.578 0 0 0-.862-3.034 8.911 8.911 0 0 0-1.789-2.445c.337-1.342-.413-2.505-.413-2.505-1.292-.08-2.113.4-2.416.62-.052-.02-.102-.044-.154-.064-.22-.089-.446-.172-.677-.247-.231-.073-.47-.14-.711-.197a9.867 9.867 0 0 0-.875-.161C14.557.753 12.94 0 12.94 0c-1.804 1.145-2.147 2.744-2.147 2.744l-.018.093c-.098.029-.2.057-.298.088-.138.042-.275.094-.413.143-.138.055-.275.107-.41.166a8.869 8.869 0 0 0-1.557.87l-.063-.029c-2.497-.955-4.716.195-4.716.195-.203 2.658.996 4.33 1.235 4.636a11.608 11.608 0 0 0-.607 2.635C1.636 12.677.953 15.014.953 15.014c1.926 2.214 4.171 2.351 4.171 2.351.003-.002.006-.002.006-.005.285.509.615.994.986 1.446.156.19.32.371.488.548-.704 2.009.099 3.68.099 3.68 2.144.08 3.553-.937 3.849-1.173a9.784 9.784 0 0 0 3.164.501h.08l.055-.003.107-.002.103-.005.003.002c1.01 1.44 2.788 1.646 2.788 1.646 1.264-1.332 1.337-2.653 1.337-2.94v-.058c0-.02-.003-.039-.003-.06.265-.187.52-.387.758-.6a7.875 7.875 0 0 0 1.415-1.7c1.43.083 2.437-.885 2.437-.885-.236-1.49-1.085-2.216-1.264-2.354l-.018-.013-.016-.013a.217.217 0 0 1-.031-.02c.008-.092.016-.18.02-.27.011-.162.016-.323.016-.48v-.253l-.005-.098-.008-.135a1.891 1.891 0 0 0-.01-.13c-.003-.042-.008-.083-.013-.125l-.016-.124-.018-.122a6.215 6.215 0 0 0-2.032-3.73 6.015 6.015 0 0 0-3.222-1.46 6.292 6.292 0 0 0-.85-.048l-.107.002h-.063l-.044.003-.104.008a4.777 4.777 0 0 0-3.335 1.695c-.332.4-.592.84-.768 1.297a4.594 4.594 0 0 0-.312 1.817l.003.091c.005.055.007.11.013.164a3.615 3.615 0 0 0 .698 1.82 3.53 3.53 0 0 0 1.827 1.282c.33.098.66.14.971.137.039 0 .078 0 .114-.002l.063-.003c.02 0 .041-.003.062-.003.034-.002.065-.007.099-.01.007 0 .018-.003.028-.003l.031-.005.06-.008a1.18 1.18 0 0 0 .112-.02c.036-.008.072-.013.109-.024a2.634 2.634 0 0 0 .914-.415c.028-.02.056-.041.085-.065a.248.248 0 0 0 .039-.35.244.244 0 0 0-.309-.06l-.078.042c-.09.044-.184.083-.283.116a2.476 2.476 0 0 1-.475.096c-.028.003-.054.006-.083.006l-.083.002c-.026 0-.054 0-.08-.002l-.102-.006h-.012l-.024.006c-.016-.003-.031-.003-.044-.006-.031-.002-.06-.007-.091-.01a2.59 2.59 0 0 1-.724-.213 2.557 2.557 0 0 1-.667-.438 2.52 2.52 0 0 1-.805-1.475 2.306 2.306 0 0 1-.029-.444l.006-.122v-.023l.002-.031c.003-.021.003-.04.005-.06a3.163 3.163 0 0 1 1.352-2.29 3.12 3.12 0 0 1 .937-.43 2.946 2.946 0 0 1 .776-.101h.06l.07.002.045.003h.026l.07.005a4.041 4.041 0 0 1 1.635.49 3.94 3.94 0 0 1 1.602 1.662 3.77 3.77 0 0 1 .397 1.414l.005.076.003.075c.002.026.002.05.002.075 0 .024.003.052 0 .07v.065l-.002.073-.008.174a6.195 6.195 0 0 1-.08.639 5.1 5.1 0 0 1-.267.927 5.31 5.31 0 0 1-.624 1.13 5.052 5.052 0 0 1-3.237 2.014 4.82 4.82 0 0 1-.649.066l-.039.003h-.287a6.607 6.607 0 0 1-1.716-.265 6.776 6.776 0 0 1-3.4-2.274 6.75 6.75 0 0 1-.746-1.15 6.616 6.616 0 0 1-.714-2.596l-.005-.083-.002-.02v-.056l-.003-.073v-.096l-.003-.104v-.07l.003-.163c.008-.22.026-.45.054-.678a8.707 8.707 0 0 1 .28-1.355c.128-.444.286-.872.473-1.277a7.04 7.04 0 0 1 1.456-2.1 5.925 5.925 0 0 1 .953-.763c.169-.111.343-.213.524-.306.089-.05.182-.091.273-.135.047-.02.093-.042.138-.062a7.177 7.177 0 0 1 .714-.267l.145-.045c.049-.015.098-.026.148-.041.098-.029.197-.052.296-.076.049-.013.1-.02.15-.033l.15-.032.151-.028.076-.013.075-.01.153-.024c.057-.01.114-.013.171-.023l.169-.021c.036-.003.073-.008.106-.01l.073-.008.036-.003.042-.002c.057-.003.114-.008.171-.01l.086-.006h.023l.037-.003.145-.007a7.999 7.999 0 0 1 1.708.125 7.917 7.917 0 0 1 2.048.68 8.253 8.253 0 0 1 1.672 1.09l.09.077.089.078c.06.052.114.107.171.159.057.052.112.106.166.16.052.055.107.107.159.164a8.671 8.671 0 0 1 1.41 1.978c.012.026.028.052.04.078l.04.078.075.156c.023.051.05.1.07.153l.065.15a8.848 8.848 0 0 1 .45 1.34.19.19 0 0 0 .201.142.186.186 0 0 0 .172-.184c.01-.246.002-.532-.024-.856z"/></svg>
+maintainer: com.steadybit
+license: MIT
+gitHub:
+  owner: steadybit
+  repository: extension-grafana
+ghcr:
+  owner: steadybit
+  repository: extension-grafana
+  package: extension-grafana
+helmChart:
+  repository: https://steadybit.github.io/extension-grafana
+  name: steadybit-extension-grafana
+homepage: https://hub.steadybit.com/extension/com.steadybit.extension_grafana
+installation: https://github.com/steadybit/extension-grafana#installation
+changelog: https://github.com/steadybit/extension-grafana/blob/main/CHANGELOG.md
+tags:
+  - Grafana
+  - Kubernetes
+  - Check
+  - Observability
+  - Monitoring

extensions/com.steadybit.extension_grafana/previews.yml

@@ -0,0 +1,13 @@
+---
+- type: image
+  src: steadybit_experiment_editor.png
+  alt: Steadybit's "Alert Rule Check" allows you to verify the behaviour of your Grafana alert rules.
+- type: image
+  src: steadybit_grafana_experiment_execution_run_log.png
+  alt: The run log showing that an experiment completed because the alert rule state is the one expected for this kind of failure.
+- type: image
+  src: grafana_annotations.png
+  alt: Steadybit events are reported to Grafana as annotations with tags to filter them easily.
+- type: image
+  src: grafana_steadybit_events.png
+  alt: Steadybit events as Grafana annotations can be showed on dashboards to ease analyzing causes and effects.

extensions/com.steadybit.extension_grafana/summary.mdx

@@ -0,0 +1,17 @@
+# Introduction to the Grafana Extension
+The Steadybit Grafana Extension bridges the world of Steadybit and Grafana.
+The extension adds checks to your Chaos Engineering experiments to validate Grafana Alert rules state and reports events of your experiments to Grafana [as annotations to ease correlation](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/).
+
+# Integration and Functionality
+Integration of Grafana into Steadybit works via the Grafana API.
+Thus, all you need is a Grafana's [Service Account Token](https://grafana.com/docs/grafana/latest/developers/http_api/create-api-tokens-for-org/).
+
+## Integration of Grafana in Steadybit
+With the [Alert Rule Check](/action/com.steadybit.extension_grafana.alert-rule.check) you can integrate your Grafana alert rules into your experiments.
+Verify that Grafana alert rules notice a fault injected by Steadybit to check that your observability strategy is working as expected.
+
+## Integration of Steadybit in Grafana
+The extension automatically reports experiment executions to Grafana, which helps you to correlate experiments with your dashboards.
+
+# Installation and Setup
+To integrate the Grafana extension with your environment, follow our [setup guide](https://github.com/steadybit/extension-grafana#installation).