Infrastructure/verdaccio
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-01-20 22:52:46 -05:00
Code Issues Activity

doc: improve docs for logger

Browse source
This commit is contained in:
Juan Picado 2023-03-08 08:36:59 +01:00
parent d0b26c1300
commit 5fee278df4
4 changed files with 48 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
website/docs/config.md
View file

@ -301,19 +301,22 @@ notify:
> For more detailed configuration settings, please [check the source code](https://github.com/verdaccio/verdaccio/tree/master/packages/config/src/conf).
### Logger {#logger}
Two logger types are supported, you may chose only one of them:
#### console output (the default)
```
logs: { type: stdout, format: pretty, level: http }
log: { type: stdout, format: pretty, level: http }
```
#### file output
```
logs: { type: file, path: verdaccio.log, level: info }
log: { type: file, path: verdaccio.log, level: info }
```
For full information - see here: [Features/logger](https://verdaccio.org/docs/logger)
For full information - see here: [Features/logger](logger.md)
### Audit {#audit}

12
website/docs/logger.md
View file

@ -3,18 +3,24 @@ id: logger
title: 'Logger'
---
As with any web application, Verdaccio has a customisable built-in logger. You can define multiple types of outputs.
:::info
Since v5.22.0 the logger property is renamed to `log` but `logs` still compatible with v6 but not recommended to use, could be removed any time.
:::
As with any web application, Verdaccio has a customizable built-in logger. You can define multiple types of outputs.
```yaml
# console output
logs: { type: stdout, format: pretty, level: http }
log: { type: stdout, format: pretty, level: http }
```
or file output.
```yaml
# file output
logs: { type: file, path: verdaccio.log, level: info }
log: { type: file, path: verdaccio.log, level: info }
```
> Verdaccio 5 does not support rotation file anymore, [here more details](https://verdaccio.org/blog/2021/04/14/verdaccio-5-migration-guide#pinojs-is-the-new-logger).

24
website/versioned_docs/version-5.x/config.md
View file

@ -285,6 +285,30 @@ notify:
> For more detailed configuration settings, please [check the source code](https://github.com/verdaccio/verdaccio/tree/master/packages/config/src/conf).
### Logger {#logger}
:::warning
Since v5.22.0 the logger property is renamed to `log` but `logs` still compatible but displaying a warning
:::
Two logger types are supported, you may chose only one of them:
#### console output (the default)
```
log: { type: stdout, format: pretty, level: http }
```
#### file output
```
log: { type: file, path: verdaccio.log, level: info }
```
For full information - see here: [Features/logger](logger.md)
### Audit {#audit}
<small>Since: `verdaccio@3.0.0`</small>

12
website/versioned_docs/version-5.x/logger.md
View file

@ -3,18 +3,24 @@ id: logger
title: 'Logger'
---
As with any web application, Verdaccio has a customisable built-in logger. You can define multiple types of outputs.
:::warning
Since v5.22.0 the logger property is renamed to `log` but `logs` still compatible but displaying a warning
:::
As with any web application, Verdaccio has a customizable built-in logger. You can define multiple types of outputs.
```yaml
# console output
logs: { type: stdout, format: pretty, level: http }
log: { type: stdout, format: pretty, level: http }
```
or file output.
```yaml
# file output
logs: { type: file, path: verdaccio.log, level: info }
log: { type: file, path: verdaccio.log, level: info }
```
> Verdaccio 5 does not support rotation file anymore, [here more details](https://verdaccio.org/blog/2021/04/14/verdaccio-5-migration-guide#pinojs-is-the-new-logger).