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:

  1. Installing the Datadog Agent
  2. Configuring your Java application
  3. 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

brew install datadog/datadog/datadog-agent

Manual installation

  1. Download the macOS installer from the Datadog Agent installation page
  2. Open the downloaded .dmg file
  3. 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:

    1. Set DD_APM_TRACING_ENABLED=false environment variable
    2. Keep DD_APPSEC_ENABLED=true environment variable
    3. 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.

    2. Configure the Datadog Agent

    1. Create or edit the Agent configuration file:

      sudo nano /opt/datadog-agent/etc/datadog/datadog.yaml

    2. Add the following configuration:

      api_key: <YOUR_API_KEY>
site: <YOUR_DD_SITE>
apm_config:
  enabled: true
logs_config:
  enabled: true

    3. Start the Agent:

      sudo launchctl load -w /Library/LaunchDaemons/com.datadoghq.agent.plist

    3. Configure your Java application

    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:

    1. Send some traffic to your application
    2. Check the Application Signals Explorer in Datadog
    3. 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

    추가 유용한 문서, 링크 및 기사:

    How App and API Protection WorksDOCUMENTATION more more OOTB App and API Protection RulesDOCUMENTATION more more Troubleshooting App and API ProtectionDOCUMENTATION more more
    PREVIEWING: sezen.leblay/aap-setup-page-java