Tip

Looking for a .NET Core example? Have a look.

Using Management Endpoints (.NET Framework)

This tutorial takes you through setting up a ASP.NET 4.x Framework application with cloud management endpoints and dynamic logging levels enabled.

Note

For more detailed examples, please refer to the Management projects in the Steeltoe Samples Repository.

Create a .NET Framework Web API project

1. In Visual Studio (2019) choose to create a new project
2. Configure the new project with the follow values
3. Project Name: Management_Endpoints_Framework_Example
4. Solution Name: Management_Endpoints_Framework_Example
5. Framework: (>= 4.5)
6. Choose to create a new Web API project type
7. Once created, the project should be loaded

Next, install packages needed

1. Open the package manager console

2. Install NuGet distributed packages

   Install-Package -Id Microsoft.Extensions.Configuration -Version 2.2
   Install-Package -Id Microsoft.Extensions.Logging -Version 2.2
   Install-Package -Id Microsoft.Extensions.Logging.Console -Version 2.2
   Install-Package -Id OpenCensus -IncludePrerelease
   Install-Package -Id Steeltoe.Extensions.Logging.DynamicLogger -Version 2.4
   Install-Package -Id Steeltoe.Management.EndpointBase -Version 2.4
   Install-Package -Id Steeltoe.Extensions.Configuration.CloudFoundryBase -Version 2.4
   Install-Package -Id Steeltoe.Management.EndpointWeb -Version 2.4
   

Next, add actuators support classes

1. Create an appsettings.json file in the root of the project

   {
     "Logging": {
       "IncludeScopes": true,
       "LogLevel": {
         "Default": "Debug",
         "System": "Information",
         "Microsoft": "Information",
         "Management": "Trace",
         "Steeltoe": "Trace"
       }
     },
     "management": {
       "endpoints": {
         "actuator": {
           "exposure": {
             "include": ["*"]
           }
         }
       }
     }
   }
   

Note

Exposing all endpoints is not an ideal setting in production. This is for example only.

1. Create the ApplicationConfig.cs class in the App_Start folder

   using System;
   using System.IO;
   using Microsoft.Extensions.Configuration;
   using Steeltoe.Extensions.Configuration.CloudFoundry;
   
   public class ApplicationConfig {
     public static CloudFoundryApplicationOptions CloudFoundryApplication {
   
       get {
         var opts = new CloudFoundryApplicationOptions();
         var appSection = Configuration.GetSection(CloudFoundryApplicationOptions.CONFIGURATION_PREFIX);
         appSection.Bind(opts);
         return opts;
       }
     }
     public static CloudFoundryServicesOptions CloudFoundryServices {
       get {
         var opts = new CloudFoundryServicesOptions();
         var serviceSection = Configuration.GetSection(CloudFoundryServicesOptions.CONFIGURATION_PREFIX);
         serviceSection.Bind(opts);
         return opts;
       }
     }
   
     public static IConfigurationRoot Configuration { get; set; }
   
     public static void Configure(string environment) {
       // Set up configuration sources.
       var builder = new ConfigurationBuilder()
       .SetBasePath(GetContentRoot())
       .AddJsonFile("appsettings.json", optional: false, reloadOnChange: false)
       .AddJsonFile($"appsettings.{environment}.json", optional: true)
       .AddEnvironmentVariables()
       .AddCloudFoundry();
   
       Configuration = builder.Build();
     }
   
     public static string GetContentRoot() {
       var basePath = (string)AppDomain.CurrentDomain.GetData("APP_CONTEXT_BASE_DIRECTORY") ??
       AppDomain.CurrentDomain.BaseDirectory;
       return Path.GetFullPath(basePath);
     }
   }
   

2. Create the ManagementConfig.cs class in the App_Start folder

   using Microsoft.Extensions.Configuration;
   using Microsoft.Extensions.Logging;
   using System.Collections.Generic;
   using System.Web.Http.Description;
   using Steeltoe.Common.Diagnostics;
   using Steeltoe.Common.HealthChecks;
   using Steeltoe.Management.Endpoint;
   using Steeltoe.Management.Endpoint.Health.Contributor;
   
   public class ManagementConfig{
     public static void ConfigureManagementActuators(IConfiguration configuration, ILoggerProvider dynamicLogger, IApiExplorer apiExplorer, ILoggerFactory loggerFactory = null){
       ActuatorConfigurator.UseCloudFoundryActuators(configuration, dynamicLogger, GetHealthContributors(configuration), apiExplorer, loggerFactory);
     }
   
     public static void Start(){
       DiagnosticsManager.Instance.Start();
     }
   
     public static void Stop(){
       DiagnosticsManager.Instance.Stop();
     }
   
     private static IEnumerable<IHealthContributor> GetHealthContributors(IConfiguration configuration){
       var healthContributors = new List<IHealthContributor>{
         new DiskSpaceContributor()
       };
   
       return healthContributors;
     }
   }
   

3. Update Web.config handlers

   <configuration>
   
     ...
   
     <system.webServer>
       ...
       <validation validateIntegratedModeConfiguration="false" />
       <handlers>
       <remove name="ExtensionlessUrlHandler-Integrated-4.0" />
       <remove name="OPTIONSVerbHandler" />
       <remove name="TRACEVerbHandler" />
       <add name="ExtensionlessUrlHandler-Integrated-4.0" path="*." verb="*" type="System.Web.Handlers.TransferRequestHandler" preCondition="integratedMode,runtimeVersionv4.0" />
       </handlers>
       ...
     </system.webServer>
   
     ...
   
   </configuration>
   

4. Create the LoggingConfig.cs class in the App_Start folder

   using Microsoft.Extensions.Configuration;
   using Microsoft.Extensions.Logging;
   using Microsoft.Extensions.Logging.Console;
   using Steeltoe.Extensions.Logging;
   
   public static class LoggingConfig{
   public static ILoggerFactory LoggerFactory { get; set; }
   public static ILoggerProvider LoggerProvider { get; set; }
   
   public static void Configure(IConfiguration configuration) {
     LoggerProvider = new DynamicLoggerProvider(new ConsoleLoggerSettings().FromConfiguration(configuration));
     LoggerFactory = new LoggerFactory();
     LoggerFactory.AddProvider(LoggerProvider);
     }
   }
   

5. Modify Application_Start and Application_stop in Global.asax.cs

   using System.Web.Http;
   using System.Web.Mvc;
   using Management_Endpoints_Framework_Example.App_Start;
   
   protected void Application_Start() {
     // Create applications configuration
     ApplicationConfig.Configure("development");
   
     // Create logging system using configuration
     LoggingConfig.Configure(ApplicationConfig.Configuration);
   
     // Add management endpoints to application
     ManagementConfig.ConfigureManagementActuators(
       ApplicationConfig.Configuration,
       LoggingConfig.LoggerProvider,
       GlobalConfiguration.Configuration.Services.GetApiExplorer(),
       LoggingConfig.LoggerFactory);
   
     // Start the management endpoints
     ManagementConfig.Start();
   }
   protected void Application_Stop(){
     ManagementConfig.Stop();
   }
   

Run the application

• Visual Studio

1. Choose the top Debug menu, then choose Start Debugging (F5). This should bring up a browser with the app running
2. Navigate to the management endpoints summary page (you may need to change the port number) http://localhost:8080/actuator

Once the summary page loads, you will see a list of all available management endpoints that have been automatically created. Click each link to see what information is offered.