UnrealEngineUWP/Engine/Source/Programs/Horde/HordeServer/Models/LogEvent.cs

// Copyright Epic Games, Inc. All Rights Reserved.

using HordeCommon;
using HordeCommon.Rpc;
using Microsoft.Extensions.Logging;
using MongoDB.Bson;
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Text.Json;
using System.Threading.Tasks;

namespace HordeServer.Models
{
	/// <summary>
	/// Interface for a log event line
	/// </summary>
	public interface ILogEventLine
	{
		/// <summary>
		/// Log level
		/// </summary>
		LogLevel Level { get; }

		/// <summary>
		/// The event id
		/// </summary>
		EventId? EventId { get; }

		/// <summary>
		/// The complete rendered message, in plaintext
		/// </summary>
		string Message { get; }

		/// <summary>
		/// Data for the line
		/// </summary>
		JsonElement Data { get; }
	}

	/// <summary>
	/// Interface for event data
	/// </summary>
	public interface ILogEventData
	{
		/// <summary>
		/// The log level
		/// </summary>
		EventSeverity Severity { get; }

		/// <summary>
		/// The type of event
		/// </summary>
		EventId? EventId { get; }

		/// <summary>
		/// The complete rendered message, in plaintext
		/// </summary>
		string Message { get; }

		/// <summary>
		/// Gets this event data as a BSON document
		/// </summary>
		IReadOnlyList<ILogEventLine> Lines { get; }
	}

	/// <summary>
	/// Represents a node in the graph
	/// </summary>
	public interface ILogEvent
	{
		/// <summary>
		/// Unique id of the log containing this event
		/// </summary>
		public ObjectId LogId { get; }

		/// <summary>
		/// Severity of the event
		/// </summary>
		public EventSeverity Severity { get; }

		/// <summary>
		/// Index of the first line for this event
		/// </summary>
		public int LineIndex { get; }

		/// <summary>
		/// Number of lines in the event
		/// </summary>
		public int LineCount { get; }

		/// <summary>
		/// Span id for this log event
		/// </summary>
		public ObjectId? SpanId { get; }
	}

	/// <summary>
	/// Represents a node in the graph
	/// </summary>
	public class NewLogEventData
	{
		/// <summary>
		/// Unique id of the log containing this event
		/// </summary>
		public ObjectId LogId { get; set; }

		/// <summary>
		/// Severity of the event
		/// </summary>
		public EventSeverity Severity { get; set; }

		/// <summary>
		/// Index of the first line for this event
		/// </summary>
		public int LineIndex { get; set; }

		/// <summary>
		/// Number of lines in the event
		/// </summary>
		public int LineCount { get; set; }

		/// <summary>
		/// The span this this event belongs to
		/// </summary>
		public ObjectId? SpanId { get; set; }
	}
}