SlugEnt.APIInfo 1.2.0-beta-01

APIInfo

Provides some of the functionality that the Steeltoe Management Health library did. I was having issues with that library consistently running as well as difficulty with some of the documentation. I also wanted some other features.

Simplified Use

You just need to make a couple of additions to your hostbuilder to add an object and then a couple of entries to startup.cs to add them to the pipeline.

public static IHostBuilder CreateHostBuilder(string[] args) =>
	Host.CreateDefaultBuilder(args)
		.ConfigureServices((hostContext, services) => {
			// Set APIInfo Object and override the default root path to infotest...
			// You typically would not override the default, this just shows you can.
			APIInfoBase apiInfoBase = new ("infotest");

			services.AddSingleton<IAPIInfoBase>(apiInfoBase);

			// Add a SimpleInfo retriever - Host Information
			services.AddTransient<ISimpleInfoRetriever, SimpleRetrieverHostInfo>();

The APIInfoBase object is required as is the services.AddSingleton<IAPIInfoBase>(apiInfoBase) line. The AddConfigHideCriteria is an optional piece discussed later.

The startup.cs file needs the following additions:

app.UseEndpoints(endpoints =>
{		
	endpoints.MapControllers();
	endpoints.MapSlugEntPing();
	endpoints.MapSlugEntSimpleInfo();
	endpoints.MapSlugEntConfig();
});

The endpoints.MapSlug... lines just activate various endpoint info.

MapSlugEntPing

Provides a very simple response in the form of ping...pong. Just tells you the service is responding and working. Can use it for automations that just need to know is the service is responding or not.

Default Endpoint:

/info/ping

MapSlugEntSimpleInfo

Provides some basic information about the service that you can customize. The simple info page can be divided into sections with each section getting customized information from a class you write.

Default Endpoint:

/info/simple

MapSlugEntConfig

Provides configuration (IConfiguration) related information about the API service that it has while running. You have to be careful with this module as it will display your entire Configuration object. It therefore provides the ability to match on entire Key names or partial key names to hide values that you do not wish displayed. Values that are marked hidden are never sent to the web page, but instead are replaced with the word HIDDEN. They therefore cannot be leaked by viewing the page source.

Default Endpoint:

/info/config

apiInfoBase.AddConfigHideCriteria("password");
apiInfoBase.AddConfigHideCriteria("os");
apiInfoBase.AddConfigHideCriteria("urls",false,false);
apiInfoBase.AddConfigHideCriteria("LogLevel", true);
apiInfoBase.AddConfigHideCriteria("environment", false, false);

// Override and allow one URLS entry to display.  Note, these are exact match and case sensitive
apiInfoBase.AddConfigOverrideString("ASPNETCORE_URLS");

MapSlugEntHealth

Provides a view to the Health Check of the Application. This can include periodic checks to File Sytems, Databases and RabbitMQ servers at the moment. But more can be added. It utilizes the SlugEnt.ResourceHealthChecker library to provide the actual health checks.

Default Endpoint:

/info/health

Sample App

There is a sample app that demonstrates the key components.