Dynatrace-workflow-samples: Instructions file for Codex

Dynatrace Workflows - AI Assistant Instructions

This document provides comprehensive guidelines for creating syntactically correct Dynatrace Workflows. These instructions are designed for AI coding assistants including GitHub Copilot, Cursor, Claude Code, and Kiro.

Overview

Dynatrace Workflows are automation solutions that allow you to orchestrate tasks, integrate with external systems, and automate responses to events. This repository contains sample workflows and code snippets for the Dynatrace AutomationEngine and Workflows app.

Important: There are three distinct formats for Dynatrace Workflows. Never mix these formats:

1. Workflow Templates (YAML) - For UI import/export
2. API Format (JSON) - For programmatic workflow management
3. Terraform/Monaco - For Configuration-as-Code deployments

---

Pull Request Review Guidelines

When reviewing pull requests (automated or manual), verify the following:

Workflow Syntax Validation

• Correct format used: YAML template, API JSON, or Terraform (never mixed)
• schemaVersion is 3: All workflows must use schemaVersion: 3
• Valid YAML/JSON syntax: No parsing errors
• Task names match: name field inside task matches the task key
• Predecessors exist: All referenced predecessor tasks are defined
• Actions are valid: Action names follow app:action pattern (e.g., dynatrace.automations:execute-dql-query)

Security Review

• No hardcoded secrets: No API keys, tokens, passwords, or credentials in workflow files
• Use secret() function: Sensitive values should use {{ secret('secret_name') }}
• Use connections: External service credentials stored in Dynatrace connections
• No internal URLs exposed: No internal/private endpoints in HTTP actions

Best Practices

• Meaningful task names: Descriptive names like fetch_security_logs instead of task1
• Task descriptions: Every task should have a description
• Proper error handling: Conditions check task states before proceeding
• Dependencies declared: All required apps listed in metadata dependencies
• File naming: Templates use wftpl_*.yaml naming convention