Dynatrace

Learn how to integrate Dynatrace backend logs with OpenReplay session replays to extend your monitoring and debugging capabilities.

This integration is available for Cloud (Serverless, Dedicated), and Self-Host (Community, Enterprise) users.

Follow these steps to obtain the necessary credentials from Dynatrace:

1. Log in to your Dynatrace account.
2. Navigate to Account Management
3. Create an OAuth Client:

• Click on Identity & Access Management
• Select OAuth clients
• Click on Create client to generate the required credentials.

4. Save your credentials:

• After creating the client, save the following:
  • Client ID
  • Client Secret
  • Account URN

5. Obtain your environment ID:

   // Example
   Dynatrace URL: https://rzr85764.app.dynatrace.com/
   Environment ID: rzr85764

To link Dynatrace logs with OpenReplay sessions, a unique session ID openReplaySession.id has to be propagated from your frontend to your backend on each request you want to track.

Modify your frontend code to add the openReplaySession.id to the headers of your API requests:

// JavaScript Example for for Single Page Applications (SPA):

// Import OpenReplay
import OpenReplay from '@openreplay/tracker';

// Initialize the tracker
const tracker = new OpenReplay({
  projectKey: 'YOUR_PROJECT_KEY',
});

// Start the tracker and wait for it to resolve
tracker.start().then(() => {
  // Get the session ID after the tracker has started
  const sessionId = tracker.getSessionID();

  const headers = {
    'Content-Type': 'application/json',
  };

// Get the session ID
const sessionId = tracker.getSessionID();

const headers = {
  'Content-Type': 'application/json',
};

if (sessionId) {
  headers['openReplaySession.id'] = sessionId;
}

// Make the API request
fetch('/api/endpoint', {
  method: 'GET', // or 'POST', etc.
  headers,
  // ...other options
})
  .then(response => {
    // Handle response
  })
  .catch(error => {
    // Handle error
  });

In your backend application, extract the openReplaySession.id from incoming requests and include it in your logs using the specific key-value format openReplaySession.id=<sessionId>:

//  Example.....
// Middleware to extract the session ID
app.use((req, res, next) => {
  const sessionId = req.headers['openreplaysession.id'];
  req.sessionId = sessionId; // Attach to request object
  next();
});

// When logging events or errors
app.get('/api/endpoint', (req, res) => {
  // Your logic here

  // Log with the session ID in the required format
  console.log(`openReplaySession.id=${req.sessionId} - Endpoint accessed`);

  res.send('Success');
});

// Error handling middleware
app.use((err, req, res, next) => {
  console.error(`openReplaySession.id=${req.sessionId} - Error: ${err.message}`);
  res.status(500).send('Internal Server Error');
});

By including the openReplaySession.id in your backend logs, Dynatrace can collect logs associated with specific OpenReplay sessions. This enables you to view these logs during session replays in OpenReplay, providing a complete picture of user interactions and backend logs.

Create a custom log attribute in Dynatrace to extract the openReplaySession.id from your logs.

1. Access your Dynatrace SaaS account.
2. Go to Settings.
3. Select Log Monitoring > Custom attributes and then select Add custom attribute.
4. Enter the Key openReplaySession.id.

Reference: See the detailed steps in Dynatrace docs: Log custom attributes.

In your OpenReplay account, follow these 3 steps to complete the session replays correlations with Dynatrace backend logs.

1. Go to Preferences > Integrations in OpenReplay.
2. Select the Backend Logging tab.
3. Select the project to which you want to enable the Dynatrace integration: Locate the Dynatrace integration card > Click on it.

In the Dynatrace integration sidebar enter:

1. Environment ID: Your Dynatrace environment ID for external access.
2. Client ID and Client Secret: Saved from the first step.
3. Dynatrace Account URN: Your unique identifier used within the Dynatrace platform, also saved from the first step.

1. Click on Add to test the connection: A success message will confirm the integration is set up correctly.

1. Navigate to Sessions in OpenReplay.
2. Open any session replay.
3. Click on the Traces button.
4. Dynatrace logs related to the session will be displayed.
5. Click on any log entry to view detailed information.

Logs of types LOG with statuses WARN, ERROR, INFO, and NONE are retrieved using the Dynatrace Log Monitoring API v2.

If you encounter any issues, connect to our Slack or check out our Forum and get help from our community.