The Community Forums

Interact with an entire community of cPanel & WHM users!
  1. This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.

Standardized Hook Debugging

Discussion in 'cPanel Developers' started by jsteel, Jul 16, 2013.

  1. jsteel

    jsteel Well-Known Member

    Jul 4, 2002
    Likes Received:
    Trophy Points:
    Atlanta, GA
    I noticed there is a debug facility for the standardized hooks, but there is some conflicting information in the cPanel docs (StdHooksGettingStarted): < SoftwareDevelopmentKit < TWiki

    The Standardized Hook System provides a multi-level debug mode. The debug mode is controlled by the debughooks key in the cPanel & WHM configuration file /var/cpanel/cpanel.config. The debughook key should be one of the following values:
    0 — Disabled (default value)
    1 — Log information about defined hooks as they are executed. Do not include data.
    2 — Log information about defined hooks as they are executed and their respective data.
    PICK Important: This setting can output a large amount of data. This data is potentially log-sensitive. You should be careful when using this debug value.
    3 — Log information about every hookable event that is traversed, even if there are no defined hooks for the hookable event. This output includes details for defined hooks with data, i.e., the same as level 2.

    The first paragraph notes the config key is both 'debughooks' and 'debughook'. Which is it, as one is clearly a typo and neither appear to be present in the actual config?

  2. cPanelMichael

    cPanelMichael Forums Analyst
    Staff Member

    Apr 11, 2011
    Likes Received:
    Trophy Points:
    cPanel Access Level:
    Root Administrator
    Hello :)

    The correct key for debug mode is:


    I have opened an internal case with our documentation team to ensure this is properly reflected on the "StdHooksGettingStarted" page. For reference, the internal case number is 73297.

    Note that this value is not present in /var/cpanel/cpanel.config by default. You must manually add the value to the cpanel.config file.

    Thank you.

Share This Page