Overview

Static Analysis (SAST) is a clear-box software testing technique that analyzes a program’s pre-production code without the need to execute the program, meaning that the program is static because it isn’t running.

Static Analysis helps you identify maintainability issues and security vulnerabilities early in the software development life cycle (SDLC) to ensure only the highest quality, most secure code makes it to production. Static Analysis tools that scan for security vulnerabilities are also commonly referred to as Static Application Security Testing (SAST) tools.

Using Static Analysis provides organizations with the following benefits:

• Static Analysis takes the guesswork out of adhering to an organization’s code standards, enabling your development team to ship compliant code without significant impacts to developer velocity.
• An organization’s applications are less vulnerable to security breaches over time, due to new vulnerabilities being caught through SAST scans before code reaches production.
• New developers to an organization are able to onboard faster because Static Analysis enables an organization to maintain a more readable codebase over time.
• An organization’s software becomes reliable over time by virtue of the code being more maintainable because the risk of a developer introducing new defects to the code is minimized.

Set up Static Analysis

Static Analysis supports scanning for poor coding practices and security vulnerabilities in the following languages and technologies:

To get started, you can set up Static Analysis on the Code Analysis page or see the Setup documentation.

Integrate Static Analysis into your software development lifecycle

CI providers

Source code management

IDEs

Search and filter results

After you configure your CI pipelines to run the Datadog Static Analyzer, violations are summarized per repository on the Code Analysis Repositories page. Click on a repository to analyze Code Vulnerabilities and Code Quality results from Static Analysis.

• The Code Vulnerabilities tab contains the violations found by Datadog’s rules in the Security category.
• The Code Quality tab contains the violations found by Datadog’s rules in the Best Practices, Code Style, Error Prone, or Performance categories.

To filter your results, use the facets to the left of the list, or search. Results can be filtered by service or team facets. For more information about how results are linked to Datadog services and teams, see Getting Started with Code Analysis.

Every row represents a violation. Each violation is associated with the specific commit and branch that is selected in the filters at the top of the page (by default, results are shown for the latest commit on the default branch of the repository you are viewing).

Click on a violation to open a side panel that contains information about the scope of the violation and where it originated.

The content of the violation is shown in tabs:

• Details: A description of the violation and the lines of code that caused it. To see the offending code snippet, configure the Datadog GitHub App.
• Remediation: One or more code fixes that can resolve the violation, with options for remediation.
• Event: JSON metadata regarding the Static Analysis violation event.

Using suggested fixes

In Datadog Static Analysis, there are two types of suggested fixes:

1. Default Suggested Fix: For simple violations like linting issues, the rule analyzer automatically provides templated fixes.
2. AI Suggested Fix: For complex violations, fixes are typically not available beforehand. Instead, you can use AI Suggested Fixes, which use OpenAI’s GPT-4 to generate a suggested fix. You can choose between “Text” and “Unified Diff” fixes, which outputs plain text instructions or a code change for resolving the violation, respectively.

The two types of fixes are distinguished visually in the UI with different labels.

Default Suggested Fixes:

AI Suggested Fixes:

Fixing a vulnerability or quality issue directly from Datadog

You can push a code change to fix an issue found by Code Analysis directly from a result in Datadog in two ways.

Opening a pull request

If your GitHub app’s Pull Requests permission is set to Read & Write, one-click remediation is enabled for all Static Analysis findings with an available suggested fix. For more information about setting up the GitHub integration, see GitHub Pull Requests.

Follow these steps to fix a vulnerability and open a pull request:

1. View a specific result in Code Analysis.
2. Click Fix Violation in the side panel of the result.
3. Select Open a Pull Request.
4. Enter a pull request title and commit message.
5. Click Create PR.

Committing directly to the current branch

You can also fix a vulnerability by committing directly to the branch the result was found on.

To commit a suggested fix:

1. View a specific result in Code Analysis.
2. Click Fix Violation in the side panel of the result.
3. Click Commit to current branch.

Customizing your configuration

To customize which Static Analysis rules are configured in your repositories, see the Setup documentation.

Reporting false positives

If you believe a specific violation is a false positive, you can flag it as a false positive with a reason for flagging, which sends a report to Datadog. Submissions are reviewed on a regular basis to improve ruleset quality over time.

Further Reading

Más enlaces, artículos y documentación útiles:

Monitor all your CI pipelines with DatadogBLOG Learn about the Source Code IntegrationDOCUMENTATION