Dynatrace

https://docs.dynatrace.com/docs
Admin
Dynatrace is a unified observability platform providing AI-powered monitoring for applications,...
Tokens:7,549,045
Snippets:57,450
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Custom SSL certificate installation command example

Source: https://docs.dynatrace.com/docs/ingest-from/dynatrace-activegate/installation/windows/windows-customize-installation-for-activegate

Example command for installing ActiveGate with a custom SSL certificate and its password file.

```plaintext
c:\Dynatrace-ActiveGate-Windows-x86-<version>.exe CERTIFICATE_FILE=D:\Users\Fred\myCert.p12 CERTIFICATE_PASSWORD_FILE=D:\Users\Fred\myPwd.txt
```

--------------------------------

### Example INSTALL parameter for mount point constraints

Source: https://docs.dynatrace.com/docs/ingest-from/dynatrace-activegate/installation/linux/linux-customize-installation-for-activegate

Example `INSTALL` parameter used to illustrate mount point constraints. The installer creates a `gateway` subdirectory under this path, so the mount point `/opt/MyActiveGate` is valid but `/opt/MyActiveGate/gateway` is invalid.

```plaintext
INSTALL=/opt/MyActiveGate
```

--------------------------------

### CA certificate installation command example

Source: https://docs.dynatrace.com/docs/ingest-from/dynatrace-activegate/installation/windows/windows-customize-installation-for-activegate

Example command for installing ActiveGate with a custom CA certificate and its password file.

```plaintext
C:\Dynatrace-ActiveGate-Windows-x86-<version>.exe CA_CERTIFICATE_FILE=D:\Users\Fred\myCert.jks CA_CERTIFICATE_PASSWORD_FILE=D:\Users\Fred\myPwd.txt
```

--------------------------------

### Sample Dockerfile for Java on Cloud Run with OneAgent

Source: https://docs.dynatrace.com/docs/ingest-from/google-cloud-platform/gcp-integrations/cloudrun

A complete Dockerfile example adapted from Google's Getting Started guide for Cloud Run with Java, including the OneAgent installation. Uses multi-stage build with Maven and OpenJDK. Placeholders must be substituted.

```dockerfile
# Use the official maven/Java 11 image to create a build artifact.
# https://hub.docker.com/_/maven
FROM maven:3-jdk-11-slim AS build-env


# Set the working directory to /app
WORKDIR /app
# Copy the pom.xml file to download dependencies
COPY pom.xml .
# Copy local code to the container image.
COPY src ./src


# Download dependencies and build a release artifact.
RUN mvn package -DskipTests


# Use OpenJDK for base image.
# https://hub.docker.com/_/openjdk
# https://docs.docker.com/develop/develop-images/multistage-build/#use-multi-stage-builds
FROM openjdk:11-jre-slim


# Copy the jar to the production image from the builder stage.
COPY --from=build-env /app/target/hello-world-*.jar /hello-world.jar


# Get and enable Dynatrace
ARG DT_API_URL="<DT_ENV_FQDN>/api"
ARG DT_API_TOKEN="<DT_TOKEN>"
ARG DT_ONEAGENT_OPTIONS="flavor=default&include=java"
ENV DT_HOME="/opt/dynatrace/oneagent"
RUN apt-get update && \
    apt-get install -y wget && \
    apt-get install unzip && \
    mkdir -p "$DT_HOME" && \
    wget -O "$DT_HOME/oneagent.zip" "$DT_API_URL/v1/deployment/installer/agent/unix/paas/latest?Api-Token=$DT_API_TOKEN&$DT_ONEAGENT_OPTIONS" && \
    unzip -d "$DT_HOME" "$DT_HOME/oneagent.zip" && \
    rm "$DT_HOME/oneagent.zip"
ENV LD_PRELOAD /opt/dynatrace/oneagent/agent/lib64/liboneagentproc.so
# Run the web service on container startup.
ENTRYPOINT ["java", "-jar", "/hello-world.jar"]
```

--------------------------------

### Install dependencies for Microsoft Agent Framework example

Source: https://docs.dynatrace.com/docs/observe/dynatrace-for-ai-observability/integrations/microsoft-agent-framework

Create a virtual environment and install the required packages for the Microsoft Agent Framework example. The packages include agent-framework, agent-framework-openai, opentelemetry-sdk, opentelemetry-exporter-otlp-proto-http, and python-dotenv.

```bash
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

```

--------------------------------

### Get PostgreSQL databases and instances

Source: https://docs.dynatrace.com/docs/semantic-dictionary/model/smartscape/db/postgres

Gets databases and corresponding instances by filtering runs_on edges between DB_DATABASE_POSTGRES and DB_INSTANCE_POSTGRES entities.

```dql
smartscapeEdges "runs_on"
| filter matchesValue(source_type, "DB_DATABASE_POSTGRES") and matchesValue(target_type, "DB_INSTANCE_POSTGRES")
| fields database_name=getNodeName(source_id), instance_name=getNodeName(target_id)
```

--------------------------------

### Get SQL Server databases and instances

Source: https://docs.dynatrace.com/docs/semantic-dictionary/model/smartscape/db/mssql

Gets databases and their corresponding instances by filtering runs_on edges between DB_DATABASE_MSSQL and DB_INSTANCE_MSSQL entities. Returns database and instance names.

```DQL
smartscapeEdges "runs_on"
| filter matchesValue(source_type, "DB_DATABASE_MSSQL") and matchesValue(target_type, "DB_INSTANCE_MSSQL")
| fields database_name=getNodeName(source_id), instance_name=getNodeName(target_id)

```

--------------------------------

### GET /api/v2/settings/objects?schemaIds=builtin:failure-detection.environment.rules&scopes=environment

Source: https://docs.dynatrace.com/docs/shortlink/service-failure-detection

Fetches all currently defined failure detection rules.

```APIDOC
## GET /api/v2/settings/objects?schemaIds=builtin:failure-detection.environment.rules&scopes=environment

### Description
Fetches all currently defined failure detection rules.

### Method
GET

### Endpoint
/api/v2/settings/objects?schemaIds=builtin:failure-detection.environment.rules&scopes=environment

### Parameters
#### Query Parameters
- **schemaIds** (string) - Required - The schema ID for failure detection rules.
- **scopes** (string) - Required - The scope of the rules (e.g., environment).

### Response
#### Success Response (200)
- **items** (array) - List of settings objects.

#### Response Example
{
  "items": [
    {
      "objectId": "string",
      "schemaId": "builtin:failure-detection.environment.rules",
      "scope": "environment",
      "value": {}
    }
  ]
}
```

--------------------------------

### Get Oracle databases and instances with smartscapeEdges

Source: https://docs.dynatrace.com/docs/semantic-dictionary/model/smartscape/db/oracle

Gets databases and corresponding instances by filtering runs_on edges between Oracle Database and Oracle Instance entities, then extracting names.

```dql
smartscapeEdges "runs_on"
| filter matchesValue(source_type, "DB_DATABASE_ORACLE") and matchesValue(target_type, "DB_INSTANCE_ORACLE")
| fields database_name=getNodeName(source_id), instance_name=getNodeName(target_id)
```

--------------------------------

### Get MySQL databases and instances with smartscapeEdges

Source: https://docs.dynatrace.com/docs/semantic-dictionary/model/smartscape/db/mysql

Gets databases and their corresponding instances by filtering edges of type runs_on between DB_DATABASE_MYSQL and DB_INSTANCE_MYSQL. Returns database and instance names using getNodeName.

```DQL
smartscapeEdges "runs_on"
| filter matchesValue(source_type, "DB_DATABASE_MYSQL") and matchesValue(target_type, "DB_INSTANCE_MYSQL")
| fields database_name=getNodeName(source_id), instance_name=getNodeName(target_id)
```

--------------------------------

### React Navigation setup with Drawer and Stack navigators

Source: https://docs.dynatrace.com/docs/observe/digital-experience/rum/mobile-frontends/react-native/id-05-app-performance

Example setup using @react-navigation/native, @react-navigation/drawer, and @react-navigation/stack. Shows how view contexts are generated based on navigation state, e.g., /Home, /Home/ScreenOne, /Feature/ScreenTwo.

```javascript
import { NavigationContainer } from '@react-navigation/native';
import { createDrawerNavigator } from '@react-navigation/drawer';
import { createStackNavigator } from '@react-navigation/stack';


const Drawer = createDrawerNavigator();


function App() {
  return (
    <NavigationContainer>
      <Drawer.Navigator initialRouteName="Home">
        <Drawer.Screen name="Home" component={HomeScreen} />
        <Drawer.Screen name="Feature" component={FeatureScreen} />
      </Drawer.Navigator>
    </NavigationContainer>
  );
}


const Stack = createStackNavigator();


function FeatureScreen() {
  return (
    <Stack.Navigator>
      <Stack.Screen name="ScreenOne" component={ScreenOne} />
      <Stack.Screen name="ScreenTwo" component={ScreenTwo} />
    </Stack.Navigator>
  );
}
```

--------------------------------

### Sample Dockerfile for Cloud Run with Java and Dynatrace

Source: https://docs.dynatrace.com/docs/ingest-from/google-cloud-platform/gcp-integrations/cloudrun

Sample Dockerfile from Google's Getting Started guide for Cloud Run with Java, adapted with the Dynatrace OneAgent installer instructions. It builds a Java 11 application and enables Dynatrace monitoring.

```dockerfile
# Use the official maven/Java 11 image to create a build artifact.
# https://hub.docker.com/_/maven
FROM maven:3-jdk-11-slim AS build-env


# Set the working directory to /app
WORKDIR /app
# Copy the pom.xml file to download dependencies
COPY pom.xml .
# Copy local code to the container image.
COPY src ./src


# Download dependencies and build a release artifact.
RUN mvn package -DskipTests


# Use OpenJDK for base image.
# https://hub.docker.com/_/openjdk
# https://docs.docker.com/develop/develop-images/multistage-build/#use-multi-stage-builds
FROM openjdk:11-jre-slim


# Copy the jar to the production image from the builder stage.
COPY --from=build-env /app/target/hello-world-*.jar /hello-world.jar


# Get and enable Dynatrace
ARG DT_API_URL="<DT_ENV_FQDN>/api"
ARG DT_API_TOKEN="<DT_TOKEN>"
ARG DT_ONEAGENT_OPTIONS="flavor=default&include=java"
ENV DT_HOME="/opt/dynatrace/oneagent"
RUN apt-get update && \
    apt-get install -y wget && \
    apt-get install unzip && \
    mkdir -p "$DT_HOME" && \
    wget -O "$DT_HOME/oneagent.zip" "$DT_API_URL/v1/deployment/installer/agent/unix/paas/latest?Api-Token=$DT_API_TOKEN&$DT_ONEAGENT_OPTIONS" && \
    unzip -d "$DT_HOME" "$DT_HOME/oneagent.zip" && \
    rm "$DT_HOME/oneagent.zip"
ENV LD_PRELOAD /opt/dynatrace/oneagent/agent/lib64/liboneagentproc.so


# Run the web service on container startup.
ENTRYPOINT ["java", "-jar", "/hello-world.jar"]
```

--------------------------------

### Get ActiveGate version example

Source: https://docs.dynatrace.com/docs/ingest-from/dynatrace-activegate/agctl-command-line-interface

Example command to get the ActiveGate version using 'agctl version get'.

```bash
# Get ActiveGate version
agctl version get
```

--------------------------------

### Install backend dependencies

Source: https://docs.dynatrace.com/docs/observe/dynatrace-for-ai-observability/sample-use-cases/openai-observability

Installs the backend dependencies for the sample app.

```bash
cd python-backend
python3.12 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```

--------------------------------

### Start the app

Source: https://docs.dynatrace.com/docs/observe/dynatrace-for-ai-observability/sample-use-cases/openai-observability

Starts the app. The frontend is available at http://localhost:3000 and this command also starts the backend.

```bash
npm run dev
```

--------------------------------

### Example authorization.properties with two environments

Source: https://docs.dynatrace.com/docs/ingest-from/dynatrace-activegate/configuration/configure-an-environment-activegate-for-multi-environment-support

Example configuration showing two environments, mySampleEnv and myAnotherEnv, with placeholder tokens. The main environment includes mainTenant = true.

```properties
[mySampleEnv]
tenantToken = abcdevjhij1234567890
authToken = dt0g01.HVMTLRLZ.1234567890ZYXWVUTSRQPONMLKJIHGFEDCBA01234567890ABCDEFGHIGKLMNOPQ
mainTenant = true


[myAnotherEnv]
tenantToken = 0987654321jijvedcba
authToken = dt0g01.HVMTLRLZ.1234567890ZYXWVUTSRQPONMLKJZYXWVUTSRQPONMLKJIHGFE56GHMNO890ZABCD

```

--------------------------------

### timeframe() example

Source: https://docs.dynatrace.com/docs/platform/grail/dynatrace-query-language/functions/time-functions

Creates a timeframe from a start timestamp and an end timestamp. The example uses a duration offset from now() for the start and a timestamp for the end.

```dql
data record(timestamp = toTimestamp("2019-08-01T09:30:00.000-0400"))
| fieldsAdd timeframe(from:timestamp - 5m, to: timestamp)
```

--------------------------------

### STARTS function example

Source: https://docs.dynatrace.com/docs/analyze-explore-automate/log-monitoring/log-processing/log-processing-functions

Returns true if the first string starts with the second string. The comparison is case sensitive. The example returns true.

```dynatrace
FIELDS_ADD(STARTS('Hello World!', 'Hell'));
```

--------------------------------

### Install OneAgent on Windows with command-line parameters

Source: https://docs.dynatrace.com/docs/ingest-from/dynatrace-oneagent/installation-and-operation/windows/installation/customize-oneagent-installation-on-windows

Command-line example for the EXE version of the OneAgent installer. Parameters are appended to the installer command and separated by spaces. The --set-host-group and --set-monitoring-mode parameters are environment-specific and mandatory when using the MSI package.

```powershell
.\Dynatrace-OneAgent-Windows.exe --set-host-group=my_host_group --set-monitoring-mode=infra-only INSTALL_PATH="C:\installdir"
```

--------------------------------

### GET /query:poll response body example

Source: https://docs.dynatrace.com/docs/observe/business-observability/bo-events-capturing/bo-events-capturing-external-sources

Example response body from GET /query:poll, showing the query result and metadata.

```json
{
  "state": "SUCCEEDED",
  "progress": 100,
  "result": {
    "records": [
      {
        "count()": "0"
      }
    ],
    "types": [
      {
        "indexRange": [
          0,
          0
        ],
        "mappings": {
          "count()": {
            "type": "long"
          }
        }
      }
    ],
    "metadata": {
      "grail": {
        "canonicalQuery": "fetch bizevents\n| summarize count()",
        "timezone": "Z",
        "query": "fetch bizevents | summarize Count()",
        "scannedRecords": 0,
        "dqlVersion": "V1_0",
        "scannedBytes": 0,
        "analysisTimeframe": {
          "start": "2023-07-11T07:28:11.068767000Z",
          "end": "2023-07-11T09:28:11.068767000Z"
        },
        "locale": "",
        "executionTimeMilliseconds": 4155,
        "notifications": [],
        "queryId": "fa4b928f-caaf-46fa-bae0-6906e421076a",
        "sampled": false
      }
    }
  }
}
```

--------------------------------

### Startup file with inline variables

Source: https://docs.dynatrace.com/docs/ingest-from/microsoft-azure-services/integrations/azure-appservice/integrate-oneagent-on-web-app-for-containers

Startup file that downloads the installer and runs it with inline variable values.

```shell
#!/bin/sh


readonly installerWrapperInstallationPath=/tmp/installer-wrapper.sh
readonly installerWrapperURL=https://raw.githubusercontent.com/dynatrace-oss/cloud-snippets/main/azure/linux-app-service/oneagent-installer.sh


wget -O $installerWrapperInstallationPath -q $installerWrapperURL
DT_ENDPOINT=$DT_ENDPOINT DT_API_TOKEN=$DT_API_TOKEN DT_INCLUDE=$DT_INCLUDE START_APP_CMD=$START_APP_CMD sh $installerWrapperInstallationPath

```

--------------------------------

### GET /query:poll request URL example

Source: https://docs.dynatrace.com/docs/observe/business-observability/bo-events-capturing/bo-events-capturing-external-sources

Example request URL for the GET /query:poll method, including the request-token parameter.

```url
https://mySampleEnv.apps.dynatrace.com/platform/storage/query/v1/query:poll?request-token=%2BkuSj8qvRvq64GkG5CEHag%3D%3D
```

--------------------------------

### SUBSTR function example 1

Source: https://docs.dynatrace.com/docs/analyze-explore-automate/log-monitoring/log-processing/log-processing-functions

Takes a substring from the start position to the end. The example returns 'world' from 'hello world' starting at position 6.

```dynatrace
FIELDS_ADD(SUBSTR('hello world', 6));
```
Tokens:
Raw