A dotnet client library for the KMD Logic billing, which allows applications to record consumption metrics reliably and securely.

The KMD Logic Consumption client utilises many modern concepts from Serilog and Seq, such as Message Templates and ingestion endpoints capable of understanding CLEF.

In projects or components where you need to generate consumption metrics, add a NuGet package reference to Kmd.Logic.Consumption.Client.

Use the IConsumptionMetrics interface like this:

consumptionClient
    .ForSubscriptionOwnerContext("ReportableField", "Anything")
    .ForInternalContext("EventNumber", $"{eventNumber}")
    .Record(
        subscriptionId: subscriptionId,
        resourceId: resourceId,
        meter: "SMS/BYO/Send SMS",
        amount: 1,
	consumedDatetime : DatetimeOffset.Now,
        reason: "Just testing");

Use the IReservedCapacityMetrics interface like this:

var contextReservedCapacity = reservedCapaty
    .ForSubscriptionOwnerContext("ReportableField", "Anything")
    .ForInternalContext("EventNumber", $"{eventNumber}");

// Increase - Reserve capacity
contextReservedCapacity
    .Increase(
        subscriptionId: subscriptionId,
        resourceId: resourceId,
        meter: "Audit/Instance/Capacity",
        amount: 1,
        dateTime: DateTimeOffset.Now);

// Decrease - release capacity
contextReservedCapacity
    .Decrease(
        subscriptionId: subscriptionId,
        resourceId: resourceId,
        meter: "Audit/Instance/Capacity",
        amount: 1,
        dateTime: DateTimeOffset.Now);

To register AuditClientConsumptionMetricsDestination or AuditClientReservedCapacityMetricsDestination you have to register also the IAudit interface from KMD Logic Audit Client.

If you are developing locally, we recommend using Kmd.Logic.Audit.Client.SerilogSeq.SerilogSeqAuditClient and install Seq as the backend. To use Logic as the backend, you must choose Kmd.Logic.Audit.Client.SerilogAzureEventHubs.SerilogAzureEventHubsAuditClient as the implementation of IAudit.

Since the client implementations are thread-safe and require disposal, it would be appropriate to use a singleton lifetime in a DI container and allow the DI container to dispose of it upon application shut down.

Use SerilogAzureEventHubsAuditClient as an implementation of the IAudit interface like this:

var auditClientConfig = new SerilogSeqAuditClientConfiguration
{
    ServerUrl = config.Ingestion.Endpoint,
    ApiKey = config.Ingestion.ApiKey,
    EnrichFromLogContext = config.Client.EnrichFromLogContext,
};

services.AddSingleton(auditClientConfig);
services.AddSingleton<IAudit, SerilogSeqAuditClient>();

Use AuditClientConsumptionMetricsDestination as an implementation of the IConsumptionMetricsDestination interface like this:

services.AddSingleton<IConsumptionMetricsDestination, AuditClientConsumptionMetricsDestination>();

Use AuditClientReservedCapacityMetricsDestination as an implementation of the IReservedCapacityMetricsDestination interface like this:

services.AddSingleton<IConsumptionMetricsDestination, AuditClientReservedCapacityMetricsDestination>();

NOTE: We have implemented this functionality initially by reusing Serilog, the Seq sink and the KMD Logic Audit Client. We intend to publish a version of this client library in the future that has no such external dependencies. If this issue impacts you negatively, please let us know so that we can prioritise appropriately.

TODO

Contact us at discover@kmdlogic.io for more information.