# Application Arguments
This table provides an overview of the configuration options for the yCrash application. These settings control various aspects of the application’s behavior, such as file storage, administrator credentials, and the loading of troubleshooting reports. All properties should be configured in the launch-yc-server.sh or launch-yc-server.bat file, depending on your environment.
| Argument | Description | Default |
|---|---|---|
| logLevel | By default, yCrash logs messages at the ERROR level in the yc.log file. To enable INFO-level logs for debugging, configure -DlogLevel=info. Note: This property was introduced in yCrash version 3.0.9 | error |
| logOutput | By default, yCrash writes logs to the yc.log file. To redirect all logs to the stdout/console instead of a file, configure -DlogOutput=CONSOLE. | FILE |
| maskYCLogs | To enable masking of sensitive fields such as IP addresses and S3 bucket names in logs, set the system property -DmaskYCLogs=true. Masking will only be applied when this property is explicitly set to true. If the property is not defined or set to any value other than true, masking remains disabled. By default, this property is false to avoid unintended data confusing. Note: This property was introduced in yCrash version 3.0.9 | false |
| sanitizeHD | Your heap dump files may contain sensitive information such as credit card details, passwords, and other personally identifiable information (PII). When analyzing heap dumps using traditional tools, this sensitive data can be exposed in the heap report. To mask the sensitive data, you can configure -DsanitizeHD=true system property in yCrash. To learn more about this feature, visit Heap Dump Sanitization page. | false |
| coolingPeriod | M3 in yCrash is a feature for predicting application outages, capturing troubleshooting data, and generating root cause analysis reports. To prevent frequent alerts for the same issue, a cooling period (default 24 hours) is applied. This period can be customized using the coolingPeriod parameter in the server launch script, with supported time units including days, hours, minutes, and seconds. For instance, setting a 6-hours cooling period involves passing system property -DcoolingPeriod=6hrs. For more details refer here. | 24hrs |
| showGCReadyObjects | By default, the heap report displays only reachable objects (those currently in use). To include unreachable objects (i.e. object ready for garbage collection) in the analysis, you can utilize the showGCReadyObjects system property. When this property is enabled, the report will also include objects that are no longer needed by the application because they aren't referenced by any active part of the program, offering a more detailed view of the heap's state. To activate this feature, pass the -DshowGCReadyObjects=true property. | false |
| appURLPrefix | yCrash allows users to generate shareable report URLs that can be customized to match your enterprise's domain. To set this up, add the system property
appURLPrefix in the server launch script. For instance, to generate a URL with the domain "ycrash.mycompany.com," you would pass the system property -DappURLPrefix=https://ycrash.mycompany.com. For more details, refer here. | false |
| supportEmail | The yCrash application allows you to customize the support email address displayed on error pages and in other places by passing the supportEmail system property in the server launch script. For example, to set a support email address to "help@xyz.com," you would pass the system property -DsupportEmail=help@xyz.com. For more details, refer here. | false |
| headLine | The headline feature enables Enterprise Edition administrators to display important announcements to users in the dashboard, such as maintenance notices or new feature updates. To enable this flash message, pass the headLine system property in the server launch script. For example, if you want to announce to your team, that tool will be under maintanence, then you can pass the system property as -DheadLine="Tool will be unavailable from 9 am to 10 am on Aug 14 for maintenance purposes" For more details, refer here. | false |
| adminPassword | To access sensitive features in the yCrash application, such as deleting reports or restricting resource access, you must set up an Administrator Password to ensure that only authorized users can access these functions. To implement this, pass the adminPassword in the server launch script. For example, to set the admin password to 't@pSecrete' you can pass the system property as -DadminPassword=t@pSecrete. For more details, refer here. | false |
| downloadDumps | The 'Download Dumps' feature allows users to download all artifacts captured by the yc-360 script, including GC, thread, heap dumps, and system statistics like top, netstat, and vmstat. You can utilize the downloadDumps property to download all artifacts. To activate this feature, pass the -DdownloadDumps=true property in the server launch script. For more details, refer here. | false |
| hdParallelParsing | The heap dump analysis report includes two sections: the Troubleshooting Report and the Performance Report. By default, these are processed sequentially, but you can enable parallel processing to analyze both sections simultaneously, though it will require more memory. You can utilize the hdParallelParsing property to enable parallel processing. To activate this feature, pass the -DhdParallelParsing=true property in the server launch script. For more details, refer here. | false |
| onlyTroubleshootingReport | In heap dump analysis, the heap report consists of two sections: the Troubleshooting Report and the Performance Report. The Troubleshooting Report for diagnosing issues like memory leaks and the Performance Report for optimization insights. By default, to focus exclusively on the Troubleshooting Report, we have configured the tool using the onlyTroubleshootingReport property to process and display just that section. This feature is activated by the -DonlyTroubleshootingReport=true property in the server launch script. For more details, refer here. | true |
| onlyPerformanceReport | In heap dump analysis, the heap report consists of two sections: the Troubleshooting Report and the Performance Report. The Troubleshooting Report for diagnosing issues like memory leaks and the Performance Report for optimization insights. If your main focus is on performance, you can configure the tool to display only the Performance Report, streamlining your analysis to that section alone. To view only the Performance Report section, enable the onlyPerformanceReport property in the server launch script. To activate this feature, pass the -DonlyPerformanceReport=true property in the server launch script. For more details, refer here. | false |
| maskData | Heap dumps can contain confidential information such as passwords, API keys, database credentials, and other sensitive data essential for your application's functionality. To mitigate the risk of exposing this information, our application introduces the "Mask Data" feature, which secures sensitive content in heap reports by replacing it with masked placeholders. You can utilize the maskData property to mask the sensitive data in heap report. For example, to mask 80% of data, you can pass the system property as -DmaskData=80% property in the server launch script. For more details, refer here. | false |
| uploadDir | The yCrash server stores all captured artifacts in the same directory in which yCrash has been installed. You can specify the upload directory path using the uploadDir system property in the launch server script. For example, to store all artifacts in the /opt/ycrash-uploads directory, you would pass the system property as
-DuploadDir=/opt/ycrash-uploads. | true |
| logDir | By default, yCrash tool stores all its logs in the same directory in which it has been installed. You can specify the path where you want to store the logs using the logDir system property in the launch server script. For example, to store logs in the /opt/ycrash/logs folder, set the property as -DlogDir=/opt/ycrash/logs. | true |
There are a few additional property available to control M3 functionality. To understand them in detail and configure them appropriately, please refer here.