Google Cloud Run

Method 1: Direct Code Initialization

Add the following lines to the beginning of your application code base. The access token is your account key, which can be found on the Installation page.

index.js

Javascript

Your API Keys

const tracker = require('@middleware.io/node-apm');
tracker.track({
    serviceName: "your-service-name",
    accessToken: "<MW_API_KEY>",
    target: "https://<MW_UID>.middleware.io:443",
});
// must come before importing any other module.
// At the very top of the entrypoint
const express = require('express'); // other dependencies

Method 2: Add the tracker with command line arguments

Create a file named instrument.js or instrument.ts in your project root:

instrument.js

Javascript

Your API Keys

// instrument.js
const tracker = require('@middleware.io/node-apm');
tracker.track({
    serviceName: "your-service-name",
    accessToken: "<MW_API_KEY>",
    target: "https://<MW_UID>.middleware.io:443",
});

To ensure the tracker is initialized before any other code runs, use the --require flag when starting your Node.js application:

Shell

Javascript

node --require ./instrument.js your-main-app.js

Deploy your application to Google Cloud Run. The APM tracker will start automatically with the application.

Ensure your Dockerfile or deployment script installs the APM package and includes the correct entry point for initialization.

Add this environment variable to allow comprehensive collection of metadata about the application's runtime Environment Add ENV Variables and Deploy to Google Cloud Run

OTEL_NODE_RESOURCE_DETECTORS=all

In serverless environments like Google Cloud Run, you may encounter missing spans due to sudden instance termination. To mitigate this, you have two options:

OTEL_BSP_SCHEDULE_DELAY=500

const tracker = require('@middleware.io/node-apm');

// Initialize the tracker
tracker.track({
  // Your configuration options
});

// Handle application shutdown
process.on('SIGTERM', async () => {
  console.log('SIGTERM signal received. Shutting down gracefully');

If you need to add custom spans or attributes, you can follow the instructions found here