Communicate.Archeo 0.3.0

Usage

This nuget package supports dependency injection and currently requires .net cores HttpClientFactory (a version using the old HttpClient is on the docket, as well as a version using the built in Microsoft log framework). You also need to define a IBackupLogger that logs failures when the primary logging fails. Let's begin with the IBackupLogger:

    public class BackupLogger : IBackupLogger
    {
        private string AiKey { get; set; }

        private TelemetryClient telemetryClient;

        public BackupLogger()
        {
            AiKey = Environment.GetEnvironmentVariable("APPINSIGHTS_INSTRUMENTATIONKEY", EnvironmentVariableTarget.Process);
            telemetryClient = new TelemetryClient() { InstrumentationKey = AiKey };
        }

        public void LogInformation(string log)
        {
            var evt = new EventTelemetry(log);
            telemetryClient.TrackEvent(evt);
        }

        public void LogError(string message, List<LogStep> logSteps)
        {
            telemetryClient.TrackTrace(message, new Dictionary<string, string>() { { "Logstep object", JsonConvert.SerializeObject(logSteps) } });
        }

        public void LogException(Exception e, List<LogStep> logSteps)
        {
            telemetryClient.TrackException(e, new Dictionary<string, string>() { { "Logstep object", JsonConvert.SerializeObject(logSteps) } });
        }
    }

This is a simple backup logger that uses Application Insights. As long as you override the required methods you can use any backup logger you want to.

Using DI

In your startup.cs you need to declare a HttpClient. You can name it whatever you want but a default name is supplied in the ArcheoDefaults constants class:

            services.AddHttpClient(ArcheoDefaults.HttpClientName, client =>
            {
                client.BaseAddress = new Uri(ArcheoDefaults.ArcheoEndpoint);
                client.DefaultRequestHeaders.Add("APIKEY", GetAppSetting("ArcheoApiKey"));
            });

You also need to add the IArcheLogger itself as a scoped service. You can use dependency injection to insert both the IHttpFactory and the IBackupLogger or you can supply them explicitly:

      services.AddScoped<IArcheoLogger>(sp => new ArcheoLogger(sp.GetService<IHttpClientFactory>(), new BackupLogger()));
      Or
      services.AddScoped<IBackupLogger, BackupLogger>();
      services.AddScoped<IArcheoLogger, ArcheoLogger>();

Setting up the logger

To avoid having to send every parameter every time you use the logger this nuget provides the Arche.LogBase object. This object is used if parameters supplied on logging are null. The LogBase should be instantiated as early in the pipeline as possible. You simply set the object like this:

            logger.LogBase = new ArcheoLogBase()
            {
                MessageType = messageType,
                Reciever = partyConfig.ReceiverId,
                Sender = partyConfig.SenderId,
                TransactionId = transactionId,
                TransactionTag = transactionTag,
                TransactionType = partyConfig.DocumentType
            };

Logging

If you set up the LogBase you only need 2-3 parameters when logging. If you need to override any of the LogBase params on only a single log entry just supply the parameter. This nuget provides 4 logging methods as of now. Please see the code comments for details. Here are some simple examples that only work if LogBase is used:

archeo.LogException((Exception)e, $"Exception occured in {nameof(test)}");
archeo.LogHttpFailure((HttpResponseMessage)result, "Sending file to APIM failed");
archeo.LogSuccess(encoding.GetBytes(fileContent), "File successfully downloaded", $"file.file");
archeo.LogFailure(fileContent, "Something failed")

Sending logs

After logging you share of logs you need to call await archeo.SendLogs(). This is usually done in the finallyclause in the catch all, but you are free to do this whenever you want. When logs are sent the list of logged steps is cleared but the LogBase is kept in case you want to log more withing the same scope. If you want to clear both objects you can call IArcheoLogger.Clear()