File: TcpEndpointProbesExtensions.cs
Web Access
Project: src\src\Libraries\Microsoft.Extensions.Diagnostics.Probes\Microsoft.Extensions.Diagnostics.Probes.csproj (Microsoft.Extensions.Diagnostics.Probes)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.Extensions.Diagnostics.Probes;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Options;
using Microsoft.Shared.Diagnostics;
 
namespace Microsoft.Extensions.DependencyInjection;
 
/// <summary>
/// Extension methods for setting up TCP-based health check probes.
/// </summary>
public static class TcpEndpointProbesExtensions
{
    /// <summary>
    /// Registers health status reporting using a TCP port
    /// if service is considered as healthy <see cref="IHealthCheck"/>.
    /// </summary>
    /// <param name="services">The <see cref="IServiceCollection" /> to add the services to.</param>
    /// <returns>The value of <paramref name="services"/>.</returns>
    public static IServiceCollection AddTcpEndpointProbe(this IServiceCollection services)
    {
        _ = Throw.IfNull(services);
 
        return services.AddTcpEndpointProbe(Microsoft.Extensions.Options.Options.DefaultName);
    }
 
    /// <summary>
    /// Registers health status reporting using a TCP port
    /// if service is considered as healthy <see cref="IHealthCheck"/>.
    /// </summary>
    /// <param name="services">The <see cref="IServiceCollection" /> to add the services to.</param>
    /// <param name="name">Name used to retrieve the options.</param>
    /// <returns>The value of <paramref name="services"/>.</returns>
    public static IServiceCollection AddTcpEndpointProbe(this IServiceCollection services, string name)
    {
        _ = Throw.IfNull(services);
 
        _ = services.AddHealthChecks();
 
        _ = services
            .AddOptionsWithValidateOnStart<TcpEndpointProbesOptions, TcpEndpointProbesOptionsValidator>(name);
 
        _ = services.AddSingleton<IHostedService>(provider =>
        {
            var options = provider.GetRequiredService<IOptionsMonitor<TcpEndpointProbesOptions>>().Get(name);
            return ActivatorUtilities.CreateInstance<TcpEndpointProbesService>(provider, options);
        });
 
        return services;
    }
 
    /// <summary>
    /// Registers health status reporting using a TCP port
    /// if service is considered as healthy <see cref="IHealthCheck"/>.
    /// </summary>
    /// <param name="services">The <see cref="IServiceCollection" /> to add the services to.</param>
    /// <param name="configure">Configuration for <see cref="TcpEndpointProbesOptions"/>.</param>
    /// <returns>The value of <paramref name="services"/>.</returns>
    public static IServiceCollection AddTcpEndpointProbe(
        this IServiceCollection services,
        Action<TcpEndpointProbesOptions> configure)
    {
        _ = Throw.IfNull(services);
        _ = Throw.IfNull(configure);
 
        _ = services.Configure(configure);
 
        return services.AddTcpEndpointProbe();
    }
 
    /// <summary>
    /// Registers health status reporting using a TCP port
    /// if service is considered as healthy <see cref="IHealthCheck"/>.
    /// </summary>
    /// <param name="services">The <see cref="IServiceCollection" /> to add the services to.</param>
    /// <param name="name">Name for the options.</param>
    /// <param name="configure">Configuration for <see cref="TcpEndpointProbesOptions"/>.</param>
    /// <returns>The value of <paramref name="services"/>.</returns>
    public static IServiceCollection AddTcpEndpointProbe(
        this IServiceCollection services,
        string name,
        Action<TcpEndpointProbesOptions> configure)
    {
        _ = Throw.IfNull(services);
        _ = Throw.IfNull(configure);
 
        _ = services.Configure(name, configure);
 
        return services.AddTcpEndpointProbe(name);
    }
 
    /// <summary>
    /// Registers health status reporting using a TCP port
    /// if service is considered as healthy <see cref="IHealthCheck"/>.
    /// </summary>
    /// <param name="services">The <see cref="IServiceCollection" /> to add the services to.</param>
    /// <param name="configurationSection">Configuration for <see cref="TcpEndpointProbesOptions"/>.</param>
    /// <returns>The value of <paramref name="services"/>.</returns>
    public static IServiceCollection AddTcpEndpointProbe(
        this IServiceCollection services,
        IConfigurationSection configurationSection)
    {
        _ = Throw.IfNull(services);
        _ = Throw.IfNull(configurationSection);
 
        _ = services.Configure<TcpEndpointProbesOptions>(configurationSection);
 
        return services.AddTcpEndpointProbe();
    }
 
    /// <summary>
    /// Registers health status reporting using a TCP port
    /// if service is considered as healthy <see cref="IHealthCheck"/>.
    /// </summary>
    /// <param name="services">The <see cref="IServiceCollection" /> to add the services to.</param>
    /// <param name="name">Name for the options.</param>
    /// <param name="configurationSection">Configuration for <see cref="TcpEndpointProbesOptions"/>.</param>
    /// <returns>The value of <paramref name="services"/>.</returns>
    public static IServiceCollection AddTcpEndpointProbe(
        this IServiceCollection services,
        string name,
        IConfigurationSection configurationSection)
    {
        _ = Throw.IfNull(services);
        _ = Throw.IfNull(configurationSection);
 
        _ = services.Configure<TcpEndpointProbesOptions>(name, configurationSection);
 
        return services.AddTcpEndpointProbe(name);
    }
}