mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-08-29 03:06:45 +08:00
Update Spring Integration metrics support since Spring Integration `4.3.6`+ no longer needs `spring-integration-jmx` enable `MessageChannel`, `MessageHandler` and `MessageSource` metrics. - Add `IntegrationManagementConfiguration` conditional auto-configuration to provide `@EnableIntegrationManagement` when JMX is `enabled` or there is no `IntegrationManagementConfigurer.MANAGEMENT_CONFIGURER_NAME` bean. By default this bean doesn't exist and you explicitly should declare it (e.g. via `@EnableIntegrationManagement`) if you would like to collect metrics. At the same time Spring Integration enables it when JMX management is present (that is a purpose of that new `IntegrationManagementConfiguration`) - Change `SpringIntegrationMetricReader` to read metrics from the `IntegrationManagementConfigurer`, not `IntegrationMBeanExporter` - Change `PublicMetricsAutoConfiguration` to register `IntegrationManagementConfigurer.MANAGEMENT_CONFIGURER_NAME` bean if not present. Since we are here in `actuator`, therefore we are interested in the metrics for SI as well. - Since we don't need JMX for the metrics any more, remove SI-JMX dependency from the `spring-boot-starter-integration`. - Remove `IntegrationManagementConfiguration` modification from the `integrationMbeanExporter()`, since that looks like mutation of an external object, when end-user would prefer their own options. Therefore we don't need `ObjectProvider<IntegrationManagementConfigurer>`, too - Add missed `MessageSourceMetrics` gathering for the `SpringIntegrationMetricReader` Closes gh-7722 |
||
---|---|---|
.. | ||
src | ||
pom.xml | ||
README.adoc |
= Spring Boot - Actuator Spring Boot Actuator includes a number of additional features to help you monitor and manage your application when it's pushed to production. You can choose to manage and monitor your application using HTTP endpoints, with JMX or even by remote shell (SSH or Telnet). Auditing, health and metrics gathering can be automatically applied to your application. The http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production-ready[user guide] covers the features in more detail. == Enabling the Actuator The simplest way to enable the features is to add a dependency to the `spring-boot-starter-actuator` '`Starter`'. To add the actuator to a Maven based project, add the following '`Starter`' dependency: [source,xml,indent=0] ---- <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> </dependencies> ---- For Gradle, use the declaration: [indent=0] ---- dependencies { compile("org.springframework.boot:spring-boot-starter-actuator") } ---- == Features * **Endpoints** Actuator endpoints allow you to monitor and interact with your application. Spring Boot includes a number of built-in endpoints and you can also add your own. For example the `health` endpoint provides basic application health information. Run up a basic application and look at `/health` (and see `/mappings` for a list of other HTTP endpoints). * **Metrics** Spring Boot Actuator includes a metrics service with "`gauge`" and "`counter`" support. A "`gauge`" records a single value; and a "`counter`" records a delta (an increment or decrement). Metrics for all HTTP requests are automatically recorded, so if you hit the `metrics` endpoint should see a sensible response. * **Audit** Spring Boot Actuator has a flexible audit framework that will publish events to an `AuditService`. Once Spring Security is in play it automatically publishes authentication events by default. This can be very useful for reporting, and also to implement a lock-out policy based on authentication failures. * **Process Monitoring** In Spring Boot Actuator you can find `ApplicationPidFileWriter` which creates a file containing the application PID (by default in the application directory with a file name of `application.pid`).