search string side menu

BRIX On-Premises > BRIX On-Premises Enterprise > Administering BRIX Enterprise / Enable monitoring parameters in BRIX Enterprise

Enable monitoring parameters in BRIX Enterprise

The process of enabling monitoring for the BRIX application consists of three steps:

  1. Install monitoring tools.
  2. Make changes to the configuration file values-elma365.yaml.
  3. Apply monitoring parameters for BRIX Enterprise.

Step 1: Install monitoring tools

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.

You can install monitoring tools in your Kubernetes cluster. For more details, see Install monitoring tools.

Step 2: Make changes to the configuration file values-elma365.yaml

Начало внимание

Before editing the values-elma365.yaml file, make a backup copy of it, as incorrect parameter settings may cause BRIX application malfunction.

Конец внимание

Fill out the values-elma365.yaml configuration file to enable monitoring:

  1. To enable monitoring support, specify true in parameter global.monitoring.enabled.
  2. Enable the installation in the Kubernetes cluster of ServiceMonitor for BRIX application services by specifying true in the global.monitoring.metrics.enabled parameter.
     
    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 true in the global.monitoring.metrics.all parameter.
     
    Within the scope of this article, enabling the provision of all metrics is not required.

Additional parameters for ServiceMonitor

 
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:

  • labels. It adds or overwrites labels for ServiceMonitor.
  • relabelings. Applied before scanning targets to their labels in order to:
    • Filter targets, e.g. to keep only those that have a certain label.
    • Edit target labels, for example, to add, remove or modify __meta_* labels obtained from the Service Discovery tool.
    • Dynamically define scrape parameters, such as path or port.
  • metricRelabelings. Applied to metric labels after they have been collected, but before they are saved in Prometheus, in order to:
    • Remove unnecessary metrics.
    • Modify the labels of collected metrics, e.g., for aggregation or simplification.
    • Filter sensitive data.
  1. If the Kubernetes cluster is deployed on the Deckhouse platform, set the deckhouse value in the global.monitoring.provisioner parameter. This will configure the supplied monitoring tools for the target platform.
  2. To install Dashboards (ConfigMap) in the Kubernetes cluster for BRIX application services, specify true in the global.monitoring.dashboard.enabled parameter.
  3. If the installation of alerts is needed, set true for global.monitoring.alerts.enabled. This will start the installation of PrometheusRule (CRD) in the Kubernetes cluster for BRIX application services.
  4. To enable export of system performance metrics to the Prometheus storage for data visualization using Grafana, set true for global.monitoring.lowcode.metricExportEnabled.

global:
  ...
  monitoring:
    enabled: true
    metrics:
      enabled: true
      all: false
    provisioner: "k8s"
    dashboard:
      enabled: true
    alerts:
      enabled: false
...

Step 3: Apply monitoring parameters for BRIX Enterprise

You can update monitoring parameters for BRIX Enterprise in two ways: online and offline.

Update parameters online

  1. Determine the version of the chart with which the BRIX application was installed or updated:

helm show chart elma365/elma365

Example of command execution:

enable-monitoring-enterprise-1

After the command execution, you see the chart version information in the version string. Save this value for the next step.

  1. Update the parameters using the values-elma365.yaml configuration file. To do this, execute the following command specifying the installed chart version for the --version flag instead of <elma365-chart-version>:

helm upgrade --install elma365 elma365/elma365 -f values-elma365.yaml --version <elma365-chart-version> --timeout=30m --wait [-n namespace]

Update parameters offline

Go to directory with downloaded BRIX chart and run the following command:

helm upgrade --install elma365 ./elma365 -f values-elma365.yaml --timeout=30m --wait [-n namespace]

It takes about 10-30 minutes to update the parameters. Wait for it to complete.

autoscaling-service-enterprise.html enterprise-troubleshooting.html