Use new relic via docker-compose 2.4 features

https://docs.docker.com/compose/compose-file/#extension-fields

Author: piggito

.gitlab-ci.yml

@@ -1,12 +1,13 @@
 # Variables to add in Gitalb UI : Settings > CI/CD
 # - SONAR_HOST // Optional
 # - SONAR_TOKEN // Optional
+# - NEW_RELIC_LICENSE_KEY // Optional
 
 variables:
-  GIT_DEPTH: "3"
+  GIT_DEPTH: "10"
   THEME_PATH: "" # Update to enable front jobs (web/themes/custom/XXX)
   STORYBOOK_PATH: "" # Update to enable storybook job (themes/custom/XXX/dist/storybook/index.html)
-  GIT_STRATEGY: clone # Workaround until git is updated in runner, see https://gitlab.com/gitlab-org/gitlab-foss/issues/60466
+  GIT_STRATEGY: fetch
   REVIEW_DOMAIN: "XXX.XXX.com" # Mandatory, should equal to DNS of available runner server with docker + docker-compose + traefik
 
 image: skilldlabs/php:73

Makefile

@@ -74,6 +74,8 @@ endif
 	$(call php-0, apk add --no-cache tzdata $(ADD_PHP_EXT))
 	# Set up timezone
 	$(call php-0, cp /usr/share/zoneinfo/Europe/Paris /etc/localtime)
+	# Install newrelic PHP extension if NEW_RELIC_LICENSE_KEY defined
+	make -s newrelic
 	$(call php-0, kill -USR2 1)
 	$(call php, composer global require -o --update-no-dev --no-suggest "hirak/prestissimo:^0.3")
 

README.md

@@ -118,7 +118,7 @@ networks:
 * `make lint` - Runs frontend linters.
 * `make storybook` - Runs storybook in current theme.
 * `make blackfire` - Adds and enables blackfire.io php extension, needs [configuration](https://blackfire.io/docs/configuration/php) in docker-composer override.yml.
-* `make newrelic` - Adds and enables newrelic.com php extension, needs [configuration](https://docs.newrelic.com/docs/agents/php-agent/getting-started/introduction-new-relic-php#configuration) in docker-composer.override.yml.
+* `make newrelic` - Adds and enables newrelic.com php extension, needs [configuration](https://docs.newrelic.com/docs/agents/php-agent/getting-started/introduction-new-relic-php#configuration) `NEW_RELIC_LICENSE_KEY` environment variable defined with valid license key.
 
 #### Additional goals
 

docker/docker-compose.override.yml.default

@@ -1,14 +1,27 @@
 version: "2.4"
 
+x-service-defaults:
+  &service-defaults
+  restart: always
+  networks:
+    - front
+
+x-service-rewrelic:
+  &service-newrelic
+  newrelic:
+    <<: *service-defaults
+    image: newrelic/php-daemon
+    container_name: "${COMPOSE_PROJECT_NAME}_newrelic"
+
 services:
+#  <<: *service-newrelic
 
 # Override base service.
   php:
     environment:
       COMPOSER_MEMORY_LIMIT: "-1"
 #      BLACKFIRE_CLIENT_ID: x
 #      BLACKFIRE_CLIENT_TOKEN: x
-#      NEW_RELIC_LICENSE_KEY: x
 #      NEW_RELIC_APPNAME: "${COMPOSE_PROJECT_NAME}"
     volumes:
       - "./90-mail.ini:/etc/php7/conf.d/90-mail.ini:z"
@@ -22,32 +35,25 @@ services:
 # Then download extension using "make blackfire"
 
 #  blackfire:
+#    <<: *service-defaults
 #    image: blackfire/blackfire
 #    container_name: "${COMPOSE_PROJECT_NAME}_blackfire"
 #    environment:
 #      BLACKFIRE_SERVER_ID: x
 #      BLACKFIRE_SERVER_TOKEN: x
 #      BLACKFIRE_LOG_LEVEL: 1
-#    networks:
-#      - front
-
-#  newrelic:
-#    image: newrelic/php-daemon
-#    container_name: "${COMPOSE_PROJECT_NAME}_newrelic"
-#    networks:
-#      - front
 
 #  adminer:
+#    <<: *service-defaults
 #    image: adminer:standalone
 #    container_name: "${COMPOSE_PROJECT_NAME}_adminer"
 #    links:
 #      - mysql:mysql
 #    depends_on:
 #      - mysql
-#    networks:
-#      - front
 
 #  mysql:
+#    <<: *service-defaults
 #    image: percona:5.7
 #    container_name: "${COMPOSE_PROJECT_NAME}_mysql"
 #    volumes:
@@ -57,11 +63,9 @@ services:
 #      MYSQL_USER: d8
 #      MYSQL_PASSWORD: d8
 #      MYSQL_ROOT_PASSWORD: d8root
-#    restart: always
-#    networks:
-#      - front
 
 #  postgresql:
+#    <<: *service-defaults
 #    image: postgres:12.2-alpine
 #    container_name: "${COMPOSE_PROJECT_NAME}_pgsql"
 #    volumes:
@@ -71,16 +75,11 @@ services:
 #      POSTGRES_USER: d9
 #      POSTGRES_PASSWORD: d9root
 #      PGDATA: /var/lib/postgresql/data
-#    restart: always
-#    networks:
-#      - front
 
   mailhog:
+    <<: *service-defaults
     image: skilldlabs/mailhog
     container_name: "${COMPOSE_PROJECT_NAME}_mail"
-    restart: always
-    networks:
-      - front
     labels:
       - 'traefik.enable=true'
       # Treafik 1.x
@@ -127,10 +126,3 @@ services:
 #      - 'traefik.http.routers.solr-${COMPOSE_PROJECT_NAME}.tls=true'
 #      - 'traefik.http.services.solr-${COMPOSE_PROJECT_NAME}.loadbalancer.server.port=8983'
 
-#networks:
-#  front:
-#    driver: bridge
-#    ipam:
-#      driver: default
-#      config:
-#        - subnet: "${IPRANGE}"

docker/docker-compose.yml

@@ -1,16 +1,20 @@
 version: "2.4"
 
+x-service-defaults:
+  &service-defaults
+  restart: always
+  networks:
+    - front
+
 services:
 
   php:
+    <<: *service-defaults
     image: ${IMAGE_PHP}
     container_name: "${COMPOSE_PROJECT_NAME}_php"
     volumes:
       - ../:/var/www/html:z
       - ../drush/.drushrc.php:/home/www-data/.drushrc.php:z
-    restart: always
-    networks:
-      - front
 #    environment:
 #      REDIS_HOST: ${REDIS_HOST}
 #      REDIS_PORT: ${REDIS_PORT}
@@ -21,17 +25,16 @@ services:
 #      - redis:redis
 
   nginx:
+    <<: *service-defaults
     image: ${IMAGE_NGINX}
     container_name: "${COMPOSE_PROJECT_NAME}_web"
     depends_on:
       - php
     volumes_from:
       - php
-    restart: always
-    networks:
-      - front
 
 #  solr:
+#    <<: *service-defaults
 #    image: ${IMAGE_SOLR}
 #    container_name: "${COMPOSE_PROJECT_NAME}_solr"
 #    volumes:
@@ -41,16 +44,12 @@ services:
 #      - solr-precreate
 #      - ${COMPOSE_PROJECT_NAME}
 #      - /solr-conf
-#    networks:
-#    - front
 
 #  redis:
+#    <<: *service-defaults
 #    image: ${IMAGE_REDIS}
 #    container_name: "${COMPOSE_PROJECT_NAME}_redis"
 #    command: redis-server --maxmemory-policy allkeys-lru --requirepass ${REDIS_PASSWD}
-#    restart: always
-#    networks:
-#      - front
 
 networks:
   front:

scripts/makefile/newrelic.sh

@@ -6,21 +6,20 @@
 PHP_INI_DIR=/etc/php7/conf.d
 
 # get the latest version from https://download.newrelic.com/php_agent/archive/
-NEW_RELIC_AGENT_VERSION="${NEW_RELIC_AGENT_VERSION:-9.12.0.268}"
+NEW_RELIC_AGENT_VERSION="${NEW_RELIC_AGENT_VERSION:-9.13.0.270}"
 # change it to 'linux' if docker image is not based on Alpinelinux
 NEW_RELIC_LINUX=${NEW_RELIC_LINUX:-linux-musl}
 
 set -e
 
-env_vars='NEW_RELIC_APPNAME NEW_RELIC_LICENSE_KEY'
-
-for var in $env_vars; do
-	eval "val=\${$var}"
-	if [ -z "${val}" -o "${val}" = 'x' ]; then
-		echo "Configure ${var} in docker-compose.override.yml"
-		echo "Visit https://newrelic.com 'Account settings' to get the key"; exit 1;
-	fi
-done
+# Print help in case parameters are empty
+if [ -z "$1" ] || [ -z "$2" ]
+then
+	echo "Visit https://newrelic.com 'Account settings' to get the license key";
+	exit 1 # Exit script after printing help
+fi
+NEW_RELIC_LICENSE_KEY="$1"
+NEW_RELIC_APPNAME="$2"
 
 curl -L https://download.newrelic.com/php_agent/archive/${NEW_RELIC_AGENT_VERSION}/newrelic-php5-${NEW_RELIC_AGENT_VERSION}-${NEW_RELIC_LINUX}.tar.gz | tar -C /tmp -zx \
 	&& export NR_INSTALL_USE_CP_NOT_LN=1 \

scripts/makefile/tests.mk

@@ -199,11 +199,11 @@ else
 endif
 
 newrelic:
-ifneq ("$(wildcard scripts/makefile/newrelic.sh)","")
-	$(call php-0, /bin/sh ./scripts/makefile/newrelic.sh)
-	$(call php-0, kill -USR2 1)
-	@echo "NewRelic extension enabled"
+ifdef NEW_RELIC_LICENSE_KEY
+	$(call php-0, /bin/sh ./scripts/makefile/newrelic.sh $(NEW_RELIC_LICENSE_KEY) '$(COMPOSE_PROJECT_NAME)')
+	$(call php, sed -i -e 's/#  <<: \*service-newrelic/  <<: \*service-newrelic/g' docker/docker-compose.override.yml)
+	docker-compose up -d
+	@echo "NewRelic PHP extension enabled"
 else
-	@echo "scripts/makefile/newrelic.sh file does not exist"
-	@exit 1
+	@echo "NewRelic install skipped as NEW_RELIC_LICENSE_KEY is not set"
 endif