search string side menu

BRIX On-Premises > BRIX On-Premises Enterprise > Install add-on components for BRIX / Install monitoring tools

Install monitoring tools

The installation of monitoring tools involves deploying Prometheus in the Kubernetes cluster for time-series storage and Grafana for visualization.

The installation consists of four steps:

  1. Clear CRDs before installation (optional).
  2. Download the Helm chart and the configuration file.
  3. Fill out the configuration file.
  4. Install the Monitoring chart using helm in the Kubernetes cluster.

Step 1: Clear CRDs before installation (optional)

Perform CRD cleanup if you have previously installed monitoring tools or are using an BRIX version below BRIX - v2023.6.19 or BRIX LTS - v2023.4.52.

To clear old CRDs, execute the following command:

kubectl delete crd alertmanagerconfigs.monitoring.coreos.com
kubectl delete crd alertmanagers.monitoring.coreos.com
kubectl delete crd podmonitors.monitoring.coreos.com
kubectl delete crd probes.monitoring.coreos.com
kubectl delete crd prometheusagents.monitoring.coreos.com
kubectl delete crd prometheuses.monitoring.coreos.com
kubectl delete crd prometheusrules.monitoring.coreos.com
kubectl delete crd scrapeconfigs.monitoring.coreos.com
kubectl delete crd servicemonitors.monitoring.coreos.com
kubectl delete crd thanosrulers.monitoring.coreos.com

Step 2: Download the Helm chart and the configuration file

For installation via the internet, obtain the configuration file values-monitoring.yaml by executing the command:

helm repo add elma365 https://charts.elma365.tech
helm repo update
helm show values elma365/monitoring> values-monitoring.yaml

Step 3: Fill out the configuration file

Fill out the configuration file values-monitoring.yaml for the installation of monitoring tools. For this, specify the desired namespace for the monitoring service in the parameters kube-prometheus-stack.namespaceOverride and grafana.namespaceOverride, for example, namespaceOverride: monitoring. The namespace will be created during the installation if it has not been created beforehand.

For Grafana:

  1. Ensure that the interface is enabled and kube-prometheus-stack.grafana.ingress.enabled is set to true.
  2. Specify the address at which Grafana will be accessible in the parameter kube-prometheus-stack.grafana.ingress.hosts.
  3. Set the administrator's password in the parameter kube-prometheus-stack.grafana.adminPassword.

Filling out the values-monitoring.yaml configuration file for monitoring installation

# -- monitoring settings
kube-prometheus-stack:
  # -- grafana settings
  grafana:
    assertNoLeakedSecrets: false
    # -- address at which grafana will be available
    ingress:
      enabled: true
      ingressClassName: nginx
      hosts:
        - grafana.mycompany.com
      # -- tls settings
      # tls:
      #   - secretName: "mycompany-cert"
      #     hosts:
      #       - grafana.mycompany.com
      annotations: {}
    # -- administrator's credentials
    adminUser: admin
    adminPassword: admin
    # -- list of used plugins
    plugins:
    - camptocamp-prometheus-alertmanager-datasource
    - flant-statusmap-panel
    - vonage-status-panel
    sidecar:
      dashboards:
        enabled: true
        label: "grafana_dashboard"
        labelValue: ""
        annotations:
        folderAnnotation: grafana-dashboard-folder
        provider:
          allowUiUpdates: true
          foldersFromFilesStructure: true
  # -- prometheus settings
  prometheus:
    prometheusSpec:
      replicas: 1
      serviceMonitorSelectorNilUsesHelmValues: false
      ## -- metrics retention period
      retention: 1d
      ## -- metric max size
      retentionSize: ""

Filling out parameters for connecting to the Mimir remote storage

kube-prometheus-stack:
  grafana:
    sidecar:
      # -- enable mimir as data source
      datasources:
        enabled: true
        defaultDatasourceEnabled: true
        isDefaultDatasource: true
        uid: prometheus
        url: http://mimir-nginx:80/prometheus
     
  prometheus:
    prometheusSpec:
      # -- enable mimir as long term storage
      remoteWrite:
      - url: http://mimir-nginx:80/api/v1/push

Step 4: Install the Monitoring chart using helm in the Kubernetes cluster

Install the Monitoring chart in the namespace specified in the configuration file values-monitoring.yaml in step 2. The namespace will be created during the installation if it has not been created beforehand.

To install via the internet, execute the command:

helm upgrade --install elma365-monitoring elma365/monitoring -f values-monitoring.yaml -n monitoring --create-namespace 

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

The installation of the monitoring tools add-on does not automatically enable monitoring and dashboards on the BRIX application side.

After installation, don't forget to change the BRIX application settings and set up monitoring on the application side.

Read more about enabling service monitoring on the BRIX application side in Enable monitoring in BRIX Enterprise.

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

Delete the Monitoring chart using helm in the Kubernetes cluster

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

Before removing the Monitoring add-on component, disable monitoring on the BRIX application side..

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

  1. To delete the elma365-monitoring chart in namespace monitoring, execute the command:

helm uninstall elma365-monitoring -n monitoring

  1. CRDs created by the elma365-monitoring chart are not removed by default and must be manually cleared by a user with cluster-admin rights:

kubectl delete crd alertmanagerconfigs.monitoring.coreos.com
kubectl delete crd alertmanagers.monitoring.coreos.com
kubectl delete crd podmonitors.monitoring.coreos.com
kubectl delete crd probes.monitoring.coreos.com
kubectl delete crd prometheusagents.monitoring.coreos.com
kubectl delete crd prometheuses.monitoring.coreos.com
kubectl delete crd prometheusrules.monitoring.coreos.com
kubectl delete crd scrapeconfigs.monitoring.coreos.com
kubectl delete crd servicemonitors.monitoring.coreos.com
kubectl delete crd thanosrulers.monitoring.coreos.com

  1. If the CRD remains in the Terminating status for more than 5 minutes during deletion, patch the CRD with the command:

kubectl patch crd/MY_CRD_NAME -p '{"metadata":{"finalizers":[]}}' --type=merge

install-audit-service.html monitoring-databases.html