244 lines
23 KiB
HTML
244 lines
23 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
|
||
<head>
|
||
<title>Enable monitoring parameters in BRIX Enterprise</title>
|
||
<meta name="generator" content="Help+Manual" />
|
||
<meta name="keywords" content="" />
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="description" content="The process of enabling monitoring for the BRIX application consists of three steps:" />
|
||
<meta name="picture" content="" />
|
||
<meta property="og:type" content="website" />
|
||
<meta property="og:title" content="Full documentation for BRIX365 platform. Low-code developer guide. User guide. Admin guide. Developer guide." />
|
||
<meta property="og:url" content="https://brix365.com/en/help" />
|
||
<meta property="og:image" content="" />
|
||
<link rel="icon" href="favicon.png" type="image/png" />
|
||
|
||
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet" />
|
||
<link rel="stylesheet" href="./jquery-ui.min.css" />
|
||
<link rel="stylesheet" href="default.css" />
|
||
<link rel="stylesheet" href="./search-yandex.css" />
|
||
<link rel="stylesheet" href="./article.css" />
|
||
<link rel="stylesheet" href="./glossary.css" />
|
||
<link rel="stylesheet" href="./theme.css" />
|
||
<script type="text/javascript" src="jquery.js"></script>
|
||
<script type="text/javascript" src="helpman_settings.js"></script>
|
||
<script type="text/javascript" src="helpman_topicinit.js"></script>
|
||
|
||
<script type="text/javascript" src="highlight.js"></script>
|
||
<script type="text/javascript">
|
||
$(document).ready(function(){highlight();});
|
||
</script>
|
||
</head>
|
||
|
||
<body>
|
||
|
||
<script>!function(e,t,c,n,r,a,m){e.ym=e.ym||function(){(e.ym.a=e.ym.a||[]).push(arguments)},e.ym.l=1*new Date;for(var s=0;s<document.scripts.length;s++)if(document.scripts[s].src===n)return;a=t.createElement(c),m=t.getElementsByTagName(c)[0],a.async=1,a.src=n,m.parentNode.insertBefore(a,m)}(window,document,"script","https://mc.yandex.ru/metrika/tag.js"),ym(83179930,"init",{clickmap:!0,trackLinks:!0,accurateTrackBounce:!0,webvisor:!0})</script><noscript><div><img alt=""src=https://mc.yandex.ru/watch/83179930 style=position:absolute;left:-9999px></div></noscript>
|
||
|
||
<header class="header elma-365">
|
||
<div class="container">
|
||
<a class="header__logo" href="https://brix365.com/en/help">
|
||
<img src="./logo-en.svg" alt="header logo">
|
||
</a>
|
||
<!-- <div class="hero__search-form" id="search-panel">
|
||
<form class="search-form" onsubmit="ym(83180416,'reachGoal','poisk')">
|
||
<label class="search-form__label">
|
||
<span id="reset-search" class="search__icon"></span>
|
||
<input class="search-form__input" type="text">
|
||
</label>
|
||
<input class="search-form__submit" type="submit" value="Submit">
|
||
</form>
|
||
</div> -->
|
||
|
||
<div class="hero__search-form" id="search-panel"> <form class="search-form"> <label class="search-form__label"> <span id="reset-search" class="search__icon"></span> <input class="search-form__input" type="text"> </label> <input class="search-form__submit" type="submit" value="Submit"> </form> </div>
|
||
<div class="hero__search">
|
||
<a href="#" id="search-icon" class="hero__search-icon">
|
||
<img src="search-icon-white.svg" alt="search string">
|
||
</a>
|
||
<a href="#" id="side-menu-icon" class="hero__side-icon">
|
||
<img src="side_menu.svg" alt="side menu">
|
||
</a>
|
||
</div>
|
||
<div class="header__navi">
|
||
|
||
<ul class="header__list"><li><span class="solution-select"><span class="solution-select__selected"></span><svg width="7" height="4" viewBox="0 0 7 4" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L3.5 3.5L6 1" stroke="white" stroke-linecap="round" stroke-linejoin="round"/></svg><ul class="solution-select__list"><li><a class="project-link" href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a class="project-link" href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a class="project-link" href="https://brix365.com/en/help/crm/crm_overview.html">CRM</a></li><li><a class="project-link" href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a class="project-link" href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li><li><a class="project-link" href="https://brix365.com/en/help/business_solutions/-elma365-store.html">Business Solutions</a></li></ul></span></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li><li><a href="https://tssdk.brix365.com/" target="_blank">SDK</a></li></ul>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</header>
|
||
|
||
|
||
|
||
|
||
<main class="main container">
|
||
|
||
<aside class="sidebar" id="sidebar">
|
||
<div class="sidebar__header">
|
||
<a class="header__logo" href="https://brix365.com/en/help">
|
||
<img src="./logo-light-en.svg">
|
||
</a>
|
||
<span class="sidebar__close elma-365-close" id="close"></span>
|
||
</div>
|
||
<div class="sidebar__wrapper" id="side-menu">
|
||
|
||
</div>
|
||
</aside>
|
||
|
||
<article class="article" id="article">
|
||
<div class="article-inner">
|
||
<div class="content">
|
||
<header class="article__header">
|
||
<div class="article__bread" style="display:flex; gap:10px;">
|
||
<span id="subcategory" class="search-res__item-category search-res__item-category_subcategory subcategory article__badge"></span>
|
||
|
||
<div class="topic__breadcrumbs">
|
||
<p><a href="elma365-on-premises.html">BRIX On-Premises</a> > <a href="elma365-enterprise.html">BRIX On-Premises Enterprise</a> > Administering BRIX Enterprise / Enable monitoring parameters in BRIX Enterprise</p>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Enable monitoring parameters in BRIX Enterprise</span></h1>
|
||
</div>
|
||
|
||
</header>
|
||
<section class="article__content">
|
||
<div class="scroll-top-inner">
|
||
<a href="#h1-article" class="scroll-top"></a>
|
||
</div>
|
||
<!-- Placeholder for topic body. -->
|
||
<p class="p_Normal">The process of enabling monitoring for the BRIX application consists of three steps:</p>
|
||
<ol style="list-style-type:decimal">
|
||
<li value="1" class="p_Normal"><a href="enable-monitoring-enterprise.html#installation-tools-monitoring" class="topiclink">Install monitoring tools</a>.</li><li value="2" class="p_Normal"><a href="enable-monitoring-enterprise.html#alteration-config-file" class="topiclink">Make changes to the configuration file values-elma365.yaml</a>.</li><li value="3" class="p_Normal"><a href="enable-monitoring-enterprise.html#applying-parameters-monitoring" class="topiclink">Apply monitoring parameters for BRIX Enterprise</a>.</li></ol>
|
||
<h2 class="p_Heading2"><a id="installation-tools-monitoring" class="hmanchor"></a><span class="f_Heading2">Step 1: Install monitoring tools</span></h2>
|
||
<p class="p_Normal">The installation of monitoring tools implies the deployment in the Kubernetes cluster of Prometheus for time series storage and Grafana for visualization. If you already have Prometheus and Grafana deployed, you can skip this step.</p>
|
||
<p class="p_Normal">You can install monitoring tools in your Kubernetes cluster. For more details, see <a href="install-monitoring-tools.html" class="topiclink">Install monitoring tools</a>.</p>
|
||
<h2 class="p_Heading2"><a id="alteration-config-file" class="hmanchor"></a><span class="f_Heading2">Step 2: Make changes to the configuration file values-elma365.yaml</span></h2>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">Начало внимание</span></p>
|
||
<p class="p_Normal">Before editing the <code><b>values-elma365.yaml</b></code> file, make a backup copy of it, as incorrect parameter settings may cause BRIX application malfunction.</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">Конец внимание</span></p>
|
||
<p class="p_Normal">Fill out the <code><b>values-elma365.yaml</b></code> configuration file to enable monitoring:</p>
|
||
<ol style="list-style-type:upper-roman">
|
||
<li value="1" class="p_Normal">To enable monitoring support, specify <code><b>true</b></code> in parameter <code><b>global.monitoring.enabled</b></code>.</li><li value="2" class="p_Normal">Enable the installation in the Kubernetes cluster of ServiceMonitor for BRIX application services by specifying <code><b>true</b></code> in the <code><b>global.monitoring.metrics.enabled</b></code> parameter.<br />
|
||
<br />
|
||
By default, only the basic metrics of BRIX services are given. Providing all metrics is disabled to prevent the monitoring system from being overwhelmed by too many metrics. To enable the provision of a significantly larger number of metrics by the BRIX application services, specify <code><b>true</b></code> in the <code><b>global.monitoring.metrics.all</b></code> parameter.<br />
|
||
<br />
|
||
Within the scope of this article, enabling the provision of all metrics is not required.</li></ol>
|
||
<p class="p_Normal"><a class="dropdown-toggle" style="font-style: normal; font-weight: normal; color: #000000; background-color: transparent; text-decoration: none;" href="javascript:HMToggle('toggle','TOGGLE0186A1')">Additional parameters for ServiceMonitor</a></p>
|
||
<div id="TOGGLE0186A1" class="dropdown-toggle-body" style="text-align: left; text-indent: 0; line-height: 1.80; padding: 0 0 0 0; margin: 0 0 0 0;"><table style="border:none; border-spacing:0;">
|
||
<tr>
|
||
<td style="vertical-align:top; padding:0; border:none"><p class="p_Normal"> <br />
|
||
By default, all ServiceMonitors are used for monitoring. You can exclude data collection from certain ServiceMonitors or configure data redirection to different Prometheus instances using labels. To do this, use the parameters: </p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><code><b>labels</b></code>. It adds or overwrites labels for ServiceMonitor.</li><li class="p_Normal"><code><b>relabelings</b></code>. Applied before scanning targets to their labels in order to:<ul style="list-style-type:circle">
|
||
<li class="p_Normal">Filter targets, e.g. to keep only those that have a certain label.</li><li class="p_Normal">Edit target labels, for example, to add, remove or modify <code><b>__meta_*</b></code> labels obtained from the Service Discovery tool.</li><li class="p_Normal">Dynamically define scrape parameters, such as path or port.</li></ul>
|
||
<li class="p_Normal"><code><b>metricRelabelings</b></code>. Applied to metric labels after they have been collected, but before they are saved in Prometheus, in order to:<ul style="list-style-type:circle">
|
||
<li class="p_Normal">Remove unnecessary metrics.</li><li class="p_Normal">Modify the labels of collected metrics, e.g., for aggregation or simplification.</li><li class="p_Normal">Filter sensitive data.</li></ul></li></ul>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<ol style="list-style-type:upper-roman">
|
||
<li value="3" class="p_Normal">If the Kubernetes cluster is deployed on the Deckhouse platform, set the <code><b>deckhouse</b></code> value in the <code><b>global.monitoring.provisioner</b></code> parameter. This will configure the supplied monitoring tools for the target platform.</li><li value="4" class="p_Normal">To install Dashboards (ConfigMap) in the Kubernetes cluster for BRIX application services, specify <code><b>true</b></code> in the <code><b>global.monitoring.dashboard.enabled</b></code> parameter.</li><li value="5" class="p_Normal">If the installation of alerts is needed, set <code><b>true</b></code> for <code><b>global.monitoring.alerts.enabled</b></code>. This will start the installation of PrometheusRule (CRD) in the Kubernetes cluster for BRIX application services.</li><li value="6" class="p_Normal">To enable <a href="export-monitoring-enterprise.html" class="topiclink">export of system performance metrics</a> to the Prometheus storage for data visualization using Grafana, set <code><b>true</b></code> for <code><b>global.monitoring.lowcode.metricExportEnabled</b></code>.</li></ol>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">global:</span><br />
|
||
<span class="f_CodeExample"> ...</span><br />
|
||
<span class="f_CodeExample"> monitoring:</span><br />
|
||
<span class="f_CodeExample"> enabled: </span><span class="f_CodeExample" style="font-weight: bold;">true</span><br />
|
||
<span class="f_CodeExample"> metrics:</span><br />
|
||
<span class="f_CodeExample"> enabled: </span><span class="f_CodeExample" style="font-weight: bold;">true</span><br />
|
||
<span class="f_CodeExample"> all: </span><span class="f_CodeExample" style="font-weight: bold;">false</span><br />
|
||
<span class="f_CodeExample"> provisioner: "k8s"</span><br />
|
||
<span class="f_CodeExample"> dashboard:</span><br />
|
||
<span class="f_CodeExample"> enabled: </span><span class="f_CodeExample" style="font-weight: bold;">true</span><br />
|
||
<span class="f_CodeExample"> alerts:</span><br />
|
||
<span class="f_CodeExample"> enabled: </span><span class="f_CodeExample" style="font-weight: bold;">false</span><br />
|
||
<span class="f_CodeExample">...</span></p>
|
||
<h2 class="p_Heading2"><a id="applying-parameters-monitoring" class="hmanchor"></a><span class="f_Heading2">Step 3: Apply monitoring parameters for BRIX Enterprise</span></h2>
|
||
<p class="p_Normal">You can update monitoring parameters for BRIX Enterprise in two ways: online and <a href="enable-monitoring-enterprise.html#offline-update" class="topiclink">offline</a>.</p>
|
||
<h3 class="p_Heading3"><span class="f_Heading3">Update parameters online</span></h3>
|
||
<ol style="list-style-type:upper-roman">
|
||
<li value="1" class="p_Normal">Determine the version of the chart with which the BRIX application was installed or updated:</li></ol>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">helm show chart elma365/elma365</span></p>
|
||
<p class="p_Normal">Example of command execution:</p>
|
||
<p class="p_Normal"><img alt="enable-monitoring-enterprise-1" title="enable-monitoring-enterprise-1" width="417" height="141" style="margin:0;width:417px;height:141px;border:none" src="enable-monitoring-enterprise-1.png"/></p>
|
||
<p class="p_Normal">After the command execution, you see the chart version information in the <code><b>version</b></code> string. Save this value for the next step.</p>
|
||
<ol style="list-style-type:upper-roman" start="2">
|
||
<li value="2" class="p_Normal">Update the parameters using the <code><b>values-elma365.yaml</b></code> configuration file. To do this, execute the following command specifying the installed chart version for the <code><b>--version</b></code> flag instead of <code><b><elma365-chart-version></b></code>:</li></ol>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">helm upgrade --install elma365 elma365/elma365 -f values-elma365.yaml --version <elma365-chart-version> --timeout=30m --wait [-n </span><span class="f_CodeExample" style="font-weight: bold;">namespace</span><span class="f_CodeExample">]</span></p>
|
||
<h3 class="p_Heading3"><a id="offline-update" class="hmanchor"></a><span class="f_Heading3">Update parameters offline</span></h3>
|
||
<p class="p_Normal">Go to directory with downloaded BRIX chart and run the following command:</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">helm upgrade --install elma365 ./elma365 -f values-elma365.yaml --timeout=30m --wait [-n </span><span class="f_CodeExample" style="font-weight: bold;">namespace</span><span class="f_CodeExample">]</span></p>
|
||
<p class="p_Normal">It takes about 10-30 minutes to update the parameters. Wait for it to complete.</p>
|
||
|
||
<div class="bottom-nav">
|
||
|
||
<a id="prev-link" class="topic__navi_prev" href="autoscaling-service-enterprise.html">
|
||
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
|
||
class="bottom-nav__link">autoscaling-service-enterprise.html</span>
|
||
</a>
|
||
|
||
|
||
<a id="next-link" class="topic__navi_next" href="enterprise-troubleshooting.html">
|
||
<span class="bottom-nav__link">enterprise-troubleshooting.html</span> <span
|
||
class="bottom-nav__arrow bottom-nav__arrow--next"></span>
|
||
</a>
|
||
|
||
</div>
|
||
<!-- добавляет на страницу строку блок Была ли статья полезной? -->
|
||
<div class="feedback" id="feedback"><div class="feedback-help"><span><b>Was this helpful?</b></span><form action="" method="POST" class="feedback-form" id="feedback-form"><div class="feedback__popup feedback__popup-response" id="feedback__popup_thx" style="display: none;">Thanks for your feedback!</div><div class="feedback__popup" id="feedback__popup_why" style="display: none;"><div class="feedback__popup-header">Please specify why:</div><input type="radio" name="category" id="bad_recommendation" value="bad_recommendation"><label for="bad_recommendation">Recommendations did not help me</label><input type="radio" name="category" id="difficult_text" value="difficult_text"><label for="difficult_text">Article is hard to understand</label><input type="radio" name="category" id="no_answer" value="no_answer"><label for="no_answer">Didn`t answer my question</label><input type="radio" name="category" id="bad_header" value="bad_header"><label for="bad_header">Content does not match the topic</label><input type="radio" name="category" id="other_reason" value="other_reason"><label for="other_reason">Other</label></div><div class="feedback__popup" id="feedback__popup-other" style="display: none;"><div class="feedback__popup-header">How we can improve it?</div><textarea class="feedback__textarea" name="other" id=""></textarea><input type="submit" class="feedback__other-btn" value="Submit"></div><div class="feedback-form__btn-group"><input type="radio" name="useful" id="feedback__useful_yes" value="true"><label for="feedback__useful_yes"><img src="like.svg" class="small-img" alt="like"><spanclass="feedback-form__btn-group_yes-btn">Yes</spanclass="feedback-form__btn-group_yes-btn"></label><input type="radio" name="useful" id="feedback__useful_no" value="false"><label for="feedback__useful_no"><img src="dislike.svg" class="small-img" alt="dislike"><spanclass="feedback-form__btn-group_no-btn">No</spanclass="feedback-form__btn-group_no-btn"></label></div><select name="category"><option disabled="">Please specify why</option><option value="bad_recommendation" selected="">Recommendations did not help me</option><option value="difficult_text">Article is hard to understand</option><option value="no_answer">Didn`t answer my question</option><option value="bad_header">Content does not match the topic</option><option value="other_reason">Other</option></select><input type="submit"></form></div><div class="found_typo"><p style="margin: 0px; margin-top: 16px !important;"><span><b>Found a typo?</b></span> Select it and press <i>Ctrl+Enter</i> to send us feedback</p></div></div>
|
||
|
||
</section>
|
||
</div>
|
||
<aside class="article__sidebar" style="display:none">
|
||
<input type="checkbox" />
|
||
<div class="article__arrow"></div>
|
||
<div class="table-of-contents elma365-right" id="toc2Content">
|
||
<h3 class="h3-toc">In this topic</h3>
|
||
<nav id="toc2"></nav>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</article>
|
||
</main>
|
||
<footer class="footer">
|
||
<div class="footer-container">
|
||
<div class="footer-mobile">
|
||
|
||
<ul class="footer-mobile__list"><li><a href="https://brix365.com/en/" target="_blank">BRIX</a></li><li><a href="https://tssdk.brix365.com/en/latest/" target="_blank">SDK</a></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li></ul><ul class="footer-mobile__list"><li><a href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li></ul>
|
||
|
||
|
||
</div>
|
||
<div class="footer-wrap">
|
||
|
||
<div><span class="mobile-question-popup">Send feedback</span><form method="POST" action class="question__popup question-xs" id="question__popup"><div class="question-wrap"><span class="close"></span><span class="title">Ask a question</span><label for="help_question" style="display: none;"></label><textarea name="help_question" id="help_question"></textarea><input type="submit" value="Send"></div></form><div class="hidden fade-in question-success-xs">Sent</div></div>
|
||
|
||
<div class="footer-flex-b">
|
||
<span class="footer-copy">© 2025 BRIX</span>
|
||
<ul class="footer-list">
|
||
|
||
<li class="footer-item">
|
||
<a href="#" class="arrow-top" style="display: block;"></a>
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</footer>
|
||
<iframe name="hmnavigation" style="display:none!important"></iframe>
|
||
<script src="./jquery-ui.js"></script>
|
||
<!--script src="//cdn.jsdelivr.net/npm/featherlight@1.7.14/release/featherlight.min.js" type="text/javascript" charset="utf-8"></script-->
|
||
<script src="./jquery.tocify.min.js"></script>
|
||
<script src="./TypoReporter.min.js"></script>
|
||
<script src="./google-search.js"></script>
|
||
<script src="./main.js"></script>
|
||
<script type="text/javascript">
|
||
HMInitToggle('TOGGLE0186A1','hm.type','dropdown','hm.state','0');
|
||
</script>
|
||
</body>
|
||
|
||
</html>
|