...
Query API is not only concerned with persistence layer but a multipurpose tool which can be extended via extension point. Out of the box the following API extensions are supported:
| API | Version | Supported Nodes | Purpose | Example | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| SQL:Core | 3.0.0+ | ADM, API, SFx | SQL interface for core RDBMS |
| ||||||||
| HQL:Core | 3.0.0+ | ADM, API, SFx | Hibernate QL interface for core RDBMS |
| ||||||||
| HQL:Payment | 3.0.0+ | ADM | Hibernate QL interface for payment RDBMS |
| ||||||||
| IceCat:Product | 3.3.0+
| ADM | IceCat search interface to validate product XML |
| ||||||||
| FT:Product | 3.0.0+ | API,SFx | Lucene full text query interface |
|
In order to perform a query over desired medium:
...
SFG
| Label | ||||
|---|---|---|---|---|
|
...
| Code Block |
|---|
<appender name="DEFAULT" class="ch.qos.logback.classic.sift.SiftingAppender">
<!-- declare discriminator -->
<discriminator class="org.yes.cart.utils.log.ShopCodeAndLevelLogDiscriminator"/>
<sift>
<!-- shopCode can be use in appender name (e.g. view in JMX) -->
<appender name="DEFAULT-${shopCode}" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- shopCode can be use in file name -->
<File>${catalina.base}/logs/yc-${shopCode}.log</File>
<Append>true</Append>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %5p %c{1}:%L - %m%n</pattern>
</encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<maxIndex>10</maxIndex>
<FileNamePattern>${catalina.base}/logs/yc-${shopCode}.log.%i.zip</FileNamePattern>
</rollingPolicy>
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
</sift>
</appender> |
Out of the box logs
| Log file(s) | Sift | Level | Purpose |
|---|---|---|---|
| Storefront (API, SFx) | |||
| yc-${shopCode}.log | shop code + level | INFO | DEFAULT-${shopCode} appender (root) |
| yc-${shopCode}-pay.log | shop code | DEBUG | SHOPPAY appender, payment gateway related logging, packages:
|
| yc-orderexport.log | INFO | ORDEREXPORT appender, order export related logging, packages:
| |
| yc-orderstate.log | INFO | ORDERSTATE appender, order transition related logging, packages:
| |
| yc-mail.log | INFO | MAIL appender, email generation and send logging, packages:
| |
| yc-maildump.log | INFO | MAILDUMP appender, log full content of email that was sent | |
| yc-audit.csv | INFO | AUDIT appender, log persistence updates audit records Change to TRACE to enable audit logging | |
| yc-${shopCode}-ftq.log | shop code | INFO | FTQ-${shopCode} appender, logs all full text queries Change to DEBUG to enable query logging Change to TRACE to enable query explanations logging |
| yc-ws.log | ERROR | WS appender, logs web services communication (WS.IN and WS.OUT) Change to INFO to enable logging | |
| yc-config.log | INFO | CONFIG appender, logs information on loaded modules and extension points Change to DEBUG to enable logging | |
| yc-${shopCode}-sac.log | shop code | DEBUG | SAC (Security access control) appender, logs access violations |
| Admin (ADM) | |||
| yc-${shopCode}.log | shop code + level | INFO | DEFAULT-${shopCode} appender (root) |
| yc-${shopCode}-pay.log | shop code | DEBUG | SHOPPAY appender, payment gateway related logging, packages:
|
| yc-${shopCode}-job.log | shop code + level | INFO | JOB-${shopCode} appender, logs all tasks executions, packages:
|
| yc-${shopCode}-import.log | shop code + level | INFO | BULKIMPORT-${shopCode} appender, logs all data imports, packages:
|
| yc-remote.log | INFO | REMOTE (file upload/download/move/delete operations) appender, logs all data imports, packages:
| |
| yc-orderexport.log | INFO | ORDEREXPORT appender, order export related logging, packages:
| |
| yc-orderstate.log | INFO | ORDERSTATE appender, order transition related logging, packages:
| |
| yc-mail.log | INFO | MAIL appender, email generation and send logging, packages:
| |
| yc-maildump.log | INFO | MAILDUMP appender, log full content of email that was sent | |
| yc-audit.csv | INFO | AUDIT appender, log persistence updates audit records Change to TRACE to enable audit logging | |
| yc-ws.log | ERROR | WS appender, logs web services communication (WS.IN and WS.OUT) Change to INFO to enable logging | |
| yc-config.log | INFO | CONFIG appender, logs information on loaded modules and extension points Change to DEBUG to enable logging | |
| yc-${shopCode}-sac.log | shop code | DEBUG | SAC (Security access control) appender, logs access violations |
| yc-security.log | INFO | SECURITY (Spring) appender, packages:
|