CapedLog.core 2.2.4

Container of log

Implementation of a container for storing logs.

Each container has a maximum number of records upon reaching which writing to the container becomes impossible until the external reader processes all the records from the container. This allows you to avoid memory overflow while increasing the flow of messages in the log between the operations of processing the log data (saving to disk or sending over the network).

Additionally, each container can have meta-information (a set of static and dynamic labels)

var log = new CapedLog.CapedLog();
var conf = new CapedLog.CapedLogConf(new[] { new KeyValuePair<string, string>("const_label_name", "const_label_value") }, new[] { "dynamic_label_name1", "dynamic_label_name2" }, 10);
var container = log.GetOrCreate(conf);
var metric = container.GetMetric(new[] { "dynamic_label_value1", "dynamic_label_value2" });
metric.TryEnqueue(() => CapedLog.CapedLogMessage.Create("msg1"));
metric.TryEnqueue(() => CapedLog.CapedLogMessage.Create("msgN"));

Scrape log messages process

To collect accumulated messages in the log, you must implement a background message processing process that will be periodically started

class MyScrapeProcess : CapedLog.IScrapeProcess
{
    public Task<int> Send(IReadOnlyList<CapedLog.CapedLogMetric> metrics, CancellationToken cancellation)
    {
        var result = 0;
        var temp = new List<CapedLog.CapedLogMessage>();
        foreach (var metric in metrics)
        {
            if (metric.DequeueAll(temp) == 0)
                continue;

            //Do something

            result += temp.Count;
            temp.Clear();
        }

        return Task.FromResult(result);
    }
}

...

var log = new CapedLog.CapedLog();
var conf = new CapedLog.CapedLogConfBuilder()
    .AddConstLabel("foo", "1")
    .SetDefaultCapacity(10)
    .Build();
var container = log.GetOrCreate(conf);
var scrape = CapedLog.CapedLogScrape.CreateScrape(log, new MyScrapeProcess());
var metric = container.GetMetric(Array.Empty<string>());
var cancellation = new CancellationTokenSource();

//Sending messages to the log
metric.TryEnqueue(() => CapedLog.CapedLogMessage.Create("msg1"));
metric.TryEnqueue(() => CapedLog.CapedLogMessage.Create("msgN"));

// Periodic collection of messages from the log
var myScrapeProcessResult = scrape(cancellation.Token).Result;

Assert.AreEqual(2, myScrapeProcessResult);