Skip to content

Commit

Permalink
Merge pull request #133 from Ivanov-Anton/branch-546576
Browse files Browse the repository at this point in the history
remove debug column from API Log Config
  • Loading branch information
dmitry-sinina authored Oct 10, 2023
2 parents ab76056 + 65851e2 commit 3148b92
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions en/web-interface/system/yeti-ui-system-api_log_configs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,18 @@
Api Log Configs
~~~~~~~~~~~~~~~

Api Log Configs are used for setting (where necessary) Debug mode for storing records to the :ref:`API Log <api_logs>`.
You can click on the "Yes/No" button near the records for changing their state.
Api Log Configs are used for setting (where necessary) Debug mode for storing additional info to the :ref:`API Log <api_logs>`.
You can create specific API Log Configs or delete them from Admin UI.

The Api Log Configs is a part of our system that enables the configuration of :ref:`API logging <api_logs>` behavior.
It defines how API requests and responses are logged and whether debugging information is captured for specific API controllers.

**Api Log Config**'s properties:
````````````````````````````````
Controller
Controller that will be used for applying of the Debug mode of storing records to the :ref:`API Log <api_logs>` in case of enabling Debug property bellow.
Debug
In case of enabling this property (by clicking on it) additional fields (Request Body, Response Body, Request Headers, Response Headers) will be stored to the :ref:`API Log <api_logs>` for the Controller above.

Best Practices:
```````````````
Use API log configurations rationally to capture logs only for controllers that require detailed logging.
Regularly review and update API log configurations as your application evolves to maintain an accurate log management strategy.

0 comments on commit 3148b92

Please sign in to comment.