Skip to content

F response log format

Timm Fitschen requested to merge f-response-log-format into dev

Summary

Implements https://gitlab.indiscale.com/caosdb/customers/leibniz-zmt/management/-/issues/229

Introduces two new config options, REST_RESPONSE_LOG_FORMAT and GRPC_RESPONSE_LOG_FORMAT which control the log message's format.

Focus

  • It was not possible to rely on the logging frameworks configuration options for this issue. The logging frameworks can control the output formatting of metadata, the log level, and the output method. However, the message which is being logged is constructed before it is passed to the logging framework.
  • Since we have two very different API's it was necessary to handle the logging in two places and also introduce two new server options.

Test Environment

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

  • All automated tests pass
  • Reference related issues
  • Up-to-date CHANGELOG.md (or not necessary)
  • Up-to-date JSON schema (or not necessary)
  • Appropriate user and developer documentation (or not necessary)
    • How do I use the software? Assume "stupid" users.
    • How do I develop or debug the software? Assume novice developers.
  • Annotations in code (Gitlab comments)
    • Intent of new code
    • Problems with old code
    • Why this implementation?

Check List for the Reviewer

  • I understand the intent of this MR
  • All automated tests pass
  • Up-to-date CHANGELOG.md (or not necessary)
  • Appropriate user and developer documentation (or not necessary)
  • The test environment setup works and the intended behavior is reproducible in the test environment
  • In-code documentation and comments are up-to-date.
  • Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

Edited by Florian Spreckelsen

Merge request reports