docs/overview.rst

   1 ..
   2 .. Copyright (c) 2019 AT&T Intellectual Property.
   3 ..
   4 .. Copyright (c) 2019 Nokia.
   5 ..
   6 ..
   7 .. Licensed under the Creative Commons Attribution 4.0 International
   8 ..
   9 .. Public License (the "License"); you may not use this file except
  10 ..
  11 .. in compliance with the License. You may obtain a copy of the License at
  12 ..
  13 ..
  14 ..     https://creativecommons.org/licenses/by/4.0/
  15 ..
  16 ..
  17 .. Unless required by applicable law or agreed to in writing, documentation
  18 ..
  19 .. distributed under the License is distributed on an "AS IS" BASIS,
  20 ..
  21 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  22 ..
  23 .. See the License for the specific language governing permissions and
  24 ..
  25 .. limitations under the License.
  26 ..
  27
  28
  29 pylog Overview
  30 ==============
  31
  32 Structured logging library for Python with Mapped Diagnostic Context (MDC) support.
  33
  34 The library:
  35
  36 - Outputs the log entries to standard out in a structured format
  37 - Supports severity based filtering
  38 - Supports Mapped Diagnostic Context (MDC)
  39 - automatically adds the MDC pairs to all the log entries