Skip to content

docs(dashmate): document logging configuration #2156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Sep 26, 2024
Merged

docs(dashmate): document logging configuration #2156

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d00c36a
docs(dashmate): document logging configuration
shumkov Sep 20, 2024
5445edf
Update packages/dashmate/src/config/configJsonSchema.js
QuantumExplorer Sep 26, 2024
3022e2f
Update packages/dashmate/src/config/configJsonSchema.js
QuantumExplorer Sep 26, 2024
31e50a6
Update packages/dashmate/src/config/configJsonSchema.js
QuantumExplorer Sep 26, 2024
ac1cc6e
Update packages/dashmate/src/config/configJsonSchema.js
QuantumExplorer Sep 26, 2024
9f20f35
Update packages/dashmate/src/config/configJsonSchema.js
QuantumExplorer Sep 26, 2024
bb9d4cc
Merge branch 'v1.4-dev' into docs/logging-config
QuantumExplorer Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 31 additions & 4 deletions packages/dashmate/src/config/configJsonSchema.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,28 +404,39 @@ export default {
filePath: {
type: ['null', 'string'],
minLength: 1,
description: 'Write logs only to stdout if null. Write to stdout and log'
+ ' file (absolute file path on host machine). Use file log to persist core logs.'
+ ' stdout logs are stored with docker containers and removed together',
},
debug: {
type: 'object',
properties: {
enabled: {
type: 'boolean',
description: 'Enable debug logging (debug=1)',
},
ips: {
type: 'boolean',
description: 'Include IP addresses in debug output',
},
sourceLocations: {
type: 'boolean',
description: 'Prepend debug output with name of the originating source'
+ ' location (source file, line number and function name)',
},
threadNames: {
type: 'boolean',
description: 'Prepend debug output with name of the originating thread (only'
+ ' available on platforms supporting thread_local)',
},
timeMicros: {
type: 'boolean',
description: 'Add microsecond precision to debug timestamps',
},
includeOnly: {
type: 'array',
uniqueItems: true,
description: 'Log all categories if empty or only specified otherwise.',
items: {
type: 'string',
enum: ['net', 'tor', 'mempool', 'http', 'bench', 'zmq', 'walletdb', 'rpc', 'estimatefee',
Expand All @@ -437,6 +448,7 @@ export default {
},
exclude: {
type: 'array',
description: 'Exclude debugging information for a category or categories.',
uniqueItems: true,
items: {
type: 'string',
Expand Down Expand Up @@ -654,10 +666,12 @@ export default {
properties: {
level: {
type: 'string',
description: 'Log level for gateway container logs',
enum: ['trace', 'debug', 'info', 'warn', 'error', 'critical', 'off'],
},
accessLogs: {
type: 'array',
description: 'Envoy access logs',
items: {
oneOf: [
{
Expand All @@ -667,7 +681,8 @@ export default {
type: 'string',
minLength: 1,
enum: ['stdout', 'stderr'],
description: 'Access log type: stdout, stderr or file',
description: 'stdout, stderr or file (absolute file path on host'
+ ' machine)',
},
format: {
type: 'string',
Expand All @@ -693,7 +708,9 @@ export default {
additionalProperties: {
type: 'string',
},
description: 'JSON fields and values. If null, default template is used.',
description: 'JSON fields and values. If null, default template is'
+ ' is used. More info:'
+ ' https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#format-dictionaries',
},
},
required: ['template'],
Expand All @@ -703,7 +720,9 @@ export default {
properties: {
template: {
type: ['null', 'string'],
description: 'Template string. If null, default template is used.',
description: 'Template string. If null, default template is used.'
+ ' More info:'
+ ' https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#format-strings',
},
},
required: ['template'],
Expand Down Expand Up @@ -827,6 +846,7 @@ export default {
},
logs: {
type: 'object',
description: 'Define Drive logs',
propertyNames: {
type: 'string',
minLength: 1,
Expand All @@ -847,10 +867,13 @@ export default {
},
format: {
type: 'string',
description: 'Log format:'
+ ' https://docs.rs/tracing-subscriber/latest/tracing_subscriber/fmt/format/index.html',
enum: ['full', 'compact', 'pretty', 'json'],
},
color: {
type: ['boolean', 'null'],
description: 'Whether or not to use colorful output; defaults to autodetect',
},
},
required: ['destination', 'level', 'format', 'color'],
Expand Down Expand Up @@ -1115,17 +1138,21 @@ export default {
level: {
type: 'string',
enum: ['trace', 'debug', 'info', 'warn', 'error'],
description: 'Log verbosity level',
},
format: {
type: 'string',
enum: ['plain', 'json'],
description: 'Log format: text or json',
},
path: {
type: ['string', 'null'],
minLength: 1,
description: 'Write to stdout only if null or to stdout and specified log'
+ ' file (absolute file path on host machine)',
},
},
required: ['level', 'format'],
required: ['level', 'format', 'path'],
additionalProperties: false,
},
rpc: {
Expand Down
Loading