Enhanced Observability

[jonatan-ivanov]

This is a placeholder issue to group smaller tasks together to provide better Observability support for Spring Boot users.

Info enhancements

• Add details about the JVM, e.g.: name, vendor, version: Java Info Contributor #28136
• Add details about the OS, e.g.: arch, name, version: Expose Operating System information as an info contributor #28907
• Implement SBOM actuator endpoint #39799
  • Add the list of used profiles: Add SpringInfoContributor #38356
  • Boot/Framework/Cloud/ Data/etc. versions? (also see "arbitrary records from the manifest file" below): Add SpringInfoContributor #38356
  • Spring Boot Actuator "manifest" endpoint #22924
• Add details about the available resources e.g.: cpu, memory
  • Add ProcessInfoContributor #38371
  • Add memory info to ProcessInfo #41262
• Add SslInfoContributor and SslHealthIndicator #41205
• Add garbage collector info to process info contributor #44704
• Add details about certain "user" properties: timezone, country, language, user dir
• Add network-related details: host, ip
• Miscellaneous items: current time, start time, uptime
• Enhance StartupInfoLogger with some of these details

See:

• An all-in-one implementation example for some of the features above: RuntimeInfoContributor
• An example json output

Health enhancements

• Add OOB health support for Feign clients: this should go to Spring Cloud OpenFeign, Spring Boot might provide support to handle the Health response (see: this solution), related: Configurable Health Indicator to observe HTTP Endpoints #36953
• Metrics/tracing for health indicators

Spring Security enhancements

• /whoami endpoint: show principal and granted authorities

The list is still in progress and very likely to evolve in the near future.

[dsyer]

The activeProfiles is already exposed in the /env endpoint.

[jonatan-ivanov]

Good point, today I was implementing it and I realized that if I don't set the active profiles property but set spring.profiles.default, then environment.getActiveProfiles() will be empty and the profle I set for default will be used. I think on the info endpoint it would be more useful to return the "effectively used profiles" instead of the value of environment.getActiveProfiles(). Something like this I guess:

String[] getEffectiveProfiles() {
    return ObjectUtils.isEmpty(environment.getActiveProfiles()) ? environment.getDefaultProfiles() : environment.getActiveProfiles();
}

[dsyer]

Uptime is already a metric as well - I guess it really belongs there because you don't expect info to change over time.

[jonatan-ivanov]

I think using data that can change over time should be ok on the info endpoint, e.g.: current time (to detect clock skew issues), uptime (to see if the app was restarted or not), even the cpu count can change over time (because of cgroups).

I think the same about data that we have metrics for, e.g.: jvm version info. I think they can be used in different use-cases and the user should decide if they want one or the other or both.