Static Code Search report

The Static Code Search Report enables users to analyze Spark applications over a specified time range by extracting program-related metadata. This report helps understand application behavior and debugging issues and optimizes Spark workloads.

Key features

Application Metadata Analysis: Extracts key program details such as application ID, user, queue, and cluster information.
Code Inspection: Displays Spark application code, allowing users to review logic, identify inefficiencies, and detect optimization opportunities.
Execution Status Tracking: Monitors job execution states, including start time, finish time, and final status.
Cluster Utilization Overview: Identifies which clusters applications ran on, helping in resource planning and troubleshooting.

Generating a new report

The following are the fields required to generate a Satic Code Search report:

Report Name: Name assigned to the report for identification.
Retention Period (Mandatory): Defines how long the report is retained before deletion.
Lookback Period (Mandatory): Specifies the historical timeframe to analyze.
Search String (Optional): Filters program records based on a keyword or pattern.
Email ID (Optional): Specifies recipients for automated email notifications.

For details on the other fields, refer to the following section:

Generating reports

Click Generate Reports > New button.

In the New Report dialog box, enter the following details.

Items	Description
General
Name	Name of the report.
Environment	Select your platform. The reports corresponding to the selected platform are only listed in the Report type. If you select the All option, all the reports are listed.
Report type	Type of report. Select the report
Schedule	Select the checkbox to schedule the report to run daily, hourly, weekly, or monthly. You can also set the schedule can using a cron expression. You can expand the Example drop-down and select the corresponding options. The next four sample run times are displayed for reference.
Retention	The number of days to retain the report files. All the reports are stored in the `unity-one/src/assets/reports/jobs` directory. After completion of the retention period, the report files are automatically purged.
Parameters
Application kind	Select the type of application.
Baseline / Target Specify the following details for comparing the base pipeline and the target pipeline.
Look Back	The period ranges in days when applications can be selected for report generation. A notification is displayed above this option that informs about the duration when data is available for the report.
Use Exact Date-Time	Check this option and select the from and to dates to schedule the report for the specified time range. The only anomaly with this option is that the same report will be scheduled to be generated repeatedly.
Users	Select the users who must be included in the report. You can select multiple users. To select all users, you can leave the field blank.
Queues	Select the queues that you want to be included in the report. You can select multiple queues. To select all queues, you can leave the field blank.
Clusters	Select the clusters that you want to be included in the report. You can select multiple clusters. To select all clusters, you can leave the field blank.
Features Filter	Specify the Key-Value pair. You can add or remove a pair.
Notifications
Email to	Email ID to send the notification when the report is generated. You can specify multiple email IDs with comma separation. You can also select the Attach Files to Email checkbox to receive the reports as an attachment.
Advance Options
Profile Memory	Select this option if you want to generate logs that help to troubleshoot scenarios where the report takes excessive time to generate or fails to generate. Caution The option will increase the report run time excessively.

Click OK. The generated reports will be listed under Reports on the App UI.
Select the generated report and then click Run. After the report is successfully run, the details of the report runs are listed in the Run box on the right.
Click the following:
- HTML files link to view the report details.
- Input parameters link to view the parameters you chose to run the report.
- Log file link to view the logs of the report.

Using the report

The Static Code Search Report provides an in-depth analysis of Spark applications, helping users optimize execution patterns, troubleshoot issues, and enhance performance. By leveraging metadata insights, code visibility, and execution tracking, this report is a valuable tool for monitoring and improving Spark workloads.

The report presents Spark application details in a structured format with the following fields:

App ID: Unique identifier for the Spark application.
User: Name of the user who executed the application.
Name: Name assigned to the Spark application.
Queue: The queue in which the application was executed.
Final Status: Indicates whether the application completed successfully or failed.
Cluster ID: Identifier of the cluster where the application was executed.
Started Time: Timestamp marking when the application started.
Finished Time: Timestamp marking when the application ended.
Program: The actual Spark program executed, including its logic and configurations.

In this section:

Home