feat: control enabling of telemetry

GZTimeWalker · Apr 8, 2024 · 93b00d8 · 93b00d8
1 parent 3060ca3
commit 93b00d8
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 34 deletions.
diff --git a/docs/pages/config/appsettings.en.mdx b/docs/pages/config/appsettings.en.mdx
@@ -30,6 +30,7 @@ Here is a complete example of configuration:
     }
   },
   "Telemetry": {
+    "Enable": true,
     "OpenTelemetry": {
       "Enable": true,
       "Protocol": "Grpc",
@@ -144,6 +145,8 @@ GZCTF only supports PostgreSQL as the database, and does not support MySQL and o
 
 GZCTF supports metrics and distributed tracing. You can configure the providers you want to use.
 
+- **Enable**: Enable telemetry support or not.
+
 - **OpenTelemetry**: Exporting metrics and tracing data to OpenTelemetry.
 
   - **Enable**: Enable it or not.

diff --git a/docs/pages/config/appsettings.ja.mdx b/docs/pages/config/appsettings.ja.mdx
@@ -30,6 +30,7 @@ import { Callout } from "nextra-theme-docs";
     }
   },
   "Telemetry": {
+    "Enable": true,
     "OpenTelemetry": {
       "Enable": true,
       "Protocol": "Grpc",
@@ -144,6 +145,8 @@ GZCTFはデータベースとしてPostgreSQLのみをサポートしており
 
 GZCTFはメトリクスと分散トレーシングをサポートしています。使用するプロバイダーを設定できます。
 
+- **Enable**: テレメトリーを有効化するかどうか。
+
 - **OpenTelemetry**: メトリクスとトレーシングデータを OpenTelemetry にエクスポートします。
 
   - **Enable**: 有効にするかどうか。

diff --git a/docs/pages/config/appsettings.zh.mdx b/docs/pages/config/appsettings.zh.mdx
@@ -30,6 +30,7 @@ import { Callout } from "nextra-theme-docs";
     }
   },
   "Telemetry": {
+    "Enable": true,
     "OpenTelemetry": {
       "Enable": true,
       "Protocol": "Grpc",
@@ -144,6 +145,8 @@ GZCTF 仅支持 PostgreSQL 作为数据库，不支持 MySQL 等其他数据库
 
 GZCTF 支持测量和分布式追踪。您可以配置您想要使用的提供商。
 
+- **Enable**: 是否启用测量和追踪支持。
+
 - **OpenTelemetry**：将测量和追踪数据导出到 OpenTelemetry。
 
   - **Enable**：是否启用。

diff --git a/src/GZCTF/Program.cs b/src/GZCTF/Program.cs
@@ -207,46 +207,51 @@
 #region Telemetry
 
 var telemetryOptions = builder.Configuration.GetSection("Telemetry");
-var otel = builder.Services.AddOpenTelemetry();
+var telemetryEnabled = telemetryOptions.Exists() && telemetryOptions.GetSection("Enable").Get<bool>();
 
-otel.ConfigureResource(resource => resource.AddService("GZCTF"));
+if (telemetryEnabled)
+{
+    var otel = builder.Services.AddOpenTelemetry();
 
-var azmoOptions = telemetryOptions.GetSection("AzureMonitor");
-var azureMonitorEnabled = azmoOptions.Exists() && azmoOptions.GetSection("Enable").Get<bool>();
-var otelOptions = telemetryOptions.GetSection("OpenTelemetry");
-var otelEnabled = otelOptions.Exists() && otelOptions.GetSection("Enable").Get<bool>();
-var consoleOptions = telemetryOptions.GetSection("Console");
-var consoleEnabled = consoleOptions.Exists() && consoleOptions.GetSection("Enable").Get<bool>();
+    otel.ConfigureResource(resource => resource.AddService("GZCTF"));
 
-otel.WithMetrics(metrics =>
-{
-    metrics.AddAspNetCoreInstrumentation();
-    metrics.AddHttpClientInstrumentation();
-    metrics.AddPrometheusExporter();
-});
+    var azmoOptions = telemetryOptions.GetSection("AzureMonitor");
+    var azureMonitorEnabled = azmoOptions.Exists() && azmoOptions.GetSection("Enable").Get<bool>();
+    var otelOptions = telemetryOptions.GetSection("OpenTelemetry");
+    var otelEnabled = otelOptions.Exists() && otelOptions.GetSection("Enable").Get<bool>();
+    var consoleOptions = telemetryOptions.GetSection("Console");
+    var consoleEnabled = consoleOptions.Exists() && consoleOptions.GetSection("Enable").Get<bool>();
 
-otel.WithTracing(tracing =>
-{
-    tracing.AddAspNetCoreInstrumentation();
-    tracing.AddHttpClientInstrumentation();
-    tracing.AddNpgsql();
-    if (consoleEnabled)
+    otel.WithMetrics(metrics =>
     {
-        tracing.AddConsoleExporter();
-    }
-});
+        metrics.AddAspNetCoreInstrumentation();
+        metrics.AddHttpClientInstrumentation();
+        metrics.AddPrometheusExporter();
+    });
 
-if (azureMonitorEnabled)
-{
-    otel.UseAzureMonitor(
-        options => options.ConnectionString = azmoOptions.GetSection("ConnectionString").Get<string>());
-}
+    otel.WithTracing(tracing =>
+    {
+        tracing.AddAspNetCoreInstrumentation();
+        tracing.AddHttpClientInstrumentation();
+        tracing.AddNpgsql();
+        if (consoleEnabled)
+        {
+            tracing.AddConsoleExporter();
+        }
+    });
 
-if (otelEnabled)
-{
-    otel.UseOtlpExporter(
-        otelOptions.GetRequiredSection("Protocol").Get<OtlpExportProtocol>(),
-        new(otelOptions.GetRequiredSection("EndpointUri").Get<string>()!));
+    if (azureMonitorEnabled)
+    {
+        otel.UseAzureMonitor(
+            options => options.ConnectionString = azmoOptions.GetSection("ConnectionString").Get<string>());
+    }
+
+    if (otelEnabled)
+    {
+        otel.UseOtlpExporter(
+            otelOptions.GetRequiredSection("Protocol").Get<OtlpExportProtocol>(),
+            new(otelOptions.GetRequiredSection("EndpointUri").Get<string>()!));
+    }
 }
 
 #endregion
@@ -381,7 +386,10 @@
 app.MapHub<MonitorHub>("/hub/monitor");
 app.MapHub<AdminHub>("/hub/admin");
 
-app.MapPrometheusScrapingEndpoint();
+if (telemetryEnabled)
+{
+    app.MapPrometheusScrapingEndpoint();
+}
 
 app.MapFallbackToFile("index.html");