Enabling Index

Last updated: 2020-07-22 17:59:40

    CLS offers real-time log query to help identify business problems quickly. You need to configure and enable index before log search.

    How search works

    Log search is performed based on the keywords of a log that are matched with the information you entered. You can flexibly adjust the keywords by customizing a word delimiter or specifying whether to enable case sensitivity depending on your business needs. The following example uses a log to explain the word delimiters and case-sensitivity.

    10002345987;write;ERROR;code=400;topic does not exist;

    Word delimiters

    The text of the raw log can be split into several keywords by using a word delimiter to facilitate your search. For example:

    • If the word delimiter is set to ;=, the log is split into 6 words: 10002345987, write, ERROR, code, 400, and topic does not exist. In exact search, you can find the log by typing any of the above words.
    • If the word delimiter is left blank, the entire log is regarded as a word. In exact search, you have to type the entire word to search for the log.


    Case-sensitivity refers to the precise distinction between uppercase and lowercase letters in a string. For example, when the word delimiter is ;=:

    • If case-sensitive is enabled, the log cannot be found by typing error. This is because error and ERROR are regarded as two different keywords.
    • If case-sensitivity is disabled, the log can be found by typing error, Error, or ERROR.

    Enabling index

    Index is an optional feature for log topics. You need to select the log topic to query, and then enable its index feature. Specific steps are as follows:

    1. Log in to the CLS Console.
    2. Select Logset in the left sidebar, and then go to the target logset and log topic.
    3. In the Log Topic tab, select Index Configuration.
    4. Enable Full-text Index or Key-value Index as needed, select Case-sensitive (not selected by default), and enter a word delimiter (default word delimiters: @&()='",;:<>[]{}/ \n\t\r).
    5. Click Save to complete the index configuration.

    After a log topic is created, its index is not enabled by default. You need to manually enable it.

    Index types

    Full-text index

    CLS uses a complete log as text for searching. When the full-text index is enabled, you can use a keyword to search for the log. You can also set a custom full-text word delimiter. The text of the raw log is split into several keywords by using a word delimiter to facilitate your search.

    To illustrate the full-text word delimiter feature, here are some examples for search.

    Full-Text Word Delimiter Exact Search Fuzzy Search
    Left blank Enter "10002345987;write;error;code=400;topic does not exist;" Enter "10002345987*"
    ; Enter "code=400" or "topic does not exist" Enter "code=40?" or "code*"
    ;= Enter "code", "400", or "code=400" Enter "topic*" or "40?"
    ; = Enter "topic", "does", "not", or "exist" Enter "do*"

    Key-value index

    CLS can configure key-value index according to the key in the collection configuration. In the key-value index configuration, enter the appropriate key according to the index requirements, and specify its data type (text, long, or double). Custom word delimiters are supported by in the "text" data type. Different word delimiters can be set for different keys.

    Data types

    CLS supports the following three field types:

    Name Type Description
    text Text
    long Integer (Int 64)
    double Floating-point number (64 bit)


    1. Log data collected cannot be found when index is disabled.
    2. Log search will be available in about 1 minute after index is enabled.
    3. The data storage time is the same as that in the logset.
    4. If a log topic is enabled and disabled multiple times, the log data from the period(s) during which index was enabled can be found.