Avenged.AspNetCore.HealthChecks.Typesense 1.0.0

Typesense Health Checks

A lightweight .NET health check extension for monitoring the availability of your Typesense service.

Easily integrate into ASP.NET Core Health Checks to ensure your Typesense instance is responsive and healthy.

✨ Features

• Adds a HealthCheck for Typesense using ASP.NET Core's health checks system.
• Supports both synchronous and asynchronous client factories.
• Uses ListKeys as a lightweight and reliable health probe.
• Customizable name, failure status, tags, and timeout.
• Compatible with Microsoft.Extensions.Diagnostics.HealthChecks.

📦 Installation

Install via NuGet:

dotnet add package Avenged.AspNetCore.HealthChecks.Typesense

⚙️ Requirements

• .NET Standard 2.1 or .NET 6.0+
• A configured ITypesenseClient (from Typesense.Net)

<PackageReference Include="Typesense.Net" />
<PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" />

🚀 Getting Started

1. Configure your ITypesenseClient

Register your ITypesenseClient using DI:

services.AddSingleton<ITypesenseClient>(_ =>
    new TypesenseClient(new Configuration
    {
        ApiKey = "your-api-key",
        Nodes = new[] { new Node("https", "localhost", "8108") },
        ConnectionTimeout = TimeSpan.FromSeconds(5)
    }));

2. Add the health check

You can add the health check using either the sync or async factory:

Option A: Using DI-registered client

services.AddHealthChecks()
        .AddTypesense();

Option B: Using a custom factory (sync)

services.AddHealthChecks()
        .AddTypesense(sp =>
        {
            var config = new Configuration { ApiKey = "...", Nodes = ... };
            return new TypesenseClient(config);
        });

Option C: Using a custom factory (async)

services.AddHealthChecks()
        .AddTypesense(async sp =>
        {
            await Task.Delay(100); // any async initialization
            return new TypesenseClient(new Configuration { ... });
        });

🔍 How It Works

• TypesenseHealthCheck tries to list the API keys via ListKeys() to confirm the Typesense server is reachable and responsive.
• The health check will return:
  • Healthy if the request completes successfully.
  • Unhealthy if any exception occurs (e.g., connection failure, timeout, auth error).

🧪 Example Use Case

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddHealthChecks()
                .AddTypesense();

var app = builder.Build();

app.MapHealthChecks("/health");

app.Run();

⚙️ Customization

You can customize the health check registration:

services.AddHealthChecks()
        .AddTypesense(
            name: "typesense-api",
            failureStatus: HealthStatus.Degraded,
            tags: new[] { "search", "typesense" },
            timeout: TimeSpan.FromSeconds(3));

📄 License

This project is licensed under the MIT License.