diff options
| author |   Cédric Ollivier <cedric.ollivier@orange.com> | 2023-03-15 21:40:48 +0100 |
|---|---|---|
| committer | Cédric Ollivier <cedric.ollivier@orange.com> | 2023-03-15 21:49:09 +0100 |
| commit | 490b20d3e31acbc3e8f62f950186fb507fb445f0 (patch) | |
| tree | c9d81999a5287f401c78a2c72e26a346c7463d92 /docs/admin-guide.rst | |
| parent | 9a552aaf3dcd944a629aa30a3cb8122eb8ce7585 (diff) | |
Enable all Sphinx build warnings as errors
It also fixes several issues to pass the gate.
Please note that .. code-block :: json content must be json.
Issue-ID: DOC-798
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Change-Id: I38a751b67ab70a5ed5d61cdd49fe914c7b9270cd
Diffstat (limited to 'docs/admin-guide.rst')
| -rw-r--r-- | docs/admin-guide.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst index a7439ef4c1..c2643f87cd 100644 --- a/docs/admin-guide.rst +++ b/docs/admin-guide.rst @@ -30,7 +30,7 @@ Logging Configuration CPS Log pattern --------------- -.. code-block:: java +.. code-block:: <pattern> { @@ -50,7 +50,7 @@ Change logging level - Curl command 1. Check current log level of "logging.level.org.onap.cps" if it is set to it's default value (INFO) -.. code-block:: java +.. code-block:: bash curl --location --request GET 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \ --header 'Content-Type: application/json; charset=utf-8' @@ -68,7 +68,7 @@ Change logging level .. note:: Below-mentioned endpoint will change the log level at runtime. After executing the curl command "effectiveLevel" will set and applied immediately without restarting CPS service. -.. code-block:: java +.. code-block:: bash curl --location --request POST 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \ --header 'Content-Type: application/json; charset=utf-8' \ @@ -80,7 +80,7 @@ Change logging level - Curl command 3. Verify if log level of "logging.level.org.onap.cps" is changed from 'INFO' to 'DEBUG' -.. code-block:: java +.. code-block:: bash curl --location --request GET 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \ --header 'Content-Type: application/json; charset=utf-8' @@ -109,7 +109,7 @@ Measure Execution Time of CPS Service Execute CPS service that you want to calculate total elapsed time and log as shown below -.. code-block:: xml +.. code-block:: 2022-01-28 18:39:17.679 DEBUG [cps-application,e17da1571e518c59,e17da1571e518c59] 11128 --- [tp1901272535-29] o.onap.cps.aop.CpsLoggingAspectService : Execution time of : DataspaceRepository.getByName() with argument[s] = [test42] having result = org.onap.cps.spi.entities.DataspaceEntity@68ded236 :: 205 ms |