Configuring multiple collations for ERRORLOG file

The Microsoft SQL Server agent version 06.31.17.00 or later for Application Performance Management version 8.1.4.0.4 supports multiple collations in ERRORLOG file. You can now configure the agent to parse more than one collations in the ERRORLOG file for Problem Detail attribute group. Note that the multiple collations in ERRORLOG file is not applicable for Error Event Detail attribute group.

Before you begin

To configure multiple collations of the agent, ensure that the agent is installed.

About this task

The default collation is English. For other languages of SQL Server, the agent will parse the ERRORLOG file based on the collations in the configuration file koqErrConfig.ini. So you must add the collations that are in used in koqErrConfig.ini file.

Procedure

To configure multiple collations for the agent, complete the following steps:

  1. Go to the agent directory agent_directory.
    Windows
    • For 64-bits agent, agent_directory is Agent_home\TMAITM6_x64.
    • For 32-bits agent, agent_directory is Agent_home\TMAITM6.
    Linux
    • For 64-bits agent, agent_directory is Agent_home/TMAITM6_x64.
    Where Agent_home is the agent installation directory.
  2. Open the configuration koqErrConfig.ini file:
  3. Move to the end of the file to add the new collations.
    For example, to enable collation for French, add the following collation settings in name-value pair format at the end of koqErrConfig.ini file.
    [French]
    Error = Erreur :
    Severity = Gravité : 
    State = État :
    Note: The sample list of collations is available in agent_directory\koqErrConfigSample.ini.
    Where Windows
    • For 64-bits agent, agent_directory is Agent_home\TMAITM6_x64.
    • For 32-bits agent, agent_directory is Agent_home\TMAITM6.
    Linux
    • For 64-bits agent, agent_directory is Agent_home/TMAITM6_x64.
    Where Agent_home is the agent installation directory.
    If the target collation is not available in koqErrConfigSample.ini, you can determine the collation keyword values from the ERRORLOG file.
    Adhere to the following collation format when configure the collation settings in koqErrConfig.ini.
    [Section_name]
    Error = Error_value
    Severity = Severity_value
    State = State_value
    Where
    • Section_name is the SQL Server collation name. Ensure the collation name is enclosed with an open bracket [ and a closed bracket ].
    • Error_value is the corresponding error keyword found in the ERRORLOG file of your target collation.
    • Severity_value is the corresponding severity keyword found in the ERRORLOG file of your target collation.
    • State_value is the corresponding state keyword found in the ERRORLOG file of your target collation.
    Important: The keyword values must be the same as the keyword values found in the ERRORLOG file, including the special characters.
  4. Save the configuration koqErrConfig.ini file.

    Agent restart is not required.

    If the configuration file koqErrConfig.ini is not available or the configuration file koqErrConfig.ini is empty,the ERRORLOG file will show the default collation as English error message with severity level more than the default severity level, if any.

    If the configuration file koqErrConfig.ini is configured correctly, the ERRORLOG file will show the corresponding error messages with severity level more then the default severity level, if any.

    The default severity level is 17.

    Attention: The changes made in the koqErrConfig.ini file is not preserved during agent upgrade, you must make a backup before performing agent upgrade.

What to do next

Check the Errorlog Alert widget or the Problem Detail attribute group on Application Performance Management dashboard as the result of the collation settings..