Files
help365/platform/enterprise-troubleshooting.html
koziavin 00717a92fb
All checks were successful
Deploy Static Site / deploy (push) Successful in 6m6s
update
2025-05-29 16:42:45 +04:00

232 lines
22 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<title>Diagnostics and troubleshooting 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="Diagnostics can be used to determine the current state of the system, eliminate existing errors, and optimize performance." />
<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> &gt; <a href="elma365-enterprise.html">BRIX On-Premises Enterprise</a> &gt; Administering BRIX Enterprise / Diagnostics and troubleshooting in BRIX Enterprise</p>
</div>
</div>
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Diagnostics and troubleshooting 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">Diagnostics can be used to determine the current state of the system, eliminate existing errors, and optimize performance.</p>
<p class="p_Normal">The diagnostic and troubleshooting process consists of three steps:</p>
<ol style="list-style-type:decimal">
<li value="1" style="line-height: 1.28; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><a href="enterprise-troubleshooting.html#collect-diagnostic-info" class="topiclink">Collecting diagnostic information</a>.</li><li value="2" style="line-height: 1.28; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><a href="enterprise-troubleshooting.html#apply-new-parameters-enterprise" class="topiclink">Applying new parameters for BRIX Enterprise</a>.</li><li value="3" style="line-height: 1.28; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><a href="enterprise-troubleshooting.html#generate-logs-check-status" class="topiclink">Generating logs and checking the status of services</a>.</li></ol>
<p class="p_Normal">Please note that during the diagnostic and troubleshooting process, changes are made to the existing configuration file <code><b>values-elma365.yaml</b></code>, which is received and filled in when BRIX Enterprise is installed. Unintentional changes to parameters in this file may result in the loss of BRIX application functionality.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;внимание</span></p>
<p class="p_Normal">Before making changes to the <code><b>values-elma365.yaml</b></code> file, it is recommended to create its backup copy.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;внимание</span></p>
<p class="p_Normal">If the <code><b>values-elma365.yaml</b></code> file has been lost, retrieve the parameters of the current BRIX installation and save them to this file. To do this, execute the following command:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">helm&nbsp;get&nbsp;values&nbsp;elma365&nbsp;[-n&nbsp;</span><span class="f_CodeExample" style="font-weight: bold;">namespace</span><span class="f_CodeExample">]&nbsp;&gt;&nbsp;values-elma365.yaml</span></p>
<h2 class="p_Heading2"><a id="collect-diagnostic-info" class="hmanchor"></a><span class="f_Heading2">Step 1: Collecting diagnostic information</span></h2>
<p style="line-height: 1.28; margin: 0 0 11px 0;">To collect system state data, enable debugging of the platform. To do this, set the<span style="font-family: Calibri,Vectora,'Droid Sans','Open Sans',Frutiger,sans-serif;"> </span><code><b>debug</b></code><span style="font-family: Calibri,Vectora,'Droid Sans','Open Sans',Frutiger,sans-serif;"> </span>parameter to<span style="font-family: Calibri,Vectora,'Droid Sans','Open Sans',Frutiger,sans-serif;"> </span><code><b>true</b></code>:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">debug:&nbsp;</span><span class="f_CodeExample" style="font-weight: bold;">true</span></p>
<h2 class="p_Heading2"><a id="apply-new-parameters-enterprise" class="hmanchor"></a><span class="f_Heading2">Step 2: Applying new parameters for BRIX Enterprise</span></h2>
<p class="p_Normal">You can update BRIX application settings in two ways: <a href="enterprise-troubleshooting.html#update-via-internet" class="topiclink">online</a> or <a href="enterprise-troubleshooting.html#update-offline" class="topiclink">offline</a>.</p>
<h3 class="p_Heading3"><a id="update-via-internet" class="hmanchor"></a><span class="f_Heading3">Update parameters online</span></h3>
<ol style="list-style-type:upper-roman">
<li value="1" style="line-height: 1.28; margin-top: 0; margin-right: 0; margin-bottom: 11px;">Determine the chart version where the BRIX application was installed or updated:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid; margin: 0 0 0 34px;"><span class="f_CodeExample">helm&nbsp;show&nbsp;chart&nbsp;elma365/elma365</span></p>
<p class="p_Normal" style="margin: 0 0 0 34px;">Command execution example:</p>
<p style="line-height: 1.28; margin: 0 0 11px 34px;"><img alt="change-settings-enterprise-1" width="1126" height="83" style="margin:0;width:1126px;height:83px;border:none" src="change-settings-enterprise-1.png"/></p>
<p class="p_Normal" style="margin: 0 0 0 34px;">The command will result in the chart version information being specified in the <code><b>version</b></code> file. Save this value for the next step.</p>
<ol style="list-style-type:upper-roman" start="2">
<li value="2" class="p_Normal" style="margin-top: 0; margin-right: 0; margin-bottom: 0;">Update the BRIX parameters. To do this, execute the following command specifying the installed chart version for the <code><b>--version</b></code> flag instead of <code><b>&lt;elma365-chart-version&gt;</b></code>:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid; margin: 0 0 0 34px;"><span class="f_CodeExample">helm&nbsp;upgrade&nbsp;--install&nbsp;elma365&nbsp;elma365/elma365&nbsp;-f&nbsp;values-elma365.yaml&nbsp;--version&nbsp;&lt;elma365-chart-version&gt;&nbsp;--timeout=30m&nbsp;--wait&nbsp;[-n&nbsp;</span><span class="f_CodeExample" style="font-weight: bold;">namespace</span><span class="f_CodeExample">]</span></p>
<h3 class="p_Heading3"><a id="update-offline" class="hmanchor"></a><span class="f_Heading3">Update parameters offline</span></h3>
<p class="p_Normal">Go to the chart directory where the BRIX application was installed or updated and execute the following command:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">helm&nbsp;upgrade&nbsp;--install&nbsp;elma365&nbsp;./elma365&nbsp;-f&nbsp;values-elma365.yaml&nbsp;--timeout=30m&nbsp;--wait&nbsp;[-n&nbsp;</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>
<h2 class="p_Heading2"><a id="generate-logs-check-status" class="hmanchor"></a><span class="f_Heading2">Step 3: Generating logs and checking the status of services</span></h2>
<h3 class="p_Heading3"><span class="f_Heading3">Obtain logs</span></h3>
<ul style="list-style-type:disc">
<li class="p_Normal">If you need to gather logs from all application services, execute the following command:</li></ul>
<p class="p_CodeExample" style="page-break-inside: avoid; margin: 0 0 0 34px;"><span class="f_CodeExample">kubectl&nbsp;logs&nbsp;-l&nbsp;tier=elma365&nbsp;--all-containers&nbsp;[-n&nbsp;</span><span class="f_CodeExample" style="font-weight: bold;">namespace</span><span class="f_CodeExample">]&nbsp;&gt;&nbsp;logs.txt</span></p>
<ul style="list-style-type:disc">
<li class="p_Normal">To view logs of a separate service, specify the required service instead of <code><b>[name]</b></code>:</li></ul>
<p class="p_CodeExample" style="page-break-inside: avoid; margin: 0 0 0 34px;"><span class="f_CodeExample">kubectl&nbsp;logs&nbsp;-l&nbsp;app=[name]&nbsp;[-n&nbsp;</span><span class="f_CodeExample" style="font-weight: bold;">namespace</span><span class="f_CodeExample">]</span></p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;примера</span></p>
<p class="p_Normal">Example:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">kubectl&nbsp;logs&nbsp;-l&nbsp;app=main&nbsp;-n&nbsp;brix</span></p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;примера</span></p>
<h3 class="p_Heading3"><span class="f_Heading3">View logs in real time</span></h3>
<p class="p_Normal">To monitor logs in real time, add the <code><b>-f</b></code> option:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">kubectl&nbsp;logs&nbsp;-l&nbsp;app=[name]&nbsp;-f&nbsp;[-n&nbsp;</span><span class="f_CodeExample" style="font-weight: bold;">namespace</span><span class="f_CodeExample">]</span></p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;примера</span></p>
<p class="p_Normal">Example:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">kubectl&nbsp;logs&nbsp;-l&nbsp;app=main&nbsp;-f&nbsp;-n&nbsp;brix</span></p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;примера</span></p>
<h3 class="p_Heading3"><span class="f_Heading3">Check the status of services</span></h3>
<p class="p_Normal">To make sure that all services are working correctly, execute the following command:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">kubectl&nbsp;get&nbsp;pod&nbsp;[-n&nbsp;</span><span class="f_CodeExample" style="font-weight: bold;">namespace</span><span class="f_CodeExample">]</span></p>
<p class="p_Normal">The result will be generated as a table with the list of services. Services need to be in the <code><b>Running</b></code> status, while tasks need to be in the <code><b>Completed</b></code> status.</p>
<p class="p_Normal">For more detailed analysis, it is recommended to install the necessary <a href="install-monitoring-tools.html" class="topiclink">monitoring</a>, <a href="install-loki.html" class="topiclink">logging</a> and <a href="install-tempo.html" class="topiclink">trace analysis</a> tools.</p>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="enable-monitoring-enterprise.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">enable-monitoring-enterprise.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="grafana-alert-notification-settings.html">
<span class="bottom-nav__link">grafana-alert-notification-settings.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">&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>
</body>
</html>