https://flanksource.com/assets/js/76502492.5d310e2b.js

1"use strict";(globalThis.webpackChunkmission_control=globalThis.webpackChunkmission_control||[]).push([[3828],{5533(e,r,t){t.r(r),t.d(r,{assets:()=>h,contentTitle:()=>i,default:()=>a,frontMatter:()=>d,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"guide/canary-checker/reference/jmeter","title":"JMeter","description":"The JMeter check runs the JMeter CLI with a JMX test plan.","source":"@site/docs/guide/canary-checker/reference/jmeter.mdx","sourceDirName":"guide/canary-checker/reference","slug":"/guide/canary-checker/reference/jmeter","permalink":"/docs/guide/canary-checker/reference/jmeter","draft":false,"unlisted":false,"editUrl":"https://github.com/flanksource/docs/tree/main/docs/guide/canary-checker/reference/jmeter.mdx","tags":[],"version":"current","frontMatter":{"title":"JMeter","sidebar_class_name":"beta"},"sidebar":"guide","previous":{"title":"Restic","permalink":"/docs/guide/canary-checker/reference/restic"},"next":{"title":"Examples","permalink":"/docs/guide/canary-checker/examples/"}}');var s=t(74848),c=t(28453);const d={title:"JMeter",sidebar_class_name:"beta"},i=" JMeter",h={},l=[];function o(e){const r={a:"a",code:"code",em:"em",h1:"h1",header:"header",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.R)(),...e.components},{CommonLink:t,FullImage:n,Icon:d,Standard:i}=r;return t||x("CommonLink",!0),n||x("FullImage",!0),d||x("Icon",!0),i||x("Standard",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsxs)(r.h1,{id:"-jmeter",children:[(0,s.jsx)(d,{name:"jmeter"})," JMeter"]})}),"\n",(0,s.jsx)(i,{}),"\n",(0,s.jsx)(n,{}),"\n",(0,s.jsx)(r.p,{children:"The JMeter check runs the JMeter CLI with a JMX test plan."}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-yaml",metastring:"title='jmeter-check.yaml' file=<rootDir>/modules/canary-checker/fixtures/minimal/jmeter.yaml",children:'apiVersion: canaries.flanksource.com/v1\nkind: Canary\nmetadata:\n  name: jmeter-check\nspec:\n  schedule: "@every 30s"\n  jmeter:\n    - name: jmeter check\n      host: 192.168.1.5\n      port: 1099\n      jmx:\n        valueFrom:\n          configMapKeyRef:\n            name: jmeter-config\n            key: sample\n'})}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{children:"Field"}),(0,s.jsx)(r.th,{children:"Description"}),(0,s.jsx)(r.th,{children:"Scheme"}),(0,s.jsx)(r.th,{children:"Required"})]})}),(0,s.jsxs)(r.tbody,{children:[(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.strong,{children:(0,s.jsx)(r.code,{children:"jmx"})})}),(0,s.jsx)(r.td,{children:"ConfigMap or Secret reference that contains the JMX test plan"}),(0,s.jsx)(r.td,{children:(0,s.jsx)(t,{to:"authentication",children:(0,s.jsx)(r.em,{children:"EnvVar"})})}),(0,s.jsx)(r.td,{children:"Yes"})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"properties"})}),(0,s.jsx)(r.td,{children:"Local JMeter properties"}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.em,{children:"[]string"})}),(0,s.jsx)(r.td,{})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"responseDuration"})}),(0,s.jsx)(r.td,{children:"Maximum total JTL elapsed time. The check fails when the elapsed time exceeds this duration."}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.em,{children:"Duration"})}),(0,s.jsx)(r.td,{})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"systemProperties"})}),(0,s.jsx)(r.td,{children:"Java system properties"}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.em,{children:"[]string"})}),(0,s.jsx)(r.td,{})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"host"})}),(0,s.jsxs)(r.td,{children:["Proxy host passed to the JMeter CLI ",(0,s.jsx)(r.code,{children:"-H"})," flag. The JMX plan defines the target under test."]}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.em,{children:"string"})}),(0,s.jsx)(r.td,{})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"port"})}),(0,s.jsxs)(r.td,{children:["Proxy port passed to the JMeter CLI ",(0,s.jsx)(r.code,{children:"-P"})," flag."]}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.em,{children:"int32"})}),(0,s.jsx)(r.td,{})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.strong,{children:(0,s.jsx)(r.code,{children:"name"})})}),(0,s.jsx)(r.td,{children:"Name of the check, must be unique within the canary"}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"string"})}),(0,s.jsx)(r.td,{children:"Yes"})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"description"})}),(0,s.jsx)(r.td,{children:"Description for the check"}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"string"})}),(0,s.jsx)(r.td,{})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"icon"})}

1),(0,s.jsx)(r.td,{children:"Icon for overwriting default icon on the dashboard"}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"string"})}),(0,s.jsx)(r.td,{})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"labels"})}),(0,s.jsx)(r.td,{children:"Labels for check"}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"map[string]string"})}),(0,s.jsx)(r.td,{})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"metrics"})}),(0,s.jsx)(r.td,{children:"Metrics to export from"}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.a,{href:"../concepts/metrics#custom-metrics",children:(0,s.jsx)(r.code,{children:"[]Metrics"})})}),(0,s.jsx)(r.td,{})]})]})]})]})}function a(e={}){const{wrapper:r}={...(0,c.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}function x(e,r){throw new Error("Expected "+(r?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},28453(e,r,t){t.d(r,{R:()=>d,x:()=>i});var n=t(96540);const s={},c=n.createContext(s);function d(e){const r=n.useContext(c);return n.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),n.createElement(c.Provider,{value:r},e.children)}}}]);