Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 2.16 KB

README.md

File metadata and controls

45 lines (33 loc) · 2.16 KB

tests project is maintained

ddev-gander

What is Gander?

Gander is a preconfigured Open Telemetry stack relying on Prometheus, Grafana, and Grafana Tempo.

For DDEV v1.23.5 or above run

ddev add-on get tag1consulting/ddev-gander

For earlier versions of DDEV run

ddev get tag1consulting/ddev-gander

Then run Drupal core's OpenTelemetry phpunit tests, and immediately see performance metrics and traces in a Grafana dashboard. Or add PerformanceTestBase coverage to an existing project with a few lines of code if you already have phpunit functional test coverage of your project.

For more information on the phpunit side of things, see the Drupal core change record.

Prerequisites:

  • Install ddev if you haven't already.
  • Enable ddev on your local Drupal project.
  • ddev get ddev/ddev-selenium-standalone-chrome to enable functional Javascript tests for DDEV. (ddev/ddev-selenium-standalone-chrome is a dependency of this add-on.)

Getting started

For more information and a quickstart guide, check the documentation on Drupal.org.

Add Gander and run Drupal's performance tests via a git clone of Drupal core (assuming composer is used):

  • ddev get tag1consulting/ddev-gander
  • ddev restart
  • ddev ssh
  • cd web/
  • To run a single test: phpunit -c core profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryNodePagePerformanceTest.php
  • To run all Gander tests: phpunit -c core --group OpenTelemetry
  • Check the Grafana dashboard via: http://<projectname>.ddev.site:3000/