feature: add new server property to enable telemetry (#42)

stratdev3 · stratdev3 · commit 06654ae2e228 · 2025-09-08T23:25:02.000+02:00
diff --git a/documentation/docs/guide/observability.md b/documentation/docs/guide/observability.md
@@ -7,6 +7,7 @@ Observability is integrated through support for **OpenTelemetry**, the [open sta
 
 Logs are very useful for developer when coding.
 The following example shows how to :
+- [`EnableTelemetry `](../reference/simplewserver#telemetry)
 - subscribe to all SimpleW `Event` with `openTelemetryObserver()`
 - log each request to console with `LogProcessor` (do not use for production).
 
diff --git a/documentation/docs/reference/simplewserver.md b/documentation/docs/reference/simplewserver.md
@@ -376,6 +376,15 @@ bool AutoIndex { get; set; } = false;
 This property enable or disable the index feature which list files of a static 
 content directory when no file has been selected and `DefaultDocument` does not exists.
 
+## Telemetry
+
+```csharp
+/// <summary>
+/// True to enable telemetry
+/// </summary>
+public bool EnableTelemetry { get; set; } = false;
+```
+
 ## Statistics
 
 ```csharp
diff --git a/documentation/docs/snippets/observability-advanced.cs b/documentation/docs/snippets/observability-advanced.cs
@@ -16,6 +16,10 @@ static void Main() {
             openTelemetryObserver("SimpleW");
 
             var server = new SimpleWServer(IPAddress.Any, 2015);
+
+            // enable telemetry
+            server.EnableTelemetry = true;
+
             server.AddDynamicContent("/api");
             server.Start();
             Console.WriteLine("server started at http://localhost:2015/");
diff --git a/documentation/docs/snippets/observability.cs b/documentation/docs/snippets/observability.cs
@@ -16,6 +16,10 @@ static void Main() {
             openTelemetryObserver("SimpleW");
 
             var server = new SimpleWServer(IPAddress.Any, 2015);
+
+            // enable telemetry
+            server.EnableTelemetry = true;
+
             server.AddDynamicContent("/api");
             server.Start();
             Console.WriteLine("server started at http://localhost:2015/");
diff --git a/src/SimpleW/SimpleW/ISimpleWServer.cs b/src/SimpleW/SimpleW/ISimpleWServer.cs
@@ -111,6 +111,15 @@ public interface ISimpleWServer {
 
         #endregion cors
 
+        #region telemetry
+
+        /// <summary>
+        /// True to enable telemetry
+        /// </summary>
+        bool EnableTelemetry { get; set; }
+
+        #endregion telemetry
+
     }
 
 }
diff --git a/src/SimpleW/SimpleW/SimpleWSServer.cs b/src/SimpleW/SimpleW/SimpleWSServer.cs
@@ -44,15 +44,17 @@ public SimpleWSServer(SslContext context, IPAddress address, int port) : base(co
         /// </summary>
         /// <param name="error"></param>
         protected override void OnError(SocketError error) {
-            Activity? activity = source.StartActivity();
-            if (activity != null) {
-                activity.DisplayName = "Server OnError()";
-                activity.SetStatus(ActivityStatusCode.Error);
-                ActivityTagsCollection tagsCollection = new() {
-                    { "exception.type", nameof(SocketError) },
-                };
-                activity.AddEvent(new ActivityEvent("exception", default, tagsCollection));
-                activity.Stop();
+            if (EnableTelemetry) {
+                Activity? activity = source.StartActivity();
+                if (activity != null) {
+                    activity.DisplayName = "Server OnError()";
+                    activity.SetStatus(ActivityStatusCode.Error);
+                    ActivityTagsCollection tagsCollection = new() {
+                        { "exception.type", nameof(SocketError) },
+                    };
+                    activity.AddEvent(new ActivityEvent("exception", default, tagsCollection));
+                    activity.Stop();
+                }
             }
         }
 
@@ -456,6 +458,11 @@ public void AddCORS(string origin="*", string headers = "*", string methods = "G
 
         #region OpenTelemetry
 
+        /// <summary>
+        /// True to enable telemetry
+        /// </summary>
+        public bool EnableTelemetry { get; set; } = false;
+
         /// <summary>
         /// ActivitySource
         /// </summary>
diff --git a/src/SimpleW/SimpleW/SimpleWSSession.cs b/src/SimpleW/SimpleW/SimpleWSSession.cs
@@ -248,14 +248,16 @@ public override void OnWsDisconnected() {
         /// </summary>
         /// <param name="error"></param>
         protected override void OnError(SocketError error) {
-            Activity? activity = CreateActivity();
-            SetDefaultActivity(activity, "Session OnError()", Id);
-            activity.SetStatus(ActivityStatusCode.Error);
-            ActivityTagsCollection tagsCollection = new() {
+            if (server.EnableTelemetry) {
+                Activity? activity = CreateActivity();
+                SetDefaultActivity(activity, "Session OnError()", Id);
+                activity.SetStatus(ActivityStatusCode.Error);
+                ActivityTagsCollection tagsCollection = new() {
                     { "exception.type", nameof(SocketError) },
-            };
-            activity.AddEvent(new ActivityEvent("exception", default, tagsCollection));
-            activity.Stop();
+                };
+                activity.AddEvent(new ActivityEvent("exception", default, tagsCollection));
+                activity.Stop();
+            }
         }
 
         /// <summary>
@@ -281,7 +283,7 @@ protected override void OnDisconnected() {
         /// </summary>
         /// <returns></returns>
         protected Activity? CreateActivity() {
-            return ActivitySource.StartActivity();
+            return server.EnableTelemetry ? ActivitySource.StartActivity() : null;
         }
 
         /// <summary>
diff --git a/src/SimpleW/SimpleW/SimpleWServer.cs b/src/SimpleW/SimpleW/SimpleWServer.cs
@@ -43,15 +43,17 @@ public SimpleWServer(IPAddress address, int port) : base(address, port) { }
         /// </summary>
         /// <param name="error"></param>
         protected override void OnError(SocketError error) {
-            Activity? activity = source.StartActivity();
-            if (activity != null) {
-                activity.DisplayName = "Server OnError()";
-                activity.SetStatus(ActivityStatusCode.Error);
-                ActivityTagsCollection tagsCollection = new() {
-                    { "exception.type", nameof(SocketError) },
-                };
-                activity.AddEvent(new ActivityEvent("exception", default, tagsCollection));
-                activity.Stop();
+            if (EnableTelemetry) {
+                Activity? activity = source.StartActivity();
+                if (activity != null) {
+                    activity.DisplayName = "Server OnError()";
+                    activity.SetStatus(ActivityStatusCode.Error);
+                    ActivityTagsCollection tagsCollection = new() {
+                        { "exception.type", nameof(SocketError) },
+                    };
+                    activity.AddEvent(new ActivityEvent("exception", default, tagsCollection));
+                    activity.Stop();
+                }
             }
         }
 
@@ -455,6 +457,11 @@ public void AddCORS(string origin="*", string headers = "*", string methods = "G
 
         #region OpenTelemetry
 
+        /// <summary>
+        /// True to enable telemetry
+        /// </summary>
+        public bool EnableTelemetry { get; set; } = false;
+
         /// <summary>
         /// ActivitySource
         /// </summary>
diff --git a/src/SimpleW/SimpleW/SimpleWSession.cs b/src/SimpleW/SimpleW/SimpleWSession.cs
@@ -248,14 +248,16 @@ public override void OnWsDisconnected() {
         /// </summary>
         /// <param name="error"></param>
         protected override void OnError(SocketError error) {
-            Activity? activity = CreateActivity();
-            SetDefaultActivity(activity, "Session OnError()", Id);
-            activity.SetStatus(ActivityStatusCode.Error);
-            ActivityTagsCollection tagsCollection = new() {
+            if (server.EnableTelemetry) {
+                Activity? activity = CreateActivity();
+                SetDefaultActivity(activity, "Session OnError()", Id);
+                activity.SetStatus(ActivityStatusCode.Error);
+                ActivityTagsCollection tagsCollection = new() {
                     { "exception.type", nameof(SocketError) },
-            };
-            activity.AddEvent(new ActivityEvent("exception", default, tagsCollection));
-            activity.Stop();
+                };
+                activity.AddEvent(new ActivityEvent("exception", default, tagsCollection));
+                activity.Stop();
+            }
         }
 
         /// <summary>
@@ -281,7 +283,7 @@ protected override void OnDisconnected() {
         /// </summary>
         /// <returns></returns>
         protected Activity? CreateActivity() {
-            return ActivitySource.StartActivity();
+            return server.EnableTelemetry ? ActivitySource.StartActivity() : null;
         }
 
         /// <summary>

Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,15 @@ public interface ISimpleWServer {`
`111`	`111`
`112`	`112`	`#endregion cors`
`113`	`113`
	`114`	`+ #region telemetry`
	`115`	`+`
	`116`	`+ /// <summary>`
	`117`	`+ /// True to enable telemetry`
	`118`	`+ /// </summary>`
	`119`	`+ bool EnableTelemetry { get; set; }`
	`120`	`+`
	`121`	`+ #endregion telemetry`
	`122`	`+`
`114`	`123`	`}`
`115`	`124`
`116`	`125`	`}`