Monitoring Google Cloud Run

CommonJS

Add the following lines to your Dockerfile anywhere after the last FROM clause:

COPY --from=icr.io/instana/google-cloud-run-nodejs:latest /instana /instana
RUN /instana/setup.sh
ENV NODE_OPTIONS="--require /instana/node_modules/@instana/google-cloud-run"

ECMAScript modules

Add the following lines to your Dockerfile anywhere after the last FROM clause:

• For Node.js 18.19.0 and later, add the following commands:

  COPY --from=icr.io/instana/google-cloud-run-nodejs:latest /instana /instana
  RUN /instana/setup.sh
  ENV NODE_OPTIONS="--import=/instana/node_modules/@instana/google-cloud-run/esm-register.mjs"
  

• For Node.js versions earlier to 18.19.0, add the following commands:

   COPY --from=icr.io/instana/google-cloud-run-nodejs:latest /instana /instana
   RUN /instana/setup.sh
   ENV NODE_OPTIONS="--experimental-loader=/instana/node_modules/@instana/google-cloud-run/esm-loader.mjs"
  

Build the container and push it to the image repository of your choice.

Finally, follow the configuration steps that are described in the section Configure Your Cloud Run Service.

Notes:

• If you are using Multi-stage builds (that is, if you have multiple FROM clauses in your Dockerfile), you need to add the following lines the last FROM clause of your Dockerfile.
• Auto-profile of Node.js processes running in Cloud Run is not supported.

Versioning

icr.io/instana/google-cloud-run-nodejs:latest uses the latest available image version, no matter what the current major version is. For example, if a new major version v4 is released and currently your image version is v3, the image will be automatically updated to v4 on the next rebuild if you use the tag ":latest".

If you don't want the image to be automatically updated to the latest available image version on the next rebuild, use a specific major version of the image like icr.io/instana/google-cloud-run-nodejs:2 (version 2) and manually update to the next major version.

• For more information, see Node.js Versioning.

Build dependencies and native add-ons

If you are using a rather minimal base image for your Node.js containers, which does not have the required packages to build native Node.js add-ons, you might see a warning like this in your Docker build:

gyp ERR! ...some error message from trying to rebuild native add-ons, for example:
gyp ERR! stack Error: Could not find any Python installation to use
...
Warning: Rebuilding native add-ons for @instana/google-cloud-run failed. Monitoring the Cloud Run service revision instance will work nonetheless, but you will miss some Node.js metrics (GC metrics, event loop metrics, ...). See https://www.instana.com/docs/ecosystem/google-cloud-run/#build-dependencies-and-native-add-ons for details.

As the log message implies, monitoring your Node.js Cloud Run service revision instance with Instana works. But certain metrics are missing. Instana recommends installing the missing operating system packages, at least temporarily, during the build. They do not need to be included in the final image. Which packages to install and how to install them depends on the distribution you are using.

See the following example Dockerfile snippet for Linux® Alpine:

COPY --from=icr.io/instana/google-cloud-run-nodejs:latest /instana /instana
RUN apk add --no-cache --virtual .gyp \
        build-base \
        python \
    && /instana/setup.sh \
    && apk del .gyp python
ENV NODE_OPTIONS="--require /instana/node_modules/@instana/google-cloud-run"

See the following example for Debian based distributions (including Ubuntu):

COPY --from=icr.io/instana/google-cloud-run-nodejs:latest /instana /instana
RUN apt-get update \
    && apt-get install build-essential \
    && /instana/setup.sh \
    && apt-get remove -y build-essential
ENV NODE_OPTIONS="--require /instana/node_modules/@instana/google-cloud-run"

For distributions that use yum (CentOS, RHEL, ...), the command to install the required packages would be:

RUN yum groupinstall "Development Tools"

Getting The Node.js Layer From containers.instana.io

If you also use Instana's Cloud Run support with other runtimes (like Java), for which the image layer is only available on the authenticated registry containers.instana.io, and you want to keep things consistent, you can also get the Node.js Instana Cloud Run image layer from containers.instana.io rather than the public IBM container registry, as an alternative to the approach outlined above.

Since the containers.instana.io registry requires authentication, you need to run the following command before you use it in your Docker build:

docker login -u _ -p <your-agent-key> containers.instana.io

The placeholder <your-agent-key> needs to be replaced with your actual Instana agent key. This needs to be done on the machine where you build your Docker image.

Add the following lines to your Dockerfile anywhere after the last FROM clause:

COPY --from=containers.instana.io/instana/release/google/cloud-run/nodejs:latest /instana /instana
RUN /instana/setup.sh
ENV NODE_OPTIONS="--require /instana/node_modules/@instana/google-cloud-run"