[docs-only] Update ocis_full with a new monitoring base setup

deployments/examples/ocis_full/.env

@@ -204,12 +204,6 @@ COLLABORA_SSL_VERIFICATION=false
 # and configure the service as required.
 
 
-### Debugging - Monitoring ###
-# Please see documentation at: https://owncloud.dev/ocis/deployment/monitoring-tracing/
-# Note: the leading colon is required to enable the service.
-#MONITORING=:monitoring_tracing/monitoring.yml
-
-
 ### Virusscanner Settings ###
 # IMPORTANT: If you enable antivirus, you also MUST configure the START_ADDITIONAL_SERVICES
 # envvar in the Infinite Scale Settings above by adding 'antivirus' to the list.
@@ -260,8 +254,18 @@ MAIL_SERVER_DOMAIN=
 MAIL_SERVER_DOCKER_TAG=v1.28.0
 
 
+### Debugging - Monitoring ###
+# Please see documentation at: https://owncloud.dev/ocis/deployment/monitoring-tracing/
+# Note: the leading colon is required to enable the service.
+#MONITORING=:monitoring_tracing/monitoring.yml
+# Uncomment to extend monitoring for the Collabora and OnlyOffice services if enabled above
+# Note that the value must match the filenames in the monitoring_tracing folder, do not change
+#MONITORING_COLLABORATION=m_collaboration.yml
+#MONITORING_COLLABORATION_OO=m_collaboration-oo.yml
+
+
 ## IMPORTANT ##
 # This MUST be the last line as it assembles the supplemental compose files to be used.
 # ALL supplemental configs must be added here, whether commented or not.
 # Each var must either be empty or contain :path/file.yml
-COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${MONITORING:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-}${MAIL_SERVER:-}
+COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-}${MAIL_SERVER:-}${MONITORING:-}

deployments/examples/ocis_full/monitoring_tracing/empty_dummy.yml

@@ -0,0 +1,4 @@
+# this file has ho compose configuration on purpose
+# it is required to be present and used in the monitoring.yml file
+# with this, we can mimic missing conditional rendering 
+# DO NOT DELETE OR ADD CONTENT !

deployments/examples/ocis_full/monitoring_tracing/m_collaboration-oo.yml

@@ -0,0 +1,13 @@
+# define the collaboration monitoring for onlyoffice
+# the filename must match the value in the .env file
+services:
+  collaboration-oo:
+    extends:
+      # add common tracing envvars for collaboration-oo (onlyoffice)
+      # note that the path is relative because the file is included
+      file: tracing_env.yml
+      service: common_monitoring_environment
+    environment:
+      # as onlyoffice runs as a single process, all <debug>/metrics endpoints
+      # will expose the same metrics, so it's sufficient to query one endpoint
+      COLLABORATION_DEBUG_ADDR: 0.0.0.0:9304

deployments/examples/ocis_full/monitoring_tracing/m_collaboration.yml

@@ -0,0 +1,13 @@
+# define the collaboration monitoring for collabora
+# the filename must match the value in the .env file
+services:
+  collaboration:
+    extends:
+      # add common tracing envvars for collaboration (collabora)
+      # note that the path is relative because the file is included
+      file: tracing_env.yml
+      service: common_monitoring_environment
+    environment:
+      # as collabora runs as a single process, all <debug>/metrics endpoints
+      # will expose the same metrics, so it's sufficient to query one endpoint
+      COLLABORATION_DEBUG_ADDR: 0.0.0.0:9304

deployments/examples/ocis_full/monitoring_tracing/monitoring-oo.yml

@@ -1,25 +0,0 @@
----
-
-services:
-  ocis:
-    environment:
-      # tracing
-      OCIS_TRACING_ENABLED: "true"
-      OCIS_TRACING_TYPE: "otlp"
-      OCIS_TRACING_ENDPOINT: jaeger:4317
-      # metrics
-      # if oCIS runs as a single process, all  <debug>/metrics endpoints
-      # will expose the same metrics, so it's sufficient to query one endpoint
-      PROXY_DEBUG_ADDR: 0.0.0.0:9205
-
-  collaboration-oo:
-    environment:
-      # tracing
-      OCIS_TRACING_ENABLED: "true"
-      OCIS_TRACING_TYPE: "otlp"
-      OCIS_TRACING_ENDPOINT: jaeger:4317
-      # metrics
-      COLLABORATION_DEBUG_ADDR: 0.0.0.0:9304
-
-networks:
-  ocis-net:

deployments/examples/ocis_full/monitoring_tracing/monitoring.yml

@@ -1,25 +1,25 @@
 ---
-
+# monitoring and tracing if enabled
 services:
   ocis:
+    # add common tracing envvars for ocis
+    extends:
+      file: monitoring_tracing/tracing_env.yml
+      service: common_monitoring_environment
     environment:
-      # tracing
-      OCIS_TRACING_ENABLED: "true"
-      OCIS_TRACING_TYPE: "otlp"
-      OCIS_TRACING_ENDPOINT: jaeger:4317
-      # metrics
-      # if oCIS runs as a single process, all  <debug>/metrics endpoints
+      # as oCIS runs as a single process, all <debug>/metrics endpoints
       # will expose the same metrics, so it's sufficient to query one endpoint
       PROXY_DEBUG_ADDR: 0.0.0.0:9205
 
-  collaboration:
-    environment:
-      # tracing
-      OCIS_TRACING_ENABLED: "true"
-      OCIS_TRACING_TYPE: "otlp"
-      OCIS_TRACING_ENDPOINT: jaeger:4317
-      # metrics
-      COLLABORATION_DEBUG_ADDR: 0.0.0.0:9304
+# include additional monitoring definitions for collabora and onlyoffice via the .env file
+# if the envvars are not uncommented in the .env file, use a dummy file with no content instead
+# compose is not able to conditionally include, this mimics the behavior
+include:
+  # collaboration
+  - monitoring_tracing/${MONITORING_COLLABORATION:-empty_dummy.yml}
+
+  # collaboration-oo
+  - monitoring_tracing/${MONITORING_COLLABORATION_OO:-empty_dummy.yml}
 
 networks:
   ocis-net:

deployments/examples/ocis_full/monitoring_tracing/tracing_env.yml

@@ -0,0 +1,11 @@
+# this is the commonly used ocis envvar definition for tracing when included
+# this makes this a single point of maintenance
+
+services:
+  # this is a dummy environment required for the compose extend attribute 
+  common_monitoring_environment:
+    environment:
+      # tracing envvars
+      OCIS_TRACING_ENABLED: "true"
+      OCIS_TRACING_TYPE: "otlp"
+      OCIS_TRACING_ENDPOINT: jaeger:4317