Skip to main content

Best Practices

Use the Data Picker​

  • Always use the data picker UI when possible (avoids typos)
  • The data picker shows only fields available in your configured context
  • Hover over fields in the picker to see descriptions

Test with Sample Data​

  • Use the runbook test mode to validate Mustache variables render correctly
  • Test with different incident types to ensure custom fields work as expected
  • Verify output from one action can be consumed by the next

Handle Missing Values​

  • Not all fields are guaranteed to be populated
  • Use descriptive defaults: {{incident.owner | default: "Unassigned"}}
  • Consider optional vs. required fields when designing runbooks

Keep Mustache Syntax Clean​

  • Use clear, readable syntax
  • Add spacing for readability: {{incident.title}} not {{incident.title}}
  • Use consistent formatting across runbooks

Document Custom Fields​

  • Add descriptions to custom fields in incident type configuration
  • Name custom fields clearly (e.g., error_rate not field1)
  • Document expected values and formats

Next steps​

info

Need Help? Contact our support team by email at support@harness.io or visit the Harness Documentation for additional resources and troubleshooting guides.