Space banner

   

This documentation supports an earlier version of BMC Helix IT Operations Management on-premises deployment.

To view the documentation for the latest version, select 22.4 from the Product version picker.

Preparing for BMC Helix logging

You can deploy BMC Helix Platform Logging to collect logs. BMC Helix Platform Logging uses ElasticSearch, Fluentd, and Kibana (EFK).

Fluentd needs the following privileges:

  • Kubernetes cluster
    • PodSecurityPolicy - The installer creates the PodSecurityPolicy administrator with the host path enabled and the root runAsUser and runAsGroup settings as shown in the psp_fluentd.yaml file.
    • ClusterRole and ClusterRoleBinding - The installer creates the ClusterRole and ClusterRoleBinding objects with the rules that are mentioned in the clusterole_rolebinding_fluentd.yaml file.
  • OpenShift cluster
    • Role and RoleBinding - The installer creates a role with the security context content as privileged and the rolebinding object with the rules that are mentioned in the fluentd_role.yaml file. 

The ElasticSearch and Kibana services use the following ports:

ServicePortsCommand to obtain details
ElasticSearch 9200, 9300
kuebctl -n bmc-helix-logging get svc | grep elastic


Kibana5601
kuebctl -n bmc-helix-logging get svc | grep kibana
Kibana uses the external IP of the master node.

Perform the following tasks before deploying BMC Helix IT Operations Management:

  • In the helix-on-prem-deployment-manager-<release_version>/configs/deployment.config file, change the value of the BMC_HELIX_LOGGING parameter to yes as shown below:
    BMC_HELIX_LOGGING=yes

    Important

    If the value of the BMC_HELIX_LOGGING parameter is no, the BMC Helix IT Operations Management supportability is limited, and the root cause analysis of an issue may not be possible.

  • EFK collects logs from all namespaces in the cluster. If you are using separate namespaces for other applications in your cluster, the log file size increases. In the files shown in the following table, edit the default values of the ESLOG_MASTER_STORAGE_SIZE and ESLOG_DATA_STORAGE_SIZE parameters according to your deployment size:

    File nameESLOG_MASTER_STORAGE_SIZE and ESLOG_DATA_STORAGE_SIZE parameters
    compact.config

    ESLOG_MASTER_STORAGE_SIZE=100Gi

    ESLOG_DATA_STORAGE_SIZE=100Gi

    small.config

    ESLOG_MASTER_STORAGE_SIZE=100Gi

    ESLOG_DATA_STORAGE_SIZE=100Gi

    medium.config

    ESLOG_MASTER_STORAGE_SIZE=100Gi

    ESLOG_DATA_STORAGE_SIZE=100Gi

    large.config

    ESLOG_MASTER_STORAGE_SIZE=1Ti

    ESLOG_DATA_STORAGE_SIZE=1Ti

    For example, in the internal PSR, 180 GB of space was consumed in 24 hours for a single namespace. You can change these values based on the namespaces and applications in the cluster.

  • Log retention is set to 90 days by default. You can configure the retention period. In the configs/bmc-helix-logging.config file, set the value in days for the ESLOG_RETINTION_PERIOD parameter.
    For example, to set the log retention for 30 days, set the ESLOG_RETINTION_PERIOD parameter as shown below:
    ESLOG_RETINTION_PERIOD=30

    Note

    Log retention is enabled by default. If you wan tot disable it, perform the following steps:

    1. Open the configs/bmc-helix-logging.config file.
    2. Mark the log retention feature as false.




Was this page helpful? Yes No Submitting... Thank you

Comments

  1. Mayur Jejurkar

    Command to get ElasticSearch and Kibana services are incorrect, it should be as below,

    kubectl -n bmc-helix-logging get svc | grep elastic

    kubectl -n bmc-helix-logging get svc | grep kibana

    Apr 18, 2023 05:34
    1. Ashwini Sawanth

      Hi Mayur,

      Thanks for sharing your feedback. I shall check and then update the document.


      Regards,

      Ashwini Sawanth

      Apr 24, 2023 04:58
    1. Ashwini Sawanth

      Hi Mayur, 

      We have updated the document.


      Thanks and regards, 

      Ashwini Sawanth

      Apr 24, 2023 06:38