esigs.dora.lib 1.0.0

Dora Metrics Tracker

Overview

The Dora Metrics Tracker is a .NET library designed to help track key DORA (DevOps Research and Assessment) metrics: Deployment Frequency, Lead Time for Changes, Change Failure Rate, and Mean Time to Recovery. It provides a flexible interface (IDoraMetricsTracker) with different implementations for storing and retrieving these metrics, including an in-memory solution and a file-based JSON storage solution.

Features

• Track DORA Metrics: Record deployments and incidents to calculate core DORA metrics.
• Flexible Storage: Choose between in-memory tracking for quick testing/prototyping or file-based JSON storage for persistence.
• Extensible: Easily implement new storage mechanisms by adhering to the IDoraMetricsTracker interface.
• Dependency Injection Friendly: Designed for seamless integration with dependency injection containers.

Getting Started

Prerequisites

• .NET SDK (Version 9.0 or later recommended)

Building the Project

To build the entire solution, navigate to the project's root directory and run:

dotnet build DoraSolution.sln

Running Tests

To execute all unit tests, run the following command from the project's root directory:

dotnet test DoraSolution.sln

Usage

The core functionality is exposed through the IDoraMetricsTracker interface. You can inject an implementation of this interface into your application.

Example (Conceptual)

// Example of how to use the IDoraMetricsTracker (actual setup depends on your DI container)
public class MyService
{
    private readonly IDoraMetricsTracker _metricsTracker;

    public MyService(IDoraMetricsTracker metricsTracker)
    {
        _metricsTracker = metricsTracker;
    }

    public void PerformDeployment()
    {
        // ... perform deployment logic ...

        // Record a successful deployment
        var result = _metricsTracker.RecordDeployment(DateTime.UtcNow, true, TimeSpan.FromHours(2));
        if (result.IsFailure)
        {
            Console.WriteLine($"Failed to record deployment: {result.Error}");
        }
    }

    public void AnalyzeMetrics()
    {
        var startDate = DateTime.UtcNow.AddMonths(-1);
        var endDate = DateTime.UtcNow;

        var deploymentFrequency = _metricsTracker.GetDeploymentFrequency(startDate, endDate);
        if (deploymentFrequency.IsSuccess)
        {
            Console.WriteLine($"Deployment Frequency: {deploymentFrequency.Value}");
        }

        // ... similar calls for other metrics ...
    }
}

Available Implementations

• InMemoryDoraMetricsTracker: Stores all metrics data in memory. Ideal for short-lived applications or testing.
• FileBasedDoraMetricsTracker: Persists metrics data to a JSON file. Requires configuration via DoraFileStorageOptions.

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.