Setup App and API Protection for Java on macOS
For faster setup with automatic instrumentation, consider using Single Step APM Instrumentation, which automatically installs the Datadog SDK with no additional configuration required. See Single Step APM Instrumentation for setup instructions.
Once SSI is set up, you can enable App and API Protection by going to your APM service in the Datadog app → Service Configuration section → Enable Application Security Monitoring.
Overview
Datadog Application Security Management (ASM) provides App and API Protection (AAP) capabilities including:
- Application Security Monitoring: Real-time threat detection and protection against attacks like SQL injection, XSS, and more
- Software Composition Analysis (SCA): Identification of vulnerable dependencies in your codebase
- Interactive Application Security Testing (IAST): Runtime vulnerability detection during testing
ASM works by leveraging the Datadog Java tracing library to monitor HTTP requests, analyze patterns, and detect security threats in real-time. The library integrates seamlessly with your existing application without requiring code changes.
For detailed compatibility information, including supported Java versions, frameworks, and deployment environments, see Single Step Instrumentation Compatibility.
This guide explains how to set up App and API Protection (AAP) for Java applications running on macOS. The setup involves:
- Installing the Datadog Agent
- Configuring your Java application
- Enabling AAP monitoring
Prerequisites
- macOS operating system
- Java application
- Homebrew (recommended for Agent installation)
- Administrator privileges for some configuration steps
Setup
1. Install the Datadog Agent
Using Homebrew (recommended)
brew install datadog/datadog/datadog-agent
Manual installation
- Download the macOS installer from the Datadog Agent installation page
- Open the downloaded
.dmg
file - Follow the installation wizard
Library setup
To enable AAP capabilities, you need the Datadog Java tracing library (version 0.94.0 or higher) installed in your application environment.
Download the library
Download the latest version of the Datadog Java library:
curl -Lo dd-java-agent.jar 'https://dtdg.co/latest-java-tracer'
Verify compatibility
To check that your service’s language and framework versions are supported for AAP capabilities, see Single Step Instrumentation Compatibility.
Service configuration
Run your application with AAP enabled
Start your Java application with the Datadog agent and AAP enabled:
java -javaagent:/path/to/dd-java-agent.jar -Ddd.appsec.enabled=true -Ddd.service=<MY_SERVICE> -Ddd.env=<MY_ENV> -jar path/to/app.jar
If you want to use Application Security Management without APM tracing functionality, you can deploy with [Standalone App and API Protection][4]. This configuration reduces the amount of APM data sent to Datadog to the minimum required by App and API Protection products.
To enable standalone mode:
- Set
DD_APM_TRACING_ENABLED=false
environment variable - Keep
DD_APPSEC_ENABLED=true
environment variable - This configuration will minimize APM data while maintaining full security monitoring capabilities
java -javaagent:/path/to/dd-java-agent.jar -Ddd.appsec.enabled=true -Ddd.apm.tracing.enabled=false -Ddd.service=<MY_SERVICE> -Ddd.env=<MY_ENV> -jar path/to/app.jar
Important considerations:
- File system requirements: Read-only file systems are not currently supported. The application must have access to a writable
/tmp
directory. - Service identification: Always specify
DD_SERVICE
(or -Ddd.service
) and DD_ENV
(or -Ddd.env
) for proper service identification in Datadog.
Create or edit the Agent configuration file:
sudo nano /opt/datadog-agent/etc/datadog/datadog.yaml
Add the following configuration:
api_key: <YOUR_API_KEY>
site: <YOUR_DD_SITE>
apm_config:
enabled: true
logs_config:
enabled: true
Start the Agent:
sudo launchctl load -w /Library/LaunchDaemons/com.datadoghq.agent.plist
Set environment variables
Set the required environment variables in your shell:
export DD_APPSEC_ENABLED=true
export DD_SERVICE=<YOUR_SERVICE_NAME>
export DD_ENV=<YOUR_ENVIRONMENT>
For permanent environment variables, add them to your shell profile (e.g., ~/.zshrc
or ~/.bash_profile
):
echo 'export DD_APPSEC_ENABLED=true' >> ~/.zshrc
echo 'export DD_SERVICE=<YOUR_SERVICE_NAME>' >> ~/.zshrc
echo 'export DD_ENV=<YOUR_ENVIRONMENT>' >> ~/.zshrc
Verify setup
To verify that AAP is working correctly:
- Send some traffic to your application
- Check the Application Signals Explorer in Datadog
- Look for security signals and vulnerabilities
Troubleshooting
If you encounter issues while setting up App and API Protection for your Java application, see the Java App and API Protection troubleshooting guide.
Further Reading
Additional helpful documentation, links, and articles: