| "use strict";(self.webpackChunkhertzbeat=self.webpackChunkhertzbeat||[]).push([[61030],{15680:(e,n,t)=>{t.d(n,{xA:()=>c,yg:()=>d});var i=t(96540);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function a(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?r(Object(t),!0).forEach((function(n){o(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):r(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function l(e,n){if(null==e)return{};var t,i,o=function(e,n){if(null==e)return{};var t,i,o={},r=Object.keys(e);for(i=0;i<r.length;i++)t=r[i],n.indexOf(t)>=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i<r.length;i++)t=r[i],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var s=i.createContext({}),p=function(e){var n=i.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},c=function(e){var n=p(e.components);return i.createElement(s.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},m=i.forwardRef((function(e,n){var t=e.components,o=e.mdxType,r=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),m=p(t),d=o,f=m["".concat(s,".").concat(d)]||m[d]||u[d]||r;return t?i.createElement(f,a(a({ref:n},c),{},{components:t})):i.createElement(f,a({ref:n},c))}));function d(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var r=t.length,a=new Array(r);a[0]=m;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l.mdxType="string"==typeof e?e:o,a[1]=l;for(var p=2;p<r;p++)a[p]=t[p];return i.createElement.apply(null,a)}return i.createElement.apply(null,t)}m.displayName="MDXCreateElement"},54225:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>l,toc:()=>p});var i=t(58168),o=(t(96540),t(15680));const r={id:"extend-point",title:"Custom Monitoring",sidebar_label:"Custom Monitoring"},a=void 0,l={unversionedId:"advanced/extend-point",id:"version-v1.1.x/advanced/extend-point",title:"Custom Monitoring",description:"HertzBeat has custom monitoring ability. You only need to configure two YML file to fit a custom monitoring type.",source:"@site/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-point.md",sourceDirName:"advanced",slug:"/advanced/extend-point",permalink:"/docs/v1.1.x/advanced/extend-point",draft:!1,editUrl:"https://github.com/dromara/hertzbeat/edit/master/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-point.md",tags:[],version:"v1.1.x",frontMatter:{id:"extend-point",title:"Custom Monitoring",sidebar_label:"Custom Monitoring"},sidebar:"docs",previous:{title:"Practice Example",permalink:"/docs/v1.1.x/start/ssl-cert-practice"},next:{title:"Quick Tutorial",permalink:"/docs/v1.1.x/advanced/extend-tutorial"}},s={},p=[{value:"Custom Steps",id:"custom-steps",level:3},{value:"Monitoring configuration definition file",id:"monitoring-configuration-definition-file",level:3}],c={toc:p};function u(e){let{components:n,...t}=e;return(0,o.yg)("wrapper",(0,i.A)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,o.yg)("blockquote",null,(0,o.yg)("p",{parentName:"blockquote"},"HertzBeat has custom monitoring ability. You only need to configure two YML file to fit a custom monitoring type.",(0,o.yg)("br",{parentName:"p"}),"\n","Custom monitoring currently supports ",(0,o.yg)("a",{parentName:"p",href:"extend-http"},"HTTP protocol"),"\uff0c",(0,o.yg)("a",{parentName:"p",href:"extend-jdbc"},"JDBC protocol"),"(mysql,mariadb,postgresql...), ",(0,o.yg)("a",{parentName:"p",href:"extend-ssh"},"SSH protocol"),", JMX protocol, SNMP protocol. And it will support more general protocols in the future. ")),(0,o.yg)("h3",{id:"custom-steps"},"Custom Steps"),(0,o.yg)("p",null,"In order to configure a custom monitoring type, you need to add and configure YML file."),(0,o.yg)("ol",null,(0,o.yg)("li",{parentName:"ol"},"Monitoring configuration definition file named after monitoring type - eg\uff1aexample.yml should be in the installation directory /hertzbeat/app/"),(0,o.yg)("li",{parentName:"ol"},"Restart hertzbeat system, we successfully fit a new custom monitoring type. ")),(0,o.yg)("hr",null),(0,o.yg)("p",null,"Configuration usages of the file are detailed below."),(0,o.yg)("h3",{id:"monitoring-configuration-definition-file"},"Monitoring configuration definition file"),(0,o.yg)("blockquote",null,(0,o.yg)("p",{parentName:"blockquote"},"Monitoring configuration definition file is used to define ",(0,o.yg)("em",{parentName:"p"},"the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information"),", etc. ")),(0,o.yg)("p",null,"eg\uff1aDefine a custom monitoring type named example which use the HTTP protocol to collect data.",(0,o.yg)("br",{parentName:"p"}),"\n","The file name: example.yml in /define/example.yml "),(0,o.yg)("pre",null,(0,o.yg)("code",{parentName:"pre",className:"language-yaml"},"# The monitoring type category\uff1aservice-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring\ncategory: custom\n# Monitoring application type(consistent with the file name) eg: linux windows tomcat mysql aws...\napp: example\nname:\n zh-CN: \u6a21\u62df\u5e94\u7528\u7c7b\u578b\n en-US: EXAMPLE APP\nparam:\n # field-field name identifier \n - field: host\n # name-parameter field display name \n name:\n zh-CN: \u4e3b\u673aHost\n en-US: Host\n # type-field type, style(most mappings are input label type attribute)\n type: host\n # required or not true-required false-optional\n required: true\n - field: port\n name:\n zh-CN: \u7aef\u53e3\n en-US: Port\n type: number\n # When type is number, range is used to represent the range.\n range: '[0,65535]'\n required: true\n # port default\n defaultValue: 80\n # Prompt information of parameter input box \n placeholder: 'Please enter the port'\n - field: username\n name:\n zh-CN: \u7528\u6237\u540d\n en-US: Username\n type: text\n # When type is text, use limit to indicate the string limit size\n limit: 20\n required: false\n - field: password\n name:\n zh-CN: \u5bc6\u7801\n en-US: Password\n type: password\n required: false\n - field: ssl\n name:\n zh-CN: \u542f\u52a8SSL\n en-US: Enable SSL\n # When type is boolean, front end uses switch to show the switch\n type: boolean\n required: false\n - field: method\n name:\n zh-CN: \u8bf7\u6c42\u65b9\u5f0f\n en-US: Method\n type: radio\n required: true\n # When type is radio or checkbox, option indicates the list of selectable values {name1:value1,name2:value2}\n options:\n - label: GET request\n value: GET\n - label: POST request\n value: POST\n - label: PUT request\n value: PUT\n - label: DELETE request\n value: DELETE\n# Metric group list\nmetrics:\n# The first monitoring Metric group cpu\n# Note\uff1a: the built-in monitoring Metrics have (responseTime - response time)\n - name: cpu\n # The smaller Metric group scheduling priority(0-127), the higher the priority. After completion of the high priority Metric group collection,the low priority Metric group will then be scheduled. Metric groups with the same priority will be scheduled in parallel.\n # Metric group with a priority of 0 is an availability group which will be scheduled first. If the collection succeeds, the scheduling will continue otherwise interrupt scheduling.\n priority: 0\n # metrics fields list\n fields:\n # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit\n - field: hostname\n type: 1\n instance: true\n - field: usage\n type: 0\n unit: '%'\n - field: cores\n type: 0\n - field: waitTime\n type: 0\n unit: s\n# (optional)Monitoring Metric alias mapping to the Metric name above. The field used to collect interface data is not the final Metric name directly. This alias is required for mapping conversion.\n aliasFields:\n - hostname\n - core1\n - core2\n - usage\n - allTime\n - runningTime\n# (optional)The Metric calculation expression works with the above alias to calculate the final required Metric value.\n# eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime\n calculates:\n - hostname=hostname\n - cores=core1+core2\n - usage=usage\n - waitTime=allTime-runningTime\n# protocol for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk\n protocol: http\n# Specific collection configuration when the protocol is HTTP protocol \n http:\n # host: ipv4 ipv6 domain name \n host: ^_^host^_^\n # port\n port: ^_^port^_^\n # url request interface path \n url: /metrics/cpu\n # request mode GET POST PUT DELETE PATCH\n method: GET\n # enable ssl/tls or not, tthat is to say, HTTP or HTTPS. The default is false\n ssl: false\n # request header content \n headers:\n apiVersion: v1\n # request parameter content \n params:\n param1: param1\n param2: param2\n # authorization \n authorization:\n # authorization method : Basic Auth, Digest Auth, Bearer Token\n type: Basic Auth\n basicAuthUsername: ^_^username^_^\n basicAuthPassword: ^_^password^_^\n # parsing method for reponse data: default-system rules, jsonPath-jsonPath script, website-website availability Metric monitoring \n # todo xmlPath-xmlPath script,prometheus-Prometheus data rules\n parseType: jsonPath\n parseScript: '$'\n\n - name: memory\n priority: 1\n fields:\n - field: hostname\n type: 1\n instance: true\n - field: total\n type: 0\n unit: kb\n - field: usage\n type: 0\n unit: '%'\n - field: speed\n type: 0\n protocol: http\n http:\n host: ^_^host^_^\n port: ^_^port^_^\n url: /metrics/memory\n method: GET\n headers:\n apiVersion: v1\n params:\n param1: param1\n param2: param2\n authorization:\n type: Basic Auth\n basicAuthUsername: ^_^username^_^\n basicAuthPassword: ^_^password^_^\n parseType: default\n")))}u.isMDXComponent=!0}}]); |