DiagnosisTool

Backgroud

When you want to get assistance from community or a Kylin expert, instead of sending he/her some screenshots which often contains partial information, sharing a diagnosis package maybe a better choice because almost everything which is important, including metadata, logs file, configuration files, yarn logs, hadoop components's version will collected in one click.

Diagnosis package

We divided diagnosis packages into two kind, General Diagnosis Package and Job Diagnosis Package.
`org.apache.kylin.tool.DiagnosisInfoCLI` is for get a General Diagnosis Package, and `org.apache.kylin.tool.JobDiagnosisInfoCLI` is for get a Job Diagnosis Package.
If you have any issue/failure when building a segment, please choose using the Job Diagnosis Package; otherwise, please choose the General Diagnosis Package.

Content

How to use

There are two ways to get a diagnosis package, Web UI or Command Line. Please check http://kylin.apache.org/blog/2016/06/10/diagnosis-tool/ if you cannot find the right place in web page.

If you want to choose Command Line way, here is some examples.

# If you want to collected basic information for all project 
sh bin/diag.sh org.apache.kylin.tool.DiagnosisInfoCLI -project -all \
    -destDir diag_all_info
# If you want to collected basic information for a specific project 
sh bin/diag.sh org.apache.kylin.tool.DiagnosisInfoCLI -project learn_kylin \
    -destDir diag_learn_kylin
# If you only want to collect related metadata, logs files and configuration files, you should choose this one.
sh bin/diag.sh org.apache.kylin.tool.DiagnosisInfoCLI -project learn_kylin \
     -destDir diag_learn_kylin_one_day \
-includeHBase false \
     -includeJobs false \
     -period 1
 
# If you want to find some building job failed but cannot find the cause, you may should try this.
sh bin/diag.sh org.apache.kylin.tool.JobDiagnosisInfoCLI \
    -jobId 35ebd64b-d56c-7236-6bb6-58d63160b49d \
    -destDir diag_job

Tips

1. When you click the button in Web UI to download a diagnosis package, and wait too much time and want find if there anything wrong, please check the log content in $KYLIN_HOME/logs/kylin.out (that is the std out). If you want to let the output print to other place, please consider modify $KYLIN_HOME/conf/kylin-tools-log4j.properties.
2. If you find difficult to download a diagnosis package from web page, or maybe you want do some custom filter to reduce the size of diagnosis package, please consider using the CLI way, it is somehow fexible.
3. By default, DiagnosisInfoCLI will only collected logs files of recent three days, if you need to change it please use period option.