github.com/matrixorigin/matrixone@v1.2.0/pkg/common/log/doc.go (about)

     1  // Copyright 2021 - 2022 Matrix Origin
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package log is used to control the log printing in MatrixOne.
    16  //
    17  // Printing logs using the Log package enables the following functions:
    18  //  1. Uniform logger name
    19  //  2. Support search all logs by service's uuid.
    20  //  3. Support search the operation logs of all related processes by process ID, e.g.
    21  //     search all logs of that transaction by transaction.
    22  //  4. Sampling and printing of frequently output logs.
    23  //  5. One line of code to add a time consuming log to a function.
    24  //  6. Support for using the mo_ctl function to control log printing.
    25  package log