Setup

1. Install the Datadog Java tracer.

   1. Add the Datadog Java tracer to your Dockerfile:

      Dockerfile

      Copy

      ADD 'https://dtdg.co/latest-java-tracer' agent.jar
      ENV JAVA_TOOL_OPTIONS="-javaagent:agent.jar"

   2. Add the tracer artifacts.

      Copy

      <dependency>
        <groupId>com.datadoghq</groupId>
        <artifactId>dd-trace-api</artifactId>
        <version>DD_TRACE_JAVA_VERSION_HERE</version>
      </dependency>

      Copy

      implementation 'com.datadoghq:dd-trace-api:DD_TRACE_JAVA_VERSION_HERE'

      See dd-trace-java releases for the latest tracer version.

   3. Add the @Trace annotation to any method you want to trace.

   For more information, see Tracing Java Applications.

2. Install serverless-init.

   Datadog publishes new releases of the serverless-init container image to Google’s gcr.io, AWS’s ECR, and on Docker Hub:

   hub.docker.com	gcr.io	public.ecr.aws
   datadog/serverless-init	gcr.io/datadoghq/serverless-init	public.ecr.aws/datadog/serverless-init

   Images are tagged based on semantic versioning, with each new version receiving three relevant tags:

   • 1, 1-alpine: use these to track the latest minor releases, without breaking changes
   • 1.x.x, 1.x.x-alpine: use these to pin to a precise version of the library
   • latest, latest-alpine: use these to follow the latest version release, which may include breaking changes

   Add the following instructions and arguments to your Dockerfile.

   COPY --from=datadog/serverless-init:1 /datadog-init /app/datadog-init
   ENTRYPOINT ["/app/datadog-init"]
   CMD ["./mvnw", "spring-boot:run"]
   

   Alternative configuration

   Datadog expects serverless-init to be the top-level application, with the rest of your app’s command line passed in for serverless-init to execute.

   If you already have an entrypoint defined inside your Dockerfile, you can instead modify the CMD argument.

   CMD ["/app/datadog-init", "./mvnw", "spring-boot:run"]
   

   If you require your entrypoint to be instrumented as well, you can instead swap your entrypoint and CMD arguments.

   ENTRYPOINT ["/app/datadog-init"]
   CMD ["/your_entrypoint.sh", "./mvnw", "spring-boot:run"]
   

   As long as your command to run is passed as an argument to datadog-init, you will receive full instrumentation.

   
   

3. Set up logs.

   To enable logging, set the environment variable DD_LOGS_ENABLED=true. This allows serverless-init to read logs from stdout and stderr.

   Datadog also recommends setting the environment variable DD_LOGS_INJECTION=true and DD_SOURCE=java to enable advanced Datadog log parsing.

   If you want multiline logs to be preserved in a single log message, Datadog recommends writing your logs in compact JSON format. For example, you can use a third-party logging library such as Log4j 2:

   Copy

   private static final Logger logger = LogManager.getLogger(App.class);
   logger.info("Hello World!");

   resources/log4j2.xml

   Copy

   <Configuration>
     <Appenders>
       <Console name="Console"><JsonLayout compact="true" eventEol="true" properties="true"/></Console>
     </Appenders>
     <Loggers><Root level="info"><AppenderRef ref="Console"/></Root></Loggers>
   </Configuration>

   For more information, see Correlating Java Logs and Traces.

4. Configure your application.

   After the container is built and pushed to your registry, set the required environment variables for the Datadog Agent:

   • DD_API_KEY: Your Datadog API key, used to send data to your Datadog account. For privacy and safety, configure this API key as a Google Cloud Secret.
   • DD_SITE: Your Datadog site. For example, datadoghq.com.

   For more environment variables, see the Environment variables section on this page.

   The following command deploys the service and allows any external connection to reach it. In this example, your service listening is set to port 8080. Ensure that this port number matches the exposed port inside of your Dockerfile.

   gcloud run deploy <APP_NAME>
     --image=gcr.io/<YOUR_PROJECT>/<APP_NAME> \
     --port=8080 \
     --update-env-vars=DD_API_KEY=$DD_API_KEY \
     --update-env-vars=DD_SITE=$DD_SITE \
   

5. Add a service label in Google Cloud. In your Cloud Run service’s info panel, add a label with the following key and value:

   Key	Value
   service	The name of your service. Matches the value provided as the DD_SERVICE environment variable.

   See Configure labels for services in the Cloud Run documentation for instructions.

6. Send custom metrics.

   To send custom metrics, install the DogStatsD client and view code examples. In serverless, only the distribution metric type is supported.

Environment variables

Troubleshooting

This integration depends on your runtime having a full SSL implementation. If you are using a slim image, you may need to add the following command to your Dockerfile to include certificates:

RUN apt-get update && apt-get install -y ca-certificates

To have your Cloud Run services appear in the software catalog, you must set the DD_SERVICE, DD_VERSION, and DD_ENV environment variables.

Further reading

お役に立つドキュメント、リンクや記事:

Tracing Java ApplicationsDOCUMENTATION Correlating Java Logs and TracesDOCUMENTATION