...
Status | ||||
---|---|---|---|---|
| ||||
Table of Contents | exclude | Step-by-step guide
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Step-by-step guide
GUI Profiling
Warning |
---|
Don't use 'Enable profiling for all requests'. This option will profile a Multisite request randomly, and most of the time, it will be the slowest one. |
...
Enable profiling in Checkmk
- Setup → General → Global Settings → User Interface → Profile Request
. Modify the URL to profile by adding '&_profile=1' and fire submit the request in your browser.
Code Block language bash theme RDark http://localhost/nagnis_master/check_mk/view.py?view_name=allhosts&_profile=1
.
Now two files are created in ~{{$OMD_ROOT/var/check_mk/}}.
Code Block theme RDark root@mylinuxhost:/opt/omd/sites/mysite/var/check_mk# ll |grep multisite -rw-rw---- 1 mysite mysite 100246 Nov 6 13:35 multisite.profile -rwxr-xr-x 1 mysite mysite 155 Nov 6 13:35 multisite.py*
.
By executing 'multisite.py', you can get runtime statistics about the last processed page.
Code Block language bash theme RDark root@mylinuxhost:/opt/omd/sites/mysite/var/check_mk# ./multisite.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/mysite/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} ... ...
.
For viewing
multisite.
Profileprofile
with snakeviz, move the file to another directory (e.g., /tmp), and change the owner to the owner of your Internet Browser.Code Block language bash theme RDark linuxuser@mylinuxhost:/omd/sites/mysite/var/check_mk$ sudo cp multisite.profile /tmp/ linuxuser@mylinuxhost:/tmp$ sudo chown linuxuser:linuxuser multisite.profile
.
Install the Python module (for Python 2 or Python 3, respectively).
Code Block language bash theme RDark root@mylinuxhost:~# pip install snakeviz root@mylinuxhost:~# pip3 install snakeviz
.
Now you can use snakeviz to view the profiling file.
Code Block language bash theme RDark linuxuser@mylinuxhost:/tmp$ snakeviz multisite.profile
.
...
Now you can analyze at which point of the request your view needs the most time!.
Profiling via cli
The cmk commands have the option to profile them.
Code Block language bash theme RDark OMD[mysite]:~$ cmk |grep profile --profile Enable profiling mode
.
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 language bash theme RDark ➜ ~ su - at OMD[mysite]:~$ cd tmp OMD[mysite]:~$ cmk -Afv --profile
Note cmk -Afv --profile is only one example. This command will trigger the agent baking via the CLI. You may need to profile a different command.
.
Now we will see two files:
Code Block language bash theme RDark OMD[mysite]:~/tmp$ ls |grep profile profile.out* show_profile.py*
.
To work with these files, we need to copy them outside the site.
Code Block language bash theme RDark OMD[mysite]:~/tmp$ cp show_profile.py profile.out /tmp/
.
- Now there are two ways to analyze these files:
Open the profile file via the command line:
Code Block language bash theme RDark ➜ /tmp ./show_profile.py
- Analyze via snakevize as described here: Checkmk
...
Profile a Checkmk function
Warning |
---|
Please note that we do not support any changes to our code. If you do this, please keep a backup of the file! |
...
Code Block | ||||
---|---|---|---|---|
| ||||
from cmk.utils.profile import profile_call ..... @profile_call("/tmp/myprofile_dir") def my_func_to_profile(self): print("ding dong") |
Analyze a profiling file with python3 but generated on python2
Note |
---|
If you're running Checkmk <1.6 and >2.0 on your system, you will also have python2 and python3 installed. If you generate a profile on Checkmk 1.6 (pyhon2), you won't be able to open this file if python3 is your default python on your system. |
There is a simple to achieve this anyway:
The solution is: Python virtualenv inspired by: https://computingforgeeks.com/how-to-install-python2-with-virtualenv-on-ubuntu/How To Install Python 2 with Virtualenv on Ubuntu 20.04
Here is my short step-by-step guide:
...
In this env, you can analyze all profile files generated with python2!
Network Analyze with the Internet browser
...
- Start the Network Monitor
- Ctrl + Shift + I
...
- For Firefox, follow this manual:
...
- Firefox Network Analyzer
- For Google Chrome, follow this manual:
...
- Reload the slow/ crashing view again and save/export this file as .har. Please submit this file to us.
Slow views
Note |
---|
This option is only available in Checkmk 2.2 or greater. |
Some built-in or own views may take longer time than expected. In order to detect slow views, you have to set:
The log level to DEBUG at Setup > General > Global settings > User interface > Log levels > Slow views
A threshold (in seconds) at Setup > General > Global settings > User interface > Threshold for slow views
The logging is disabled by default. The default threshold is set to 60 seconds.
If enabled, one log entry per view rendering that exceeds the configured threshold is logged to var/log/web.log.
A slow-view log entry will look like the following:
Code Block | ||||
---|---|---|---|---|
| ||||
2023-10-05 14:01:02,467 [10] [cmk.web.slow-views 783147] View name: logfile, User: cmkadmin, Row limit: None, Limit type: none, URL variables: ['csrf_token=deaacdae-e2ad-47bb-a497-8a41c4f5e378', 'filled_in=filter', 'is_log_notification_phase=-1', 'limit=none', 'logclass0=on', 'logclass1=on', 'logclass2=on', 'logclass3=on', 'logclass5=on', 'logclass8=on', 'logst_h0=on', 'logst_h1=on', 'logst_h2=on', 'logst_s0=on', 'logst_s1=on', 'logst_s2=on', 'logst_s3=on', 'logtime_from=400', 'logtime_from_range=86400', 'logtime_until_range=3600', 'view_name=logfile', '_show_filter_form=1'], View context: {'optservicegroup': {'optservice_group': '', 'neg_optservice_group': ''}, 'siteopt': {'site': ''}, 'log_class': {'logclass0': 'on', 'logclass1': 'on', 'logclass2': 'on', 'logclass3': 'on', 'logclass4': '', 'logclass5': 'on', 'logclass6': '', 'logclass8': 'on'}, 'log_notification_phase': {'is_log_notification_phase': '-1'}, 'hostregex': {'host_regex': ''}, 'serviceregex': {'service_regex': ''}, 'opthostgroup': {'opthost_group': '', 'neg_opthost_group': ''}, 'logtime': {'logtime_from': '400', 'logtime_until': '', 'logtime_from_range': '86400', 'logtime_until_range': '3600'}, 'log_state': {'logst_h0': 'on', 'logst_h1': 'on', 'logst_h2': 'on', 'logst_s0': 'on', 'logst_s1': 'on', 'logst_s2': 'on', 'logst_s3': 'on'}, 'wato_folder': {'wato_folder': ''}}, Unfiltered rows: 24783, Filtered rows: 24783, Rows after limit: 0, Duration fetching rows: 0.69s, Duration filtering rows: 0.00s, Duration rendering view: 18.44s, Rendering page exceeds 3s: 19.21s |
Related articles
Filter by label (Content by label) | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...