beam 3174 - open telemetry

client/Packages/com.beamable.server/CHANGELOG.md

@@ -6,11 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Changed
+- Open Telemetry configuration in base image.
 - Exposed methods for access to public player stats:
   - `GetPublicPlayerStat`
   - `GetPublicPlayerStats`
   - `GetAllPublicPlayerStats`
+- Inbound requests are rate limited to avoid out of memory failures. 
 
+### Added
+- Microservice message log size limit. 
 
 ## [1.6.2]
 ### Changed

client/Packages/com.beamable.server/Editor/DockerCommands/RunImageCommand.cs

@@ -172,6 +172,7 @@ public class RunServiceCommand : RunImageCommand
 		public const string ENV_WATCH_TOKEN = "WATCH_TOKEN";
 		public const string ENV_DISABLE_RUN_CUSTOM_HOOK = "DISABLE_CUSTOM_INITIALIZATION_HOOKS";
 		public const string ENV_DISABLE_EMOJI = "DOTNET_WATCH_SUPPRESS_EMOJIS";
+		public const string ENV_DISABLE_LOG_TRUNCATE = "DISABLE_LOG_TRUNCATE";
 
 		public RunServiceCommand(MicroserviceDescriptor service,
 								 string cid,
@@ -186,6 +187,9 @@ public class RunServiceCommand : RunImageCommand
 			PruneAfterStartup = true;
 			Environment = new Dictionary<string, string>()
 			{
+				// ["OTEL_EXPORTER_OTLP_ENDPOINT"] = "http://otel-collector:4317",
+				// ["EMIT_OTEL"] = "true",
+				// ["EMIT_OTEL_METRICS"] = "true",
 				[ENV_CID] = cid,
 				[ENV_PID] = pid,
 				[ENV_SECRET] = secret,
@@ -194,7 +198,8 @@ public class RunServiceCommand : RunImageCommand
 				[ENV_NAME_PREFIX] = MicroserviceIndividualization.Prefix,
 				[ENV_WATCH_TOKEN] = watch.ToString(),
 				[ENV_DISABLE_RUN_CUSTOM_HOOK] = (!shouldRunCustomHooks).ToString(),
-				[ENV_DISABLE_EMOJI] = "1"
+				[ENV_DISABLE_EMOJI] = "1",
+				[ENV_DISABLE_LOG_TRUNCATE] = "true"
 			};
 
 			if (_watch)
@@ -241,6 +246,12 @@ public class RunServiceCommand : RunImageCommand
 			}
 			MapDotnetCompileErrors();
 		}
+
+		// // this will enable sending otel data to a local running signoz instance. 
+		// protected override string GetCustomDockerFlags()
+		// {
+		// 	return "--net clickhouse-setup_default ";
+		// }
 
 	}
 

client/Packages/com.beamable.server/SharedRuntime/IBeamableServices.cs

@@ -16,6 +16,7 @@
 using Beamable.Server.Api.Social;
 using Beamable.Server.Api.Stats;
 using Beamable.Server.Api.Tournament;
+using beamable.server.Tracing;
 
 namespace Beamable.Server
 {
@@ -155,5 +156,10 @@ public interface IBeamableServices
 		/// %Microservice entry point for payment operations.
 		/// </summary>
 		IMicroservicePaymentsApi Payments { get; }
+
+		/// <summary>
+		/// Add custom tracing to client callables
+		/// </summary>
+		IBeamableTracer Tracing { get; }
 	}
 }

client/Packages/com.beamable.server/SharedRuntime/Tracing/BeamableTracer.cs

@@ -0,0 +1,82 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+
+namespace beamable.server.Tracing
+{
+
+	public interface IBeamableTracer
+	{
+		/// <summary>
+		/// Begin an Open Telemetry trace.
+		/// You must dispose the returned <see cref="IBeamTrace"/> to end the trace.
+		/// Consider a `using` statement. 
+		/// </summary>
+		/// <param name="name">The name of the trace</param>
+		/// <returns>A <see cref="IBeamTrace"/> object that can store additional meta information.</returns>
+		IBeamTrace Start(string name);
+
+		/// <summary>
+		/// Retrieve a <see cref="IBeamMetricCounter{T}"/> for the given name.
+		/// The first time this method is invoked per <see cref="name"/> value, a new instance will be created.
+		/// However, every subsequent invocation per <see cref="name"/> value will return the initial instance.
+		///
+		/// The <see cref="unit"/> and <see cref="description"/> fields applied on the first invocation will stay permanent. 
+		/// </summary>
+		/// <param name="name">The name of the metric. This should be unique.</param>
+		/// <param name="unit"></param>
+		/// <param name="description"></param>
+		/// <typeparam name="T">Must be a struct like type that is countable, like long, int, or double.</typeparam>
+		/// <returns>A <see cref="IBeamMetricCounter{T}"/> instance</returns>
+		IBeamMetricCounter<T> GetCounter<T>(string name, string unit=null, string description=null) where T : struct;
+	}
+
+	public interface IBeamTrace : IDisposable
+	{
+		/// <summary>
+		/// Set a tag value for the trace. 
+		/// </summary>
+		/// <param name="tagName">The name of the tag; should be unique. </param>
+		/// <param name="value">The value of the tag. It can be a string, or simple object such as int, long, or bool. Complex types won't be supported. </param>
+		public void SetTag(string tagName, object value);
+
+		/// <summary>
+		/// Set many tags as key value pairs. 
+		/// </summary>
+		/// <param name="tags">A set of <see cref="KeyValuePair{TKey,TValue}"/></param>
+		public void SetTags(IEnumerable<KeyValuePair<string, object>> tags);
+
+		/// <summary>
+		/// Mark the trace in an error state. 
+		/// </summary>
+		/// <param name="ex">The exception that caused the trace to fail.</param>
+		public void RecordException(Exception ex);
+	}
+
+	public interface IBeamMetricCounter<T> where T : struct
+	{
+		/// <summary>
+		/// adds the given value to the metric value. 
+		/// </summary>
+		/// <param name="value">How much to increment the metric by</param>
+		/// <param name="tags">An optional set of tags for the increase event</param>
+		void Add(T value, params KeyValuePair<string, object>[] tags);
+	}
+
+	public static class BeamMetricCounterExtensions
+	{
+		/// <summary>
+		/// Increment the given counter by 1.
+		/// </summary>
+		/// <param name="counter"></param>
+		/// <param name="tags">An optional set of tags for the event</param>
+		public static void Increment(this IBeamMetricCounter<int> counter, params KeyValuePair<string, object>[] tags) => counter.Add(1, tags);
+
+		/// <summary>
+		/// Increment the given counter by 1.
+		/// </summary>
+		/// <param name="counter"></param>
+		/// <param name="tags">An optional set of tags for the event</param>
+		public static void Increment(this IBeamMetricCounter<long> counter, params KeyValuePair<string, object>[] tags) => counter.Add(1, tags);
+	}
+}