Remote environment data

With code tiles (in Dashboards) and code sections (in Notebooks), you can consolidate data from multiple Dynatrace environments.

There are two authentication mechanisms available for fetching data from remote environments:

Platform token authentication
OAuth client authentication

Platform token authentication

The example JavaScript code described below uses the credential vault for secure token storage, and a platform token for authentication, to offer a robust and secure way to fetch data from a remote Dynatrace environment.

Prerequisites

Before you create the code for your dashboard tile or notebook section:

Create a Dynatrace platform token on the environment you want to fetch the data from. For details, see Platform tokens.
Create a Dynatrace credential vault entry on the primary environment to store the platform token that is later used in the code tile or section for authentication. For details, see Credential vault.
Add any remote environment you want to fetch data from to the allowlist in Limit outbound connections on your primary environment.
1. Go to new Settings and select Connections > Limit outbound connections. This opens the Settings Classic page.
2. Select Add item and add the domain of your Dynatrace environment. For example, myenv8132.apps.dynatrace.com, in case you want to allow one environment at a time, or use a wildcard like *.apps.dynatrace.com to allow all your Dynatrace environments at once.
3. Save your changes.

For more about allowlisting, see Allow IP ranges that can access your environment

Code

Before you start coding, review how the functions are used.

async function()

This is the main function. It calls fetchFromDynatrace (see above) with the necessary parameters.
fetchFromDynatrace(credentialId = "", url = "", query = "")

To fetch data from Dynatrace, this function:
1. Retrieves the credentials from the credential vault entry on the primary tenant based on the given credentialId.
2. Makes the API call on the APIs of the secondary/remote tenant based on the credentials as well as the url and query parameter provided by the main function.

Now that you have completed the prerequisites and reviewed the functions, you're ready to code.

Base your code on the example below.
Read the comments in the code example for code details.
Replace CREDENTIALS_VAULT-XXXXXXXXXXXXXXXX with your own credential ID.
Replace https://remote-environment-id.apps.dynatrace.com/platform/storage/query/v1/query:execute?enrich:metric-metadata with your own URL.
Customize the "fetch logs | limit 1" query according to your needs.
Run your code in a code tile (Dashboards) or code section (Notebooks).

If you encounter errors when you run your code, they will be caught and logged with the prefixes [DynatraceAuthError], [CredentialVaultError], or [ExecutionError] for easier debugging.

import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";

/**
 * Execute a query against a Dynatrace API with token retrieval inlined.
 * @param {string} credentialId - The ID of the credential vault entry.
 * @param {string} url - The API endpoint URL.
 * @param {string} query - The query to execute.
 * @returns {Promise<any>} - The API response data.
 * @throws Will throw an error if any step fails.
 */
async function fetchFromDynatrace(credentialId, url, query) {
  if (!credentialId || !url || !query) {
    throw new Error("[ValidationError] Missing required parameters: credentialId, url, or query.");
  }

  try {
    // Retrieve the platform token from the credential vault.
    const { token } = await credentialVaultClient.getCredentialsDetails({
      id: credentialId,
    }).catch((error) => {
      console.error(`[CredentialVaultError] Failed to retrieve token: ${error.message}`);
      throw new Error("Unable to fetch platform token.");
    });

    if (!token) {
      throw new Error("[CredentialVaultError] Token is undefined or empty.");
    }

    // Perform the API request.
    const response = await fetch(url, {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        Accept: "application/json",
        Authorization: `Bearer ${token}`,
      },
      body: JSON.stringify({
        query,
        requestTimeoutMilliseconds: 60000,
        enablePreview: true,
      }),
    });

    if (!response.ok) {
      throw new Error(`[HTTPError] API call failed with status ${response.status}: ${response.statusText}`);
    }

    return await response.json();
  } catch (error) {
    console.error(`[FetchError] Query execution failed: ${error.message}`);
    throw new Error("Unable to execute query.");
  }
}

/**
 * Main function to fetch and return results from Dynatrace.
 * @returns {Promise<any>} - The query result.
 */
export default async function() {
  const credentialId = "CREDENTIALS_VAULT-XXXXXXXXXXXXXXXX"; // Replace with your credential vault ID.
  const url = "https://remote-environment-id.apps.dynatrace.com/platform/storage/query/v1/query:execute"; // Replace with API URL.
  const query = "fetch logs | limit 1"; // Replace with your query.

  try {
    const { result } = await fetchFromDynatrace(credentialId, url, query);
    return result;
  } catch (error) {
    console.error(`[MainFunctionError] ${error.message}`);
    return null; // Or handle as needed.
  }
}

OAuth client authentication

The example JavaScript code described below uses the credential vault for secure token storage, and OAuth for authentication, to offer a robust and secure way to fetch data from a remote Dynatrace environment.