Note
This guide applies to Steeltoe v3. Please open an issue if you'd like to help update the content for Steeltoe v4.
Exploring all actuators
Goal
See all actuators running and learn what options are available.
Expected Results
Enhance the app created in the previous exercise to enable all actuator endpoints.
Get Started
Open "Program.cs" and replace the existing Steeltoe 'Add' statements with the single 'all actuators' statement.
// Add services to the container.
// Steeltoe actuators
builder.AddAllActuators();
Expose all the actuator endpoints for debugging and demonstration purposes in "appsettings.json". Append the below JSON, just after the "AllowedHosts" line (should be around line 8). And save the file.
,"Management": {
"Endpoints": {
"Actuator": {
"Exposure": {
"Include": [ "*" ]
}
}
}
}
Tip
Enable Intellisense for Steeltoe settings within appsettings.json by adding a schema reference inside the JSON like this: "$schema": "https://steeltoe.io/schema/v3/schema.json"
Run the application
With all actuators registered in the application builder, we are ready to see everything in action. Run the application.
Click the Debug > Start Debugging top menu item. You may be prompted to "trust the IIS Express SSL certificate" and install the certificate. Once started, your default browser should open and automatically load the weather forecast endpoint.
With the application running and the weather forecast endpoint loaded, your browser should show the following:
Note
If "Enable OpenAPI support" was checked at project creation, the Swagger endpoint is used as the startup page. Replace "swagger/index.html" with "WeatherForecast" to get the response above.
Discover all the management endpoints
Load the base actuator endpoint by replacing WeatherForecast with actuator in the browser address bar.
What has happened? In the previous exercise, only select endpoints were implemented and we visited each in the browser to see their output. There was no need to expose those endpoints, because Steeltoe doesn't secure them by default (you should use security in production environments). With the addition of all endpoints, most are secured by default. You pick and choose which should be exposed and with what roles. Here's a list of each endpoint that is available and its purpose. While the application is running, visit each one to learn more.
/actuator: A JSON structured list of all actuator endpoints that have been exposed./actuator/env: A listing of all environment variables that are available to the app./actuator/health: The current health status of the app, as reported inIHealthContributor, customized for different platforms./actuator/info: Various app information collected from theIInfoContributor./actuator/loggers: View and configure the logging levels of your application at runtime. This endpoint supports POST requests to adjust logging levels./actuator/mappings: Details about automatically discovered MVC and Web API project routes and route templates./actuator/metrics: App CLR and HTTP metrics, collected using OpenTelemetry library./actuator/prometheus: A copy of the metrics endpoint, in a Prometheus friendly format./actuator/refresh: Trigger the app’sIConfigurationRootto automatically refresh all configuration values./actuator/httptrace: Details about the last few request traces made by the app.
Stop the application
Either close the browser window or click the red stop button in the top menu.
Summary
Similar to the previous exercise, there is a minimum expectation of any microservice running in the cloud. These things are meant to help the developer debug, trace, and observe the application within its container. But these things have the potential to consume the developer's time creating everything, adding the right options, and making it distributable. Steeltoe aims to use the best in .NET to get the developer back to coding business logic and not deal with the boilerplate stuff.