Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Typo and minor clarification.

bIt It is possible to profile the rendering process of Multisite pages. This is done using the Python module cProfile. For viewing the profiling data, we use snakeviz.

...

  1. GUI Profiling

    1. Enable profiling in Checkmk

      Info

      SETUP→ General → Global Settings → USER INTERFACE

      Don't use 'Enable profiling for all request'. This option will profile a Multisite request randomly and at the most of the time it will be the slowest one.



    2. Install the Python module (for Python 2 or Python 3 respectively)

      Code Block
      languagebash
      root@cmk-VirtualBox:~# pip install snakeviz
      root@cmk-VirtualBox:~# pip3 install snakeviz


    3. Modify the URL to profile by adding '&_profile=1'

      Code Block
      languagebash
      http://localhost/nagnis_master/check_mk/view.py?view_name=allhosts&_profile=1


    4. Now two files are created in ~/var/check_mk/

      Code Block
      root@klappanas:/opt/omd/sites/nagnis_master/var/check_mk# ll |grep multisite
      -rw-rw---- 1 nagnis_master nagnis_master 100246 Nov 6 13:35 multisite.profile
      -rwxr-xr-x 1 nagnis_master nagnis_master 155 Nov 6 13:35 multisite.profile.py*


      1. By executing 'multisite.profile.py'  you can get runtime statistics about the last processed page

        Code Block
        root@klappanas:/opt/omd/sites/nagnis_master/var/check_mk# ./multisite.profile.py |more
        Fri Nov  6 13:35:33 2020    /omd/sites/nagnis_master/var/check_mk/multisite.profile
        
                 9585 function calls (9480 primitive calls) in 0.007 seconds
        
           Ordered by: internal time
        
           ncalls  tottime  percall  cumtime  percall filename:lineno(function)
                1    0.001    0.001    0.002    0.002 /omd/sites/nagnis_master/lib/python/cmk/gui/modules.py:140(_cmk_gui_top_level_modules)
             4652    0.000    0.000    0.000    0.000 {method 'startswith' of 'str' objects}
        ...
        ...
        ...
        ...


      2. For viewing multisite.profile with snakeviz, move the file to another directory (e.g. /tmp) and change the owner to the owner of your Internet Browser

        Code Block
        languagebash
        anastasios@klappanas:/omd/sites/nagnis_master/var/check_mk$ sudo cp multisite.profile /tmp/
        anastasios@klappanas:/tmp$ sudo chown anastasios:anastasios multisite.profile
        


    5. Now you can use snakeviz for viewing the profiling file

      Info


      Code Block
      anastasios@klappanas:/tmp$ snakeviz multisite.profile


    6. Now you can analyze at which point of the request your view needs the most time!

  2. Profiling via cli

    1. The cmk commands have an option to profile them

      Code Block
      OMD[at]:~$ cmk |grep profile
         --profile           Enable profiling mode


    2. The profile file will be created in the current directory. Let's go to tmp and run the cmk command with the profile option

      Code Block
      ➜  ~ su - at                                        
      OMD[at]:~$ cd tmp
      OMD[at]:~$ cmk -Afv --profile


      1. Now we will see two files:

        Code Block
        OMD[at]:~/tmp$ ls |grep profile
        profile.out*
        show_profile.py*


      2. To work with these files we need to copy them outside the site

        Code Block
        OMD[at]:~/tmp$ cp show_profile.py profile.out /tmp/


      3. Now there are two ways to analyze these files:
        1. Open the profile file via the commandline:

          Code Block
          ➜  /tmp ./show_profile.py 


        2. Analyze via snakevize like described here: Checkmk profiling
  3. Profile a checkmk function

    Warning

    Please note that we do not support any changes of our code. If you do this, please keep a backup of the file!

    There is an option to profile a function inside checkmk. This can be either your own code e.g. plugin or a checkmk specific code:

    Code Block
    from cmk.utils.profile import profile_call
    .....
    
    @profile_call("/tmp/myprofile_dir")
    def my_func_to_profile(self):
        print("ding dong")


  4. Network Analyze with the internet browser

    1. Start the Network Monitor

      Info

      Ctrl + Shift + I

      or

      For Firefox follow this manual: https://developer.mozilla.org/en-US/docs/Tools/Network_Monitor
      For Google Chrome follow this manual: https://developer.chrome.com/docs/devtools/network/


    2. Now reload the slow/ crashing view again and save/export this file as .har. Please submit this file to us

...