blob: 694ca8f49aa1f8cc6863e8bd1c3dfc60966dc5cf [file] [log] [blame]
"use strict";(self.webpackChunkhertzbeat=self.webpackChunkhertzbeat||[]).push([[49392],{15680:(e,t,n)=>{n.d(t,{xA:()=>u,yg:()=>d});var r=n(96540);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},o=Object.keys(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),c=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},p=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),p=c(n),d=a,g=p["".concat(s,".").concat(d)]||p[d]||m[d]||o;return n?r.createElement(g,i(i({ref:t},u),{},{components:n})):r.createElement(g,i({ref:t},u))}));function d(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=p;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:a,i[1]=l;for(var c=2;c<o;c++)i[c]=n[c];return r.createElement.apply(null,i)}return r.createElement.apply(null,n)}p.displayName="MDXCreateElement"},9526:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>m,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var r=n(58168),a=(n(96540),n(15680));const o={id:"custom-config",title:"Advanced Config",sidebar_label:"Advanced Config"},i=void 0,l={unversionedId:"start/custom-config",id:"version-v1.1.x/start/custom-config",title:"Advanced Config",description:"This describes how to configure the SMS server, the number of built-in availability alarm triggers, etc.",source:"@site/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/custom-config.md",sourceDirName:"start",slug:"/start/custom-config",permalink:"/docs/v1.1.x/start/custom-config",draft:!1,editUrl:"https://github.com/dromara/hertzbeat/edit/master/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/custom-config.md",tags:[],version:"v1.1.x",frontMatter:{id:"custom-config",title:"Advanced Config",sidebar_label:"Advanced Config"},sidebar:"docs",previous:{title:"Update Account(Optional)",permalink:"/docs/v1.1.x/start/account-modify"},next:{title:"Practice Example",permalink:"/docs/v1.1.x/start/ssl-cert-practice"}},s={},c=[{value:"Configure the configuration file of HertzBeat",id:"configure-the-configuration-file-of-hertzbeat",level:3}],u={toc:c};function m(e){let{components:t,...n}=e;return(0,a.yg)("wrapper",(0,r.A)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.yg)("p",null,"This describes how to configure the SMS server, the number of built-in availability alarm triggers, etc."),(0,a.yg)("p",null,(0,a.yg)("strong",{parentName:"p"},"Configuration file ",(0,a.yg)("inlineCode",{parentName:"strong"},"application.yml")," of ",(0,a.yg)("inlineCode",{parentName:"strong"},"hertzbeat"))),(0,a.yg)("h3",{id:"configure-the-configuration-file-of-hertzbeat"},"Configure the configuration file of HertzBeat"),(0,a.yg)("p",null,"Modify the configuration file located at ",(0,a.yg)("inlineCode",{parentName:"p"},"hertzbeat/config/application.yml"),(0,a.yg)("br",{parentName:"p"}),"\n","Note \u26a0\ufe0fThe docker container method needs to mount the application.yml file to the local host",(0,a.yg)("br",{parentName:"p"}),"\n","The installation package can be decompressed and modified in ",(0,a.yg)("inlineCode",{parentName:"p"},"hertzbeat/config/application.yml")," "),(0,a.yg)("ol",null,(0,a.yg)("li",{parentName:"ol"},"Configure the SMS sending server")),(0,a.yg)("blockquote",null,(0,a.yg)("p",{parentName:"blockquote"},"Only when your own SMS server is successfully configured, the alarm SMS triggered in the monitoring tool will be sent normally.")),(0,a.yg)("p",null,"Add the following Tencent platform SMS server configuration in ",(0,a.yg)("inlineCode",{parentName:"p"},"application.yml")," (parameters need to be replaced with your SMS server configuration) "),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-yaml"},"common:\n sms:\n tencent:\n secret-id: AKIDbQ4VhdMr89wDedFrIcgU2PaaMvOuBCzY\n secret-key: PaXGl0ziY9UcWFjUyiFlCPMr77rLkJYlyA\n app-id: 1435441637\n sign-name: XX Technology\n template-id: 1343434\n")),(0,a.yg)("ol",{start:2},(0,a.yg)("li",{parentName:"ol"},"Configure alarm custom parameters")),(0,a.yg)("blockquote",null,(0,a.yg)("p",{parentName:"blockquote"},"If you receive frequent built-in availability alarms, or the network jitter is severe in your area, it is recommended to adjust the following parameters")),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-yaml"},"alerter:\n # Custom console address\n console-url: https://console.tancloud.cn\n # Alarm trigger evaluation interval basic time, the same repeated alarm will not be repeatedly triggered continuously within 2 times this time, unit milliseconds\n alert-eval-interval-base: 600000\n # The maximum time between alarm trigger evaluation intervals, the same repeated alarms can be suppressed at most during this time period, in milliseconds\n max-alert-eval-interval: 86400000\n # The built-in availability alarm will be triggered several times in a row before the actual alarm is sent. The default is 1 time. When the network environment is not good and you don't want to receive availability alarms frequently, you can increase this value (3)\n system-alert-trigger-times: 1\n")),(0,a.yg)("ol",{start:3},(0,a.yg)("li",{parentName:"ol"},"Use external redis instead of memory to store real-time metric data")),(0,a.yg)("blockquote",null,(0,a.yg)("p",{parentName:"blockquote"},"By default, the real-time data of our metrics is stored in memory, which can be configured as follows to use redis instead of memory storage.")),(0,a.yg)("p",null,"Note \u26a0\ufe0f ",(0,a.yg)("inlineCode",{parentName:"p"},"memory.enabled: false, redis.enabled: true")),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-yaml"},"warehouse:\n store:\n memory:\n enabled: false\n init-size: 1024\n redis:\n enabled: true\n host: 127.0.0.1\n port: 6379\n password: 123456\n")))}m.isMDXComponent=!0}}]);