From 7d879274597d25a7b52baf1984407db25aaac1d4 Mon Sep 17 00:00:00 2001 From: Willy Kloucek Date: Wed, 18 May 2022 09:47:02 +0200 Subject: [PATCH] add descriptions to the debug config --- extensions/app-provider/pkg/config/config.go | 8 ++++---- extensions/app-registry/pkg/config/config.go | 8 ++++---- extensions/audit/pkg/config/debug.go | 8 ++++---- extensions/auth-basic/pkg/config/config.go | 8 ++++---- extensions/auth-bearer/pkg/config/config.go | 8 ++++---- extensions/auth-machine/pkg/config/config.go | 8 ++++---- extensions/frontend/pkg/config/config.go | 8 ++++---- extensions/gateway/pkg/config/config.go | 8 ++++---- extensions/graph-explorer/pkg/config/debug.go | 8 ++++---- extensions/graph/pkg/config/debug.go | 8 ++++---- extensions/groups/pkg/config/config.go | 8 ++++---- extensions/idm/pkg/config/debug.go | 8 ++++---- extensions/idp/pkg/config/debug.go | 8 ++++---- extensions/nats/pkg/config/debug.go | 8 ++++---- extensions/notifications/pkg/config/debug.go | 8 ++++---- extensions/ocdav/pkg/config/config.go | 8 ++++---- extensions/ocs/pkg/config/debug.go | 8 ++++---- extensions/proxy/pkg/config/debug.go | 8 ++++---- extensions/search/pkg/config/debug.go | 8 ++++---- extensions/settings/pkg/config/debug.go | 8 ++++---- extensions/sharing/pkg/config/config.go | 8 ++++---- extensions/storage-publiclink/pkg/config/config.go | 8 ++++---- extensions/storage-shares/pkg/config/config.go | 8 ++++---- extensions/storage-system/pkg/config/config.go | 8 ++++---- extensions/storage-users/pkg/config/config.go | 8 ++++---- extensions/store/pkg/config/debug.go | 8 ++++---- extensions/thumbnails/pkg/config/debug.go | 8 ++++---- extensions/users/pkg/config/config.go | 8 ++++---- extensions/web/pkg/config/debug.go | 8 ++++---- extensions/webdav/pkg/config/debug.go | 8 ++++---- 30 files changed, 120 insertions(+), 120 deletions(-) diff --git a/extensions/app-provider/pkg/config/config.go b/extensions/app-provider/pkg/config/config.go index 5b056762b8..9a6ddbd6c0 100644 --- a/extensions/app-provider/pkg/config/config.go +++ b/extensions/app-provider/pkg/config/config.go @@ -45,10 +45,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"APP_PROVIDER_DEBUG_ADDR"` - Token string `yaml:"token" env:"APP_PROVIDER_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"APP_PROVIDER_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"APP_PROVIDER_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"APP_PROVIDER_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"APP_PROVIDER_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"APP_PROVIDER_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"APP_PROVIDER_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-memory."` } type GRPCConfig struct { diff --git a/extensions/app-registry/pkg/config/config.go b/extensions/app-registry/pkg/config/config.go index f8b00b1365..3968f5ba63 100644 --- a/extensions/app-registry/pkg/config/config.go +++ b/extensions/app-registry/pkg/config/config.go @@ -43,10 +43,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"APP_REGISTRY_DEBUG_ADDR"` - Token string `yaml:"token" env:"APP_REGISTRY_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"APP_REGISTRY_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"APP_REGISTRY_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"APP_REGISTRY_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"APP_REGISTRY_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"APP_REGISTRY_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"APP_REGISTRY_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type GRPCConfig struct { diff --git a/extensions/audit/pkg/config/debug.go b/extensions/audit/pkg/config/debug.go index 398f2e712b..7d34e05bd9 100644 --- a/extensions/audit/pkg/config/debug.go +++ b/extensions/audit/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"AUDIT_DEBUG_ADDR"` - Token string `yaml:"token" env:"AUDIT_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"AUDIT_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"AUDIT_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"AUDIT_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"AUDIT_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"AUDIT_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"AUDIT_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/auth-basic/pkg/config/config.go b/extensions/auth-basic/pkg/config/config.go index 6ae9b1507f..0780f32439 100644 --- a/extensions/auth-basic/pkg/config/config.go +++ b/extensions/auth-basic/pkg/config/config.go @@ -44,10 +44,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"AUTH_BASIC_DEBUG_ADDR"` - Token string `yaml:"token" env:"AUTH_BASIC_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"AUTH_BASIC_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"AUTH_BASIC_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"AUTH_BASIC_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"AUTH_BASIC_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"AUTH_BASIC_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"AUTH_BASIC_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type GRPCConfig struct { diff --git a/extensions/auth-bearer/pkg/config/config.go b/extensions/auth-bearer/pkg/config/config.go index 3973c46155..7ddce31168 100644 --- a/extensions/auth-bearer/pkg/config/config.go +++ b/extensions/auth-bearer/pkg/config/config.go @@ -44,10 +44,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"AUTH_BEARER_DEBUG_ADDR"` - Token string `yaml:"token" env:"AUTH_BEARER_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"AUTH_BEARER_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"AUTH_BEARER_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"AUTH_BEARER_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"AUTH_BEARER_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"AUTH_BEARER_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"AUTH_BEARER_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type GRPCConfig struct { diff --git a/extensions/auth-machine/pkg/config/config.go b/extensions/auth-machine/pkg/config/config.go index 98473058b4..7c9b02264d 100644 --- a/extensions/auth-machine/pkg/config/config.go +++ b/extensions/auth-machine/pkg/config/config.go @@ -44,10 +44,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"AUTH_MACHINE_DEBUG_ADDR"` - Token string `yaml:"token" env:"AUTH_MACHINE_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"AUTH_MACHINE_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"AUTH_MACHINE_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"AUTH_MACHINE_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"AUTH_MACHINE_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"AUTH_MACHINE_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"AUTH_MACHINE_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type GRPCConfig struct { diff --git a/extensions/frontend/pkg/config/config.go b/extensions/frontend/pkg/config/config.go index 449e7f4f8f..e49e31c2b6 100644 --- a/extensions/frontend/pkg/config/config.go +++ b/extensions/frontend/pkg/config/config.go @@ -64,10 +64,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"FRONTEND_DEBUG_ADDR"` - Token string `yaml:"token" env:"FRONTEND_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"FRONTEND_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"FRONTEND_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"FRONTEND_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"FRONTEND_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"FRONTEND_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"FRONTEND_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type HTTPConfig struct { diff --git a/extensions/gateway/pkg/config/config.go b/extensions/gateway/pkg/config/config.go index c14064523b..935cea9d2d 100644 --- a/extensions/gateway/pkg/config/config.go +++ b/extensions/gateway/pkg/config/config.go @@ -68,10 +68,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"GATEWAY_DEBUG_ADDR"` - Token string `yaml:"token" env:"GATEWAY_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"GATEWAY_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"GATEWAY_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"GATEWAY_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"GATEWAY_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"GATEWAY_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"GATEWAY_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type GRPCConfig struct { diff --git a/extensions/graph-explorer/pkg/config/debug.go b/extensions/graph-explorer/pkg/config/debug.go index 8a781e439e..ec2da8ade1 100644 --- a/extensions/graph-explorer/pkg/config/debug.go +++ b/extensions/graph-explorer/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"GRAPH_EXPLORER_DEBUG_ADDR"` - Token string `yaml:"token" env:"GRAPH_EXPLORER_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"GRAPH_EXPLORER_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"GRAPH_EXPLORER_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"GRAPH_EXPLORER_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"GRAPH_EXPLORER_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"GRAPH_EXPLORER_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"GRAPH_EXPLORER_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/graph/pkg/config/debug.go b/extensions/graph/pkg/config/debug.go index ceff19159b..004ccb919c 100644 --- a/extensions/graph/pkg/config/debug.go +++ b/extensions/graph/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"GRAPH_DEBUG_ADDR"` - Token string `yaml:"token" env:"GRAPH_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"GRAPH_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"GRAPH_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"GRAPH_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"GRAPH_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"GRAPH_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"GRAPH_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/groups/pkg/config/config.go b/extensions/groups/pkg/config/config.go index 6c58eb6595..b9e3319266 100644 --- a/extensions/groups/pkg/config/config.go +++ b/extensions/groups/pkg/config/config.go @@ -45,10 +45,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"GROUPS_DEBUG_ADDR"` - Token string `yaml:"token" env:"GROUPS_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"GROUPS_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"GROUPS_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"GROUPS_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"GROUPS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"GROUPS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"GROUPS_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type GRPCConfig struct { diff --git a/extensions/idm/pkg/config/debug.go b/extensions/idm/pkg/config/debug.go index 43ffdf3760..77c5588878 100644 --- a/extensions/idm/pkg/config/debug.go +++ b/extensions/idm/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"IDM_DEBUG_ADDR"` - Token string `yaml:"token" env:"IDM_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"IDM_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"IDM_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"IDM_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"IDM_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"IDM_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"IDM_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/idp/pkg/config/debug.go b/extensions/idp/pkg/config/debug.go index f2a30076f2..5f7f3d3d50 100644 --- a/extensions/idp/pkg/config/debug.go +++ b/extensions/idp/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"IDP_DEBUG_ADDR"` - Token string `yaml:"token" env:"IDP_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"IDP_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"IDP_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"IDP_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"IDP_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"IDP_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"IDP_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/nats/pkg/config/debug.go b/extensions/nats/pkg/config/debug.go index 8c316683a4..efda49fc46 100644 --- a/extensions/nats/pkg/config/debug.go +++ b/extensions/nats/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"NATS_DEBUG_ADDR"` - Token string `yaml:"token" env:"NATS_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"NATS_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"NATS_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"NATS_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"NATS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"NATS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"NATS_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/notifications/pkg/config/debug.go b/extensions/notifications/pkg/config/debug.go index df19aca968..55c6b005bf 100644 --- a/extensions/notifications/pkg/config/debug.go +++ b/extensions/notifications/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"NOTIFICATIONS_DEBUG_ADDR"` - Token string `yaml:"token" env:"NOTIFICATIONS_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"NOTIFICATIONS_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"NOTIFICATIONS_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"NOTIFICATIONS_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"NOTIFICATIONS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"NOTIFICATIONS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"NOTIFICATIONS_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/ocdav/pkg/config/config.go b/extensions/ocdav/pkg/config/config.go index 72d60a06d3..ca7108de95 100644 --- a/extensions/ocdav/pkg/config/config.go +++ b/extensions/ocdav/pkg/config/config.go @@ -54,10 +54,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"OCDAV_DEBUG_ADDR"` - Token string `yaml:"token" env:"OCDAV_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"OCDAV_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"OCDAV_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"OCDAV_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"OCDAV_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"OCDAV_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"OCDAV_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type HTTPConfig struct { diff --git a/extensions/ocs/pkg/config/debug.go b/extensions/ocs/pkg/config/debug.go index 9ed071c333..a57d443f91 100644 --- a/extensions/ocs/pkg/config/debug.go +++ b/extensions/ocs/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"OCS_DEBUG_ADDR"` - Token string `yaml:"token" env:"OCS_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"OCS_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"OCS_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"OCS_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"OCS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"OCS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"OCS_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/proxy/pkg/config/debug.go b/extensions/proxy/pkg/config/debug.go index 1b9287b3de..806a6fa95d 100644 --- a/extensions/proxy/pkg/config/debug.go +++ b/extensions/proxy/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"PROXY_DEBUG_ADDR"` - Token string `yaml:"token" env:"PROXY_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"PROXY_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"PROXY_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"PROXY_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"PROXY_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"PROXY_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"PROXY_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/search/pkg/config/debug.go b/extensions/search/pkg/config/debug.go index a6ab80cbda..72016b6542 100644 --- a/extensions/search/pkg/config/debug.go +++ b/extensions/search/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `ocisConfig:"addr" env:"SEARCH_DEBUG_ADDR"` - Token string `ocisConfig:"token" env:"SEARCH_DEBUG_TOKEN"` - Pprof bool `ocisConfig:"pprof" env:"SEARCH_DEBUG_PPROF"` - Zpages bool `ocisConfig:"zpages" env:"SEARCH_DEBUG_ZPAGES"` + Addr string `ocisConfig:"addr" env:"SEARCH_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `ocisConfig:"token" env:"SEARCH_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `ocisConfig:"pprof" env:"SEARCH_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `ocisConfig:"zpages" env:"SEARCH_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/settings/pkg/config/debug.go b/extensions/settings/pkg/config/debug.go index e86d9056a8..14f6f41a79 100644 --- a/extensions/settings/pkg/config/debug.go +++ b/extensions/settings/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"SETTINGS_DEBUG_ADDR"` - Token string `yaml:"token" env:"SETTINGS_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"SETTINGS_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"SETTINGS_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"SETTINGS_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"SETTINGS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"SETTINGS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"SETTINGS_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/sharing/pkg/config/config.go b/extensions/sharing/pkg/config/config.go index 5ede701c6a..d1c6555ec2 100644 --- a/extensions/sharing/pkg/config/config.go +++ b/extensions/sharing/pkg/config/config.go @@ -48,10 +48,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"SHARING_DEBUG_ADDR"` - Token string `yaml:"token" env:"SHARING_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"SHARING_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"SHARING_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"SHARING_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"SHARING_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"SHARING_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"SHARING_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type GRPCConfig struct { diff --git a/extensions/storage-publiclink/pkg/config/config.go b/extensions/storage-publiclink/pkg/config/config.go index f359a4969c..848d45f7ca 100644 --- a/extensions/storage-publiclink/pkg/config/config.go +++ b/extensions/storage-publiclink/pkg/config/config.go @@ -44,10 +44,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"STORAGE_PUBLICLINK_DEBUG_ADDR"` - Token string `yaml:"token" env:"STORAGE_PUBLICLINK_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"STORAGE_PUBLICLINK_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"STORAGE_PUBLICLINK_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"STORAGE_PUBLICLINK_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"STORAGE_PUBLICLINK_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"STORAGE_PUBLICLINK_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"STORAGE_PUBLICLINK_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type GRPCConfig struct { diff --git a/extensions/storage-shares/pkg/config/config.go b/extensions/storage-shares/pkg/config/config.go index af0a4e50b3..eaee90d456 100644 --- a/extensions/storage-shares/pkg/config/config.go +++ b/extensions/storage-shares/pkg/config/config.go @@ -46,10 +46,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"STORAGE_SHARES_DEBUG_ADDR"` - Token string `yaml:"token" env:"STORAGE_SHARES_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"STORAGE_SHARES_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"STORAGE_SHARES_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"STORAGE_SHARES_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"STORAGE_SHARES_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"STORAGE_SHARES_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"STORAGE_SHARES_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type GRPCConfig struct { diff --git a/extensions/storage-system/pkg/config/config.go b/extensions/storage-system/pkg/config/config.go index ab6caefb09..d5e9ed246c 100644 --- a/extensions/storage-system/pkg/config/config.go +++ b/extensions/storage-system/pkg/config/config.go @@ -51,10 +51,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"STORAGE_SYSTEM_DEBUG_ADDR"` - Token string `yaml:"token" env:"STORAGE_SYSTEM_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"STORAGE_SYSTEM_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"STORAGE_SYSTEM_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"STORAGE_SYSTEM_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"STORAGE_SYSTEM_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"STORAGE_SYSTEM_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"STORAGE_SYSTEM_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type GRPCConfig struct { diff --git a/extensions/storage-users/pkg/config/config.go b/extensions/storage-users/pkg/config/config.go index 54f9723cfd..f64405dcf6 100644 --- a/extensions/storage-users/pkg/config/config.go +++ b/extensions/storage-users/pkg/config/config.go @@ -53,10 +53,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"STORAGE_USERS_DEBUG_ADDR"` - Token string `yaml:"token" env:"STORAGE_USERS_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"STORAGE_USERS_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"STORAGE_USERS_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"STORAGE_USERS_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"STORAGE_USERS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"STORAGE_USERS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"STORAGE_USERS_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type GRPCConfig struct { diff --git a/extensions/store/pkg/config/debug.go b/extensions/store/pkg/config/debug.go index 4aa297a177..8d4bcba3ce 100644 --- a/extensions/store/pkg/config/debug.go +++ b/extensions/store/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"STORE_DEBUG_ADDR"` - Token string `yaml:"token" env:"STORE_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"STORE_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"STORE_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"STORE_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"STORE_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"STORE_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"STORE_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/thumbnails/pkg/config/debug.go b/extensions/thumbnails/pkg/config/debug.go index ee9d8f4833..755cf9cf77 100644 --- a/extensions/thumbnails/pkg/config/debug.go +++ b/extensions/thumbnails/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"THUMBNAILS_DEBUG_ADDR" desc:"The debug address"` - Token string `yaml:"token" env:"THUMBNAILS_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"THUMBNAILS_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"THUMBNAILS_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"THUMBNAILS_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"THUMBNAILS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"THUMBNAILS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"THUMBNAILS_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/users/pkg/config/config.go b/extensions/users/pkg/config/config.go index 006fb47d42..92d4f74453 100644 --- a/extensions/users/pkg/config/config.go +++ b/extensions/users/pkg/config/config.go @@ -45,10 +45,10 @@ type Service struct { } type Debug struct { - Addr string `yaml:"addr" env:"USERS_DEBUG_ADDR"` - Token string `yaml:"token" env:"USERS_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"USERS_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"USERS_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"USERS_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"USERS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"USERS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"USERS_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } type GRPCConfig struct { diff --git a/extensions/web/pkg/config/debug.go b/extensions/web/pkg/config/debug.go index e3473636a8..a604b622a7 100644 --- a/extensions/web/pkg/config/debug.go +++ b/extensions/web/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"WEB_DEBUG_ADDR"` - Token string `yaml:"token" env:"WEB_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"WEB_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"WEB_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"WEB_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"WEB_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"WEB_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"WEB_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` } diff --git a/extensions/webdav/pkg/config/debug.go b/extensions/webdav/pkg/config/debug.go index 8ce9689f7f..6f2306cb3e 100644 --- a/extensions/webdav/pkg/config/debug.go +++ b/extensions/webdav/pkg/config/debug.go @@ -2,8 +2,8 @@ package config // Debug defines the available debug configuration. type Debug struct { - Addr string `yaml:"addr" env:"WEBDAV_DEBUG_ADDR"` - Token string `yaml:"token" env:"WEBDAV_DEBUG_TOKEN"` - Pprof bool `yaml:"pprof" env:"WEBDAV_DEBUG_PPROF"` - Zpages bool `yaml:"zpages" env:"WEBDAV_DEBUG_ZPAGES"` + Addr string `yaml:"addr" env:"WEBDAV_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."` + Token string `yaml:"token" env:"WEBDAV_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"` + Pprof bool `yaml:"pprof" env:"WEBDAV_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"` + Zpages bool `yaml:"zpages" env:"WEBDAV_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing traces in-me"` }