@@ -50,20 +50,147 @@ b2c webdav ls --root=logs
5050b2c webdav ls --root=logs --json
5151
5252# download a specific log file (e.g., customerror log)
53- b2c webdav get customerror.log --root=logs
53+ b2c webdav get customerror-blade0-1-appserver-20240115 .log --root=logs
5454
5555# download a log file to a specific local path
56- b2c webdav get error-20240115.log --root=logs -o ./downloads/error.log
56+ b2c webdav get error-blade0-1-appserver- 20240115.log --root=logs -o ./downloads/error.log
5757
5858# output log file content to stdout (for piping to grep, etc.)
59- b2c webdav get customerror.log --root=logs -o -
59+ b2c webdav get customerror-blade0-1-appserver-20240115 .log --root=logs -o -
6060
6161# pipe log content to grep to search for errors
62- b2c webdav get customerror.log --root=logs -o - | grep " ERROR "
62+ b2c webdav get customerror-blade0-1-appserver-20240115 .log --root=logs -o - | grep " OrderNo "
6363
6464# download security logs
6565b2c webdav ls --root=securitylogs
66- b2c webdav get security-20240115.log --root=securitylogs
66+ b2c webdav get security-blade0-1-20240115.log --root=securitylogs
67+
68+ # list archived logs (compressed after 3 days)
69+ b2c webdav ls log_archive --root=logs
70+ ```
71+
72+ ## Log File Reference
73+
74+ ### Log File Naming Pattern
75+
76+ Log files follow this naming pattern:
77+ ```
78+ <type>-<hostname>-appserver-<date>.log
79+ ```
80+
81+ Example: ` customerror-blade0-1-appserver-20240115.log `
82+
83+ ### Custom Log File Types
84+
85+ Files generated by script logging (` dw.system.Logger ` ):
86+
87+ | Log Type | Generated By | Default State |
88+ | ----------| --------------| ---------------|
89+ | ` customdebug ` | ` Logger.debug() ` / ` log.debug() ` | Disabled |
90+ | ` custominfo ` | ` Logger.info() ` / ` log.info() ` | Disabled |
91+ | ` customwarn ` | ` Logger.warn() ` / ` log.warn() ` | Always enabled |
92+ | ` customerror ` | ` Logger.error() ` / ` log.error() ` | Always enabled |
93+ | ` customfatal ` | ` log.fatal() ` | Always enabled |
94+
95+ ### Custom Named Log Files
96+
97+ Created with ` Logger.getLogger(prefix, category) ` :
98+ ```
99+ custom-<prefix>-<hostname>-appserver-<date>.log
100+ ```
101+
102+ Example: ` custom-orderexport-blade0-1-appserver-20240115.log `
103+
104+ ``` bash
105+ # list custom named log files
106+ b2c webdav ls --root=logs | grep " custom-orderexport"
107+
108+ # download a custom named log
109+ b2c webdav get custom-orderexport-blade0-1-appserver-20240115.log --root=logs
110+ ```
111+
112+ ### System Log File Types
113+
114+ | Log Type | Description |
115+ | ----------| -------------|
116+ | ` error ` | System errors in scripts, templates, platform |
117+ | ` warn ` | Lock status, slot warnings, servlet warnings |
118+ | ` info ` | System information |
119+ | ` debug ` | Debug information (when enabled) |
120+ | ` fatal ` | Critical system failures |
121+ | ` api ` | API problems and violations |
122+ | ` deprecation ` | Usage of deprecated APIs |
123+ | ` jobs ` | Job status information |
124+ | ` staging ` | Replication process information |
125+ | ` quota ` | Quota warnings and limit violations |
126+ | ` sql ` | SQL and replication issues |
127+ | ` syslog ` | API processing, staging, import/export |
128+ | ` sysevent ` | Appserver registration, cartridge logs |
129+
130+ ### Log Retention and Archives
131+
132+ | Location | Retention |
133+ | ----------| -----------|
134+ | ` /Logs/ ` | Current logs (< 3 days old) |
135+ | ` /Logs/log_archive/ ` | Compressed logs (3-30 days) |
136+ | Production/Staging | 30 days |
137+ | Security logs | 90 days |
138+
139+ ``` bash
140+ # list current logs
141+ b2c webdav ls --root=logs
142+
143+ # list archived (gzipped) logs
144+ b2c webdav ls log_archive --root=logs
145+
146+ # download archived log
147+ b2c webdav get log_archive/customerror-blade0-1-appserver-20240112.log.gz --root=logs
148+ ```
149+
150+ ### Security Logs
151+
152+ Security logs track authentication events:
153+
154+ ``` bash
155+ # list security logs
156+ b2c webdav ls --root=securitylogs
157+
158+ # download security log
159+ b2c webdav get security-blade0-1-20240115.log --root=securitylogs -o - | grep " LOGIN"
160+ ```
161+
162+ ### Import/Export Logs
163+
164+ Located in IMPEX root under ` /log/ ` :
165+
166+ ``` bash
167+ # list import/export logs
168+ b2c webdav ls log --root=impex
169+
170+ # download catalog import log
171+ b2c webdav get log/Catalog-Import-20240115.log --root=impex
172+ ```
173+
174+ ### Common Log Queries
175+
176+ ``` bash
177+ # find recent error logs
178+ b2c webdav ls --root=logs | grep customerror
179+
180+ # search for specific order in error log
181+ b2c webdav get customerror-blade0-1-appserver-20240115.log --root=logs -o - | grep " ORD12345"
182+
183+ # search for payment errors
184+ b2c webdav get customerror-blade0-1-appserver-20240115.log --root=logs -o - | grep -i " payment"
185+
186+ # check job failures
187+ b2c webdav get jobs-blade0-1-appserver-20240115.log --root=logs -o - | grep -i " failed"
188+
189+ # check quota warnings
190+ b2c webdav get quota-blade0-1-appserver-20240115.log --root=logs -o - | grep " exceeded"
191+
192+ # check deprecated API usage
193+ b2c webdav get deprecation-blade0-1-appserver-20240115.log --root=logs
67194```
68195
69196### Download Files
0 commit comments