Move common debugging configs to editable example file

.goreleaser.yml

@@ -282,6 +282,9 @@ nfpms:
       - src: "systemd/pelican.logrotate"
         dst: "/etc/logrotate.d/pelican"
         type: config|noreplace
+      - src: "systemd/examples/90-debugging.yaml"
+        dst: "/etc/pelican/config.d/90-debugging.yaml"
+        type: config|noreplace
       - dst: "/etc/pelican/config.d"
         type: "dir"
         file_info:

systemd/examples/90-debugging.yaml

@@ -0,0 +1,25 @@
+---
+#####################################################
+# Common Debugging Configuration
+#
+# Optional configuration for incr;easing log level verbosity
+#####################################################
+
+## Set Debug: true to increase verbosity of logging in
+## /var/log/pelican
+# Debug: false
+
+## Uncomment the following sections to increase component-specific
+## logging verbosity
+# Logging:
+#   Level: "Trace"
+#   Cache:
+#     Http: "trace"
+#     Ofs: "trace"
+#     Pfc: "trace"
+#     Xrd: "trace"
+#   Origin:
+#     Http: "trace"
+#     Ofs: "trace"
+#     Scitokens: "trace"
+#     Xrootd: "trace"

systemd/osdf-cache.yaml

@@ -11,12 +11,9 @@ ConfigLocations:
   - "/usr/share/pelican/config.d"
   - "/etc/pelican/config.d"
 
-## Enable Debug to send detailed logs, including XRootD logs, to the log file
-# Debug: false
 Logging:
   LogLocation: /var/log/pelican/osdf-cache.log
-  ## Valid Levels are Trace, Debug, Info, Warning, Error, Fatal and Panic.
-  # Level: "Error"
+
 Server:
   EnableUI: false
   ## Set Hostname to the external DNS name this can be accessed over, if

systemd/osdf-director.yaml

@@ -11,9 +11,5 @@ ConfigLocations:
   - "/usr/share/pelican/config.d"
   - "/etc/pelican/config.d"
 
-## Enable Debug to send detailed logs to the log file
-# Debug: false
 Logging:
   LogLocation: /var/log/pelican/osdf-director.log
-  ## Valid Levels are Trace, Debug, Info, Warning, Error, Fatal and Panic.
-  # Level: "Error"

systemd/osdf-origin.yaml

@@ -11,12 +11,9 @@ ConfigLocations:
   - "/usr/share/pelican/config.d"
   - "/etc/pelican/config.d"
 
-## Enable Debug to send detailed logs, including XRootD logs, to the log file
-# Debug: false
 Logging:
   LogLocation: /var/log/pelican/osdf-origin.log
-  ## Valid Levels are Trace, Debug, Info, Warning, Error, Fatal and Panic.
-  # Level: "Error"
+
 Server:
   EnableUI: false
   ## Set Hostname to the external DNS name this can be accessed over, if

systemd/osdf-registry.yaml

@@ -11,9 +11,5 @@ ConfigLocations:
   - "/usr/share/pelican/config.d"
   - "/etc/pelican/config.d"
 
-## Enable Debug to send detailed logs to the log file
-# Debug: false
 Logging:
   LogLocation: /var/log/pelican/osdf-registry.log
-  ## Valid Levels are Trace, Debug, Info, Warning, Error, Fatal and Panic.
-  # Level: "Error"

systemd/pelican-cache.yaml

@@ -11,12 +11,9 @@ ConfigLocations:
   - "/usr/share/pelican/config.d"
   - "/etc/pelican/config.d"
 
-## Enable Debug to send detailed logs, including XRootD logs, to the log file
-# Debug: false
 Logging:
   LogLocation: /var/log/pelican/pelican-cache.log
-  ## Valid Levels are Trace, Debug, Info, Warning, Error, Fatal and Panic.
-  # Level: "Error"
+
 Federation:
   ## The main URL for your federation. You must specify this.
   DiscoveryUrl:

systemd/pelican-director.yaml

@@ -11,12 +11,9 @@ ConfigLocations:
   - "/usr/share/pelican/config.d"
   - "/etc/pelican/config.d"
 
-## Enable Debug to send detailed logs, including XRootD logs, to the log file
-# Debug: false
 Logging:
   LogLocation: /var/log/pelican/pelican-director.log
-  ## Valid Levels are Trace, Debug, Info, Warning, Error, Fatal and Panic.
-  # Level: "Error"
+
 Federation:
   ## The main URL for your federation. You must specify this.
   DiscoveryUrl:

systemd/pelican-origin.yaml

@@ -11,12 +11,9 @@ ConfigLocations:
   - "/usr/share/pelican/config.d"
   - "/etc/pelican/config.d"
 
-## Enable Debug to send detailed logs, including XRootD logs, to the log file
-# Debug: false
 Logging:
   LogLocation: /var/log/pelican/pelican-origin.log
-  ## Valid Levels are Trace, Debug, Info, Warning, Error, Fatal and Panic.
-  # Level: "Error"
+
 Federation:
   ## The main URL for your federation. You must specify this.
   DiscoveryUrl:

systemd/pelican-registry.yaml

@@ -11,12 +11,9 @@ ConfigLocations:
   - "/usr/share/pelican/config.d"
   - "/etc/pelican/config.d"
 
-## Enable Debug to send detailed logs, including XRootD logs, to the log file
-# Debug: false
 Logging:
   LogLocation: /var/log/pelican/pelican-registry.log
-  ## Valid Levels are Trace, Debug, Info, Warning, Error, Fatal and Panic.
-  # Level: "Error"
+
 Federation:
   ## The main URL for your federation. You must specify this.
   DiscoveryUrl: