Configuring multiple collations for ERRORLOG file

The Microsoft SQL Server agent supports multiple collations in ERRORLOG file. You can configure the agent to parse multiple collations in the ERRORLOG file for Problem Detail attribute group. Multiple collations in ERRORLOG file are 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 parses 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, where:

    • For 64-bits agent, the agent_directory is Agent_home\TMAITM6_x64.
    • For 32-bits agent, the agent_directory is Agent_home\TMAITM6.

    The Agent_home is the agent installation directory.

  2. Open the configuration file koqErrConfig.ini with your editor.

  3. Add the new collations.

    For example, to enable French collation, add the following collation settings in name-value pair format in koqErrConfig.ini.

    [French]
Error = Erreur :
Severity = Gravité :
State = État :

    Note: The sample list of collations is available in agent_directory\koqErrConfigSample.ini, where:

    • For 64-bits agent, the agent_directory is Agent_home\TMAITM6_x64.

    • For 32-bits agent, the agent_directory is Agent_home\TMAITM6.

    The 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
    • The Section_name is the SQL Server collation name. Ensure that the collation name is enclosed with an open bracket “[” and a closed bracket “]”.
    • The Error_value is the error keyword found in ERRORLOG file of your target collation.
    • The Severity_value is the severity keyword found in ERRORLOG file of your target collation.
    • The State_value is the state keyword found in ERRORLOG file of your target collation.

    Important: The keyword values must be the same as the keyword values found in the ERRORLOG file, including any special characters.

  4. Save the configuration file koqErrConfig.ini.

    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 shows the default collation as English error message. The error message severity level is more than the default severity level, if any.

    If the configuration file koqErrConfig.ini is configured correctly, the ERRORLOG file shows the error messages with severity level more than the default severity level, if any.

    The default severity level is 17.

    Attention: Before agent upgrade, you must make a copy of the koqErrConfig.ini file. It is not preserved during agent upgrade.

What to do next

Check the Errorlog Alert widget or the Problem Detail attribute group on the IBM Cloud Pak console as the result of the collation settings.