ironservices
/
irontelemetry-dotnet
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

UserJourney

This commit is contained in:
Admin 2025-12-26 06:14:09 -05:00
parent 64177a5434
commit 2a6b68ba6d
4 changed files with 120 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
IronTelemetry.Client.csproj
View File

@ -5,6 +5,7 @@
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<PackageOutputPath>C:\Users\logik\Dropbox\Nugets</PackageOutputPath>
<!-- NuGet Package Properties -->
<PackageId>IronTelemetry.Client</PackageId>
@ -17,6 +18,7 @@
<RepositoryUrl>https://github.com/ironservices/irontelemetry-client</RepositoryUrl>
<PackageProjectUrl>https://www.irontelemetry.com</PackageProjectUrl>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageIcon>nuget_it.png</PackageIcon>
</PropertyGroup>
<ItemGroup>
@ -24,6 +26,12 @@
</ItemGroup>
<ItemGroup>
<None Include="nuget_it.png">
<Pack>true</Pack>
<PackagePath>\</PackagePath>
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
<Visible>true</Visible>
</None>
<None Include="README.md" Pack="true" PackagePath="\" Condition="Exists('README.md')" />
</ItemGroup>

50
IronTelemetry.cs
View File

@ -1,3 +1,5 @@
using System.Diagnostics;
namespace IronTelemetry.Client;
/// <summary>
@ -9,6 +11,31 @@ public static class IronTelemetry
{
private static TelemetryClient? _client;
private static readonly object _lock = new();
private static bool _enableDebugLogging;
/// <summary>
/// Enable verbose debug output during development.
/// When enabled, all events are written to System.Diagnostics.Debug.WriteLine.
/// </summary>
/// <example>
/// IronTelemetry.EnableDebugLogging = true; // Enable during development
/// </example>
public static bool EnableDebugLogging
{
get => _enableDebugLogging;
set => _enableDebugLogging = value;
}
/// <summary>
/// Writes a debug message if EnableDebugLogging is true.
/// </summary>
internal static void DebugLog(string message)
{
if (_enableDebugLogging)
{
Debug.WriteLine($"[IronTelemetry] {message}");
}
}
/// <summary>
/// Initialize IronTelemetry with a DSN.
@ -61,6 +88,29 @@ public static class IronTelemetry
_client!.CaptureMessage(message, level);
}
/// <summary>
/// Log a message with a title, message, and optional metadata.
/// This is useful for debugging and informational logging without exceptions.
/// </summary>
/// <param name="level">Log level: "info", "warning", "error", "debug"</param>
/// <param name="title">Short title for the log entry</param>
/// <param name="message">Detailed message (optional)</param>
/// <param name="data">Optional additional data</param>
public static void LogMessage(string level, string title, string? message = null, Dictionary<string, object>? data = null)
{
EnsureInitialized();
_client!.LogMessage(level, title, message, data);
}
/// <summary>
/// Get all current breadcrumbs. Useful for viewing breadcrumbs in a debug UI.
/// </summary>
public static IReadOnlyList<Breadcrumb> GetBreadcrumbs()
{
EnsureInitialized();
return _client!.GetBreadcrumbs();
}
/// <summary>
/// Add a breadcrumb to the current context.
/// </summary>

101
TelemetryClient.cs
View File

@ -1,4 +1,5 @@
using System.Collections.Concurrent;
using System.Diagnostics;
using System.Net.Http.Json;
using System.Runtime.InteropServices;
using System.Text.Json;
@ -127,7 +128,7 @@ public class TelemetryClient : IDisposable
StepId = currentStep?.StepId,
TraceId = context?.TraceId,
SpanId = context?.SpanId,
Breadcrumbs = GetBreadcrumbs(),
Breadcrumbs = GetBreadcrumbPayloads(),
Metadata = MergeMetadata(context?.Extras, currentJourney?.Metadata)
};
@ -143,23 +144,43 @@ public class TelemetryClient : IDisposable
_pendingItems.Enqueue(item);
AddToLocalLog(item);
if (_options.Debug)
{
var journeyInfo = currentJourney != null ? $" (journey: {currentJourney.Name})" : "";
Console.WriteLine($"[IronTelemetry] Captured exception: {ex.GetType().Name}: {ex.Message}{journeyInfo}");
}
var journeyInfo = currentJourney != null ? $" (journey: {currentJourney.Name})" : "";
LogDebug($"Captured exception: {ex.GetType().Name}: {ex.Message}{journeyInfo}");
}
public void CaptureMessage(string message, TelemetryLevel level)
{
LogMessage(level.ToString(), message, null, null);
}
/// <summary>
/// Log a message with a title, message, and optional metadata.
/// This is useful for debugging and informational logging without exceptions.
/// </summary>
/// <param name="level">Log level: "info", "warning", "error", "debug"</param>
/// <param name="title">Short title for the log entry</param>
/// <param name="message">Detailed message</param>
/// <param name="data">Optional additional data</param>
public void LogMessage(string level, string title, string? message = null, Dictionary<string, object>? data = null)
{
var currentJourney = JourneyContext.Current;
var currentStep = JourneyContext.CurrentStep;
var metadata = new Dictionary<string, object>(_extras);
if (data != null)
{
foreach (var kvp in data)
{
metadata[kvp.Key] = kvp.Value;
}
}
var item = new EnvelopeItem
{
Type = "message",
ExceptionType = level.ToString(),
Message = message,
ExceptionType = level,
Name = title,
Message = message ?? title,
AppVersion = _options.AppVersion,
AppBuild = _options.AppBuild,
Environment = _options.Environment,
@ -167,12 +188,14 @@ public class TelemetryClient : IDisposable
UserEmail = currentJourney?.UserEmail ?? _userEmail,
JourneyId = currentJourney?.JourneyId,
StepId = currentStep?.StepId,
Breadcrumbs = GetBreadcrumbs(),
Metadata = new Dictionary<string, object>(_extras)
Breadcrumbs = GetBreadcrumbPayloads(),
Metadata = metadata
};
_pendingItems.Enqueue(item);
AddToLocalLog(item);
LogDebug($"[{level.ToUpperInvariant()}] {title}: {message}");
}
public void AddBreadcrumb(Breadcrumb breadcrumb)
@ -234,10 +257,7 @@ public class TelemetryClient : IDisposable
_pendingItems.Enqueue(item);
AddToLocalLog(item);
if (_options.Debug)
{
Console.WriteLine($"[IronTelemetry] Started journey: {journey.Name} ({journey.JourneyId})");
}
LogDebug($"Started journey: {journey.Name} ({journey.JourneyId})");
}
internal void EnqueueJourneyEnd(JourneyScope journey)
@ -256,10 +276,7 @@ public class TelemetryClient : IDisposable
_pendingItems.Enqueue(item);
AddToLocalLog(item);
if (_options.Debug)
{
Console.WriteLine($"[IronTelemetry] Ended journey: {journey.Name} ({journey.Status})");
}
LogDebug($"Ended journey: {journey.Name} ({journey.Status})");
}
internal void EnqueueStepStart(StepScope step, string journeyId)
@ -277,10 +294,7 @@ public class TelemetryClient : IDisposable
_pendingItems.Enqueue(item);
AddToLocalLog(item);
if (_options.Debug)
{
Console.WriteLine($"[IronTelemetry] Started step: {step.Name}");
}
LogDebug($"Started step: {step.Name}");
}
internal void EnqueueStepEnd(StepScope step, string journeyId)
@ -304,10 +318,7 @@ public class TelemetryClient : IDisposable
_pendingItems.Enqueue(item);
AddToLocalLog(item);
if (_options.Debug)
{
Console.WriteLine($"[IronTelemetry] Ended step: {step.Name} ({step.Status})");
}
LogDebug($"Ended step: {step.Name} ({step.Status})");
}
#endregion
@ -349,10 +360,7 @@ public class TelemetryClient : IDisposable
// Queue for retry
_offlineQueue.Enqueue(items);
if (_options.Debug)
{
Console.WriteLine($"[IronTelemetry] Queued {items.Count} items for offline retry");
}
LogDebug($"Queued {items.Count} items for offline retry");
}
}
finally
@ -373,19 +381,13 @@ public class TelemetryClient : IDisposable
var response = await _httpClient.PostAsJsonAsync(url, envelope, JsonOptions);
if (_options.Debug)
{
Console.WriteLine($"[IronTelemetry] Sent {items.Count} items, status: {response.StatusCode}");
}
LogDebug($"Sent {items.Count} items, status: {response.StatusCode}");
return response.IsSuccessStatusCode;
}
catch (Exception ex)
{
if (_options.Debug)
{
Console.WriteLine($"[IronTelemetry] Failed to send: {ex.Message}");
}
LogDebug($"Failed to send: {ex.Message}");
return false;
}
}
@ -421,7 +423,12 @@ public class TelemetryClient : IDisposable
return true;
}
private List<BreadcrumbPayload> GetBreadcrumbs()
/// <summary>
/// Get all current breadcrumbs. Useful for viewing breadcrumbs in a debug UI.
/// </summary>
public IReadOnlyList<Breadcrumb> GetBreadcrumbs() => _breadcrumbs.ToArray();
private List<BreadcrumbPayload> GetBreadcrumbPayloads()
{
return _breadcrumbs.Select(b => new BreadcrumbPayload
{
@ -488,6 +495,22 @@ public class TelemetryClient : IDisposable
return (baseUrl, publicKey);
}
/// <summary>
/// Write a debug log message. Uses Debug.WriteLine if EnableDebugLogging is set,
/// otherwise Console.WriteLine if options.Debug is set.
/// </summary>
private void LogDebug(string message)
{
if (IronTelemetry.EnableDebugLogging)
{
Debug.WriteLine($"[IronTelemetry] {message}");
}
else if (_options.Debug)
{
Console.WriteLine($"[IronTelemetry] {message}");
}
}
}
/// <summary>

BIN
nuget_it.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.0 KiB