From 35ccfeea4a17d0ee176c44ca0a569da9df8b5e55 Mon Sep 17 00:00:00 2001 From: Brice Schaffner Date: Wed, 20 Nov 2024 06:44:07 +0100 Subject: [PATCH] Added missing .pylintrc and log config Those file have been forgotten when migrating from https://github.com/geoadmin/doc-guidelines-legacy and were also out dated. They are now up to date. --- PYTHON.md | 8 +- assets/.pylintrc | 529 ++++++++++++++++++++++++++++ assets/logging-cfg-django-dev.yaml | 142 ++++++++ assets/logging-cfg-django-prod.yaml | 142 ++++++++ assets/logging-cfg-flask-dev.yaml | 114 ++++++ assets/logging-cfg-flask-prod.yaml | 116 ++++++ assets/logging-cfg-local.yaml | 89 +++++ 7 files changed, 1137 insertions(+), 3 deletions(-) create mode 100644 assets/.pylintrc create mode 100644 assets/logging-cfg-django-dev.yaml create mode 100644 assets/logging-cfg-django-prod.yaml create mode 100644 assets/logging-cfg-flask-dev.yaml create mode 100644 assets/logging-cfg-flask-prod.yaml create mode 100644 assets/logging-cfg-local.yaml diff --git a/PYTHON.md b/PYTHON.md index 6b17749..3d40c1c 100644 --- a/PYTHON.md +++ b/PYTHON.md @@ -729,9 +729,11 @@ def init_logging(): Each application should use the following configurations depending on the environment: -- [logging-cfg-local.yml](assets/logging-cfg-local.yml) (local development) -- [logging-cfg-dev.yml](assets/logging-cfg-dev.yml) -- [logging-cfg-prod.yml](assets/logging-cfg-prod.yml) +- [logging-cfg-local.yml](assets/logging-cfg-local.yaml) (local development) +- [logging-cfg-flask-dev.yml](assets/logging-cfg-flask-dev.yaml) +- [logging-cfg-flask-prod.yml](assets/logging-cfg-flask-prod.yaml) +- [logging-cfg-django-dev.yml](assets/logging-cfg-django-dev.yaml) +- [logging-cfg-django-prod.yml](assets/logging-cfg-django-prod.yaml) #### Flask logging configuration diff --git a/assets/.pylintrc b/assets/.pylintrc new file mode 100644 index 0000000..5d52600 --- /dev/null +++ b/assets/.pylintrc @@ -0,0 +1,529 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-whitelist= + +# Specify a score threshold to be exceeded before program exits with error. +fail-under=10 + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins=pylint_flask + +# Pickle collected data for later comparisons. +persistent=yes + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=missing-docstring, + missing-module-docstring, + unused-argument, + unused-variable, + pointless-string-statement, + too-many-arguments, + too-few-public-methods, + consider-using-f-string, + useless-object-inheritance, + invalid-name, + too-many-branches, + too-many-statements, + consider-using-with, + broad-except, + logging-not-lazy, + too-many-public-methods, + + + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'error', 'warning', 'refactor', and 'convention' +# which contain the number of messages in each category, as well as 'statement' +# which is the total number of statements analyzed. This score is used by the +# global evaluation report (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=colorized + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format=LF + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=snake_case + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. +#class-attribute-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + fd, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx= + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=10 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +#notes-rgx= + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled). +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled). +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[DESIGN] + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=7 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=builtins.Exception.BaseException, + builtins.Exception.Exception, + builtins.Exception.StandardError diff --git a/assets/logging-cfg-django-dev.yaml b/assets/logging-cfg-django-dev.yaml new file mode 100644 index 0000000..d90def9 --- /dev/null +++ b/assets/logging-cfg-django-dev.yaml @@ -0,0 +1,142 @@ +version: 1 +disable_existing_loggers: False # this allow to get logger at module level + +root: + handlers: + - console + level: DEBUG + propagate: True + +loggers: + django: + level: DEBUG + django.utils.autoreload: + level: INFO + gunicorn.error: + level: WARNING + handlers: + - console + gunicorn.access: + level: WARNING + handlers: + - console + +filters: + type_filter: + (): logging_utilities.filters.attr_type_filter.AttrTypeFilter + typecheck_list: + request: django.http.request.HttpRequest + isotime: + (): logging_utilities.filters.TimeAttribute + isotime: False + utc_isotime: True + add_request: + (): logging_utilities.filters.add_thread_context_filter.AddThreadContextFilter + contexts: + - logger_key: request + context_key: request + django: + (): logging_utilities.filters.django_request.JsonDjangoRequest + attr_name: request + include_keys: + - request.path + - request.method + - request.headers + - request.META.QUERY_STRING + exclude_keys: + - request.headers.Authorization + - request.headers.Proxy-Authorization + - request.headers.Cookie + # These two are present when using gunicorn and cannot be correctly jsonified. + - request.META.gunicorn + - request.META.wsgi + +formatters: + standard: + format: "[%(asctime)s] %(levelname)-8s - %(name)-26s : %(message)s" + json: + (): logging_utilities.formatters.json_formatter.JsonFormatter + add_always_extra: False + filter_attributes: + - utc_isotime + remove_empty: True + ignore_missing: True + fmt: + # ECS fields + message: message + event: + category: web + created: utc_isotime + duration: response.duration + kind: event + module: module + # severity: levelno + http: + request: + id: request.headers.X-Amz-Cf-Id + method: request.method + headers: + Content-Type: request.headers.Content-Type + Content-Length: request.headers.Content-Length + Cloudfront-Forwarded-Proto: request.headers.Cloudfront-Forwarded-Proto + Content-Encoding: request.headers.Content-Encoding + Origin: request.headers.Origin + Referer: request.headers.Referer + Accept: request.headers.Accept + Accept-Encoding: request.headers.Accept-Encoding + Accept-Language: request.headers.Accept-Language + User-Agent: request.headers.User-Agent + If-None-Match: request.headers.If-None-Match + Sec-Fetch-Mode: request.headers.Sec-Fetch-Mode + Sec-Fetch-Site: request.headers.Sec-Fetch-Site + Sec-CH-UA: request.headers.Sec-CH-UA + Sec-CH-UA-Mobile: request.headers.Sec-CH-UA-Mobile + Sec-CH-UA-Platform: request.headers.Sec-CH-UA-Platform + Sec-CH-UA-Model: request.headers.Sec-CH-UA-Model + Geoadmin-Authenticated: request.headers.Geoadmin-Authenticated + Geoadmin-Username: request.headers.Geoadmin-Username + apigw-requestid: request.headers.apigw-requestid + body: + content: request.payload + response: + status_code: response.code + headers: + Cache-Control: response.headers.Cache-Control + Expires: response.headers.Expires + Content-Type: response.headers.Content-Type + Content-Length: response.headers.Content-Length + Content-Encoding: response.headers.Content-Encoding + Access-Control-Allow-Headers: response.headers.Access-Control-Allow-Headers + Access-Control-Allow-Methods: response.headers.Access-Control-Allow-Methods + Access-Control-Allow-Origin: response.headers.Access-Control-Allow-Origin + ETag: response.headers.ETag + body: + content: response.payload + log: + level: levelname + logger: name + origin: + file: + line: lineno + name: module + function: funcName + process: + pid: process + thread: + id: thread + service: + type: service_type + url: + path: request.path + query: request.META.QUERY_STRING + +handlers: + console: + class: logging.StreamHandler + formatter: json + stream: ext://sys.stdout + filters: + - type_filter + - isotime + - add_request + - django diff --git a/assets/logging-cfg-django-prod.yaml b/assets/logging-cfg-django-prod.yaml new file mode 100644 index 0000000..987672b --- /dev/null +++ b/assets/logging-cfg-django-prod.yaml @@ -0,0 +1,142 @@ +version: 1 +disable_existing_loggers: False # this allow to get logger at module level + +root: + handlers: + - console + level: WARNING + propagate: True + +loggers: + stac_api: + level: WARNING + middleware: + level: WARNING + middleware.logging: + level: INFO + django: + level: WARNING + gunicorn.error: + level: WARNING + handlers: + - console + gunicorn.access: + level: WARNING + handlers: + - console + +filters: + type_filter: + (): logging_utilities.filters.attr_type_filter.AttrTypeFilter + typecheck_list: + request: django.http.request.HttpRequest + isotime: + (): logging_utilities.filters.TimeAttribute + isotime: False + utc_isotime: True + add_request: + (): logging_utilities.filters.add_thread_context_filter.AddThreadContextFilter + contexts: + - logger_key: request + context_key: request + django: + (): logging_utilities.filters.django_request.JsonDjangoRequest + attr_name: request + include_keys: + - request.path + - request.method + - request.headers + - request.META.QUERY_STRING + exclude_keys: + - request.headers.Authorization + - request.headers.Proxy-Authorization + - request.headers.Cookie + # These two are present when using gunicorn and cannot be correctly jsonified. + - request.META.gunicorn + - request.META.wsgi + +formatters: + json: + (): logging_utilities.formatters.json_formatter.JsonFormatter + add_always_extra: False + filter_attributes: + - utc_isotime + remove_empty: True + ignore_missing: True + fmt: + + # ECS fields + message: message + event: + category: web + created: utc_isotime + duration: response.duration + kind: event + module: module + # severity: levelno + http: + request: + id: request.headers.X-Amz-Cf-Id + method: request.method + headers: + Content-Type: request.headers.Content-Type + Content-Length: request.headers.Content-Length + Cloudfront-Forwarded-Proto: request.headers.Cloudfront-Forwarded-Proto + Content-Encoding: request.headers.Content-Encoding + Origin: request.headers.Origin + Referer: request.headers.Referer + Accept: request.headers.Accept + Accept-Encoding: request.headers.Accept-Encoding + Accept-Language: request.headers.Accept-Language + User-Agent: request.headers.User-Agent + If-None-Match: request.headers.If-None-Match + Sec-Fetch-Mode: request.headers.Sec-Fetch-Mode + Sec-Fetch-Site: request.headers.Sec-Fetch-Site + Sec-CH-UA: request.headers.Sec-CH-UA + Sec-CH-UA-Mobile: request.headers.Sec-CH-UA-Mobile + Sec-CH-UA-Platform: request.headers.Sec-CH-UA-Platform + Sec-CH-UA-Model: request.headers.Sec-CH-UA-Model + body: + content: request.payload + response: + status_code: response.code + headers: + Cache-Control: response.headers.Cache-Control + Expires: response.headers.Expires + Content-Type: response.headers.Content-Type + Content-Length: response.headers.Content-Length + Content-Encoding: response.headers.Content-Encoding + Access-Control-Allow-Headers: response.headers.Access-Control-Allow-Headers + Access-Control-Allow-Methods: response.headers.Access-Control-Allow-Methods + Access-Control-Allow-Origin: response.headers.Access-Control-Allow-Origin + ETag: response.headers.ETag + body: + content: response.payload + log: + level: levelname + logger: name + origin: + file: + line: lineno + name: module + function: funcName + process: + pid: process + thread: + id: thread + service: + type: service_type + url: + path: request.path + query: request.META.QUERY_STRING + +handlers: + console: + class: logging.StreamHandler + formatter: json + stream: ext://sys.stdout + filters: + - type_filter + - isotime + - add_request + - django diff --git a/assets/logging-cfg-flask-dev.yaml b/assets/logging-cfg-flask-dev.yaml new file mode 100644 index 0000000..ed25668 --- /dev/null +++ b/assets/logging-cfg-flask-dev.yaml @@ -0,0 +1,114 @@ +version: 1 +disable_existing_loggers: False # this allow to get logger at module level + +root: + handlers: + - console + level: DEBUG + propagate: True + +loggers: + # Remove all handlers for werkzeug log entries - prevents duplicated logging + werkzeug: + handlers: [] + gunicorn.error: + level: WARNING + handlers: + - console + gunicorn.access: + level: WARNING + handlers: + - console + +filters: + isotime: + (): logging_utilities.filters.TimeAttribute + isotime: False + utc_isotime: True + flask: + (): logging_utilities.filters.flask_attribute.FlaskRequestAttribute + attributes: + - path + - method + - headers + - remote_addr + - form + - query_string + - url + - view_args + const_attributes: + (): logging_utilities.filters.ConstAttribute + service_type: flask + +formatters: + json: + (): logging_utilities.formatters.json_formatter.JsonFormatter + add_always_extra: False + filter_attributes: + - utc_isotime + - flask_request_path + - flask_request_method + - flask_request_query_string + - flask_request_headers + - flask_request_form + - flask_request_remote_addr + - flask_request_url + - flask_request_view_args + - service_type + remove_empty: True + ignore_missing: True + fmt: + # ECS fields + message: message + event: + category: web + created: utc_isotime + duration: duration + kind: event + severity: levelno + http: + request: + headers: flask_request_headers. + method: "%(flask_request_method)s" + response: + headers: response.headers. + status_code: response.status_code + log: + level: levelname + logger: name + origin: + file: + name: pathname + line: lineno + function: funcName + url: + original: flask_request_url + process: + pid: process + thread: + id: thread + service: + type: service_type + + # Custom fields + ppbgdi: + proxy: + downstream: + url: + scheme: remote.request.proto + domain: remote.request.domain + full: remote.request.url + path: remote.request.path + http: + response: + status_code: remote.response.status_code + headers: remote.response.headers +handlers: + console: + class: logging.StreamHandler + formatter: json + stream: ext://sys.stdout + filters: + - isotime + - flask + - const_attributes diff --git a/assets/logging-cfg-flask-prod.yaml b/assets/logging-cfg-flask-prod.yaml new file mode 100644 index 0000000..1e44fdf --- /dev/null +++ b/assets/logging-cfg-flask-prod.yaml @@ -0,0 +1,116 @@ +version: 1 +disable_existing_loggers: False # this allow to get logger at module level + +root: + handlers: + - console + level: WARNING + propagate: True + +loggers: + # Remove all handlers for werkzeug log entries - prevents duplicated logging + werkzeug: + handlers: [] + gunicorn.error: + level: WARNING + handlers: + - console + gunicorn.access: + level: WARNING + handlers: + - console + urllib3: + level: WARNING + +filters: + isotime: + (): logging_utilities.filters.TimeAttribute + isotime: False + utc_isotime: True + flask: + (): logging_utilities.filters.flask_attribute.FlaskRequestAttribute + attributes: + - path + - method + - headers + - remote_addr + - form + - query_string + - url + - view_args + const_attributes: + (): logging_utilities.filters.ConstAttribute + service_type: flask + +formatters: + json: + (): logging_utilities.formatters.json_formatter.JsonFormatter + add_always_extra: False + filter_attributes: + - utc_isotime + - flask_request_path + - flask_request_method + - flask_request_query_string + - flask_request_headers + - flask_request_form + - flask_request_remote_addr + - flask_request_url + - flask_request_view_args + - service_type + remove_empty: True + ignore_missing: True + fmt: + # ECS fields + message: message + event: + category: web + created: utc_isotime + duration: duration + kind: event + severity: levelno + http: + request: + headers: flask_request_headers. + method: "%(flask_request_method)s" + response: + headers: response.headers. + status_code: response.status_code + log: + level: levelname + logger: name + origin: + file: + name: pathname + line: lineno + function: funcName + url: + original: flask_request_url + process: + pid: process + thread: + id: thread + service: + type: service_type + + # Custom fields + ppbgdi: + proxy: + downstream: + url: + scheme: remote.request.proto + domain: remote.request.domain + full: remote.request.url + path: remote.request.path + http: + response: + status_code: remote.response.status_code + headers: remote.response.headers +handlers: + console: + class: logging.StreamHandler + formatter: json + stream: ext://sys.stdout + filters: + - isotime + - flask + - const_attributes diff --git a/assets/logging-cfg-local.yaml b/assets/logging-cfg-local.yaml new file mode 100644 index 0000000..bb239f6 --- /dev/null +++ b/assets/logging-cfg-local.yaml @@ -0,0 +1,89 @@ +version: 1 +disable_existing_loggers: False # this allow to get logger at module level + +root: + handlers: + - console + level: DEBUG + propagate: True + +loggers: + # Remove all handlers for werkzeug log entries - prevents duplicated logging + # Un-comment these lines if you use Flask + # werkzeug: + # handlers: [] + gunicorn.error: + level: DEBUG + handlers: + - console + gunicorn.access: + level: DEBUG + handlers: + - console + +filters: + application: + (): logging_utilities.filters.ConstAttribute + application: your-application-name # set the correct application name + isotime: + (): logging_utilities.filters.TimeAttribute + isotime: False + utc_isotime: True + # Un-comment these lines if you use flask + # flask: + # (): logging_utilities.filters.flask_attribute.FlaskRequestAttribute + # attributes: + # - url + # - method + # - headers + # - remote_addr + # - json + +formatters: + standard: + format: "[%(asctime)s] %(levelname)-8s - %(name)-26s : %(message)s" + # Un-comment these lines if you use flask + # verbose-flask: + # format: "[%(asctime)s] %(levelname)-8s - %(name)-26s : %(message)s : url=%(request_url)s headers=%(request_headers)s payload=%(request_json)s" + json: + (): logging_utilities.formatters.json_formatter.JsonFormatter + add_always_extra: True + filter_attributes: + - application + - utc_isotime + # Un-comment these lines if you use flask + # - flask_request_url + # - flask_request_method + # - flask_request_headers + # - flask_request_json + # - flask_request_remote_addr + remove_empty: True + fmt: + time: utc_isotime + level: levelname + app: application + logger: name + module: module + function: funcName + process: process + thread: thread + # Un-comment these lines if you use flask + # request: + # url: flask_request_url + # method: flask_request_method + # headers: flask_request_headers + # data: flask_request_json + # remote: flask_request_remote_addr + exc_info: exc_info + message: message + +handlers: + console: + class: logging.StreamHandler + formatter: standard + stream: ext://sys.stdout + filters: + - application + - isotime + # Un-comment this lines if you use flask + #- flask