Download as PDF, PPTX
![13
Configuration File
Spring Boot Actuators – Spring Days – John Humphreys
Since we are trying to read a ${custom.message} property, we also need a
configuration file.
But by default we don’t need one, it would just run on port 8080 out of the
box; this is just specific to our code.
§ Add a “resources” folder under src/main
§ Add an application.properties file to it.
§ Add custom.message=Hello Spring Days!!!
§ You can also override the server defaults here:
• server.port=[number]
• server.contextpath=[/path]](https://image.slidesharecdn.com/spring-days-spring-boot-and-actuator-170626185320/85/Spring-Boot-Actuators-13-320.jpg)
![13
Configuration File
Spring Boot Actuators – Spring Days – John Humphreys
Since we are trying to read a ${custom.message} property, we also need a
configuration file.
But by default we don’t need one, it would just run on port 8080 out of the
box; this is just specific to our code.
§ Add a “resources” folder under src/main
§ Add an application.properties file to it.
§ Add custom.message=Hello Spring Days!!!
§ You can also override the server defaults here:
• server.port=[number]
• server.contextpath=[/path]](https://image.slidesharecdn.com/spring-days-spring-boot-and-actuator-170626185320/75/Spring-Boot-Actuators-13-2048.jpg)
Uploaded byVMware Tanzu
Spring Boot & Actuators
The document presents an overview of Spring Boot and its actuators, highlighting the framework's ability to simplify Java development by reducing boilerplate code and configuration overhead. It discusses key features such as automatic configuration, embedded servers, and built-in monitoring tools. Additionally, it covers practical aspects like live coding sessions to create and deploy Spring Boot applications, as well as integration with an admin console for application monitoring.
More Related Content
Similar to Spring Boot & Actuators
Spring Boot & Actuators
- 1. 1 © 2016 Pivotal SpringBoot & Actuators John Humphreys, VP in Systems Mgmt. Engineering Nomura Securities Email: johnwilliamhumphreys@gmail.com
- 2. 2 Agenda Spring Boot Actuators– Spring Days – John Humphreys § Problems with Development § What is Spring Boot? § How do we use it? § Live coding – Build a spring boot app § Live coding – Add actuators for monitoring § Deployment as a service § Live coding - Hook up to the admin console
- 3. 3 Problems With Development InJava, and in general. Spring Boot Actuators – Spring Days – John Humphreys
- 4. 4 What problems arewe trying to solve? Spring Boot Actuators – Spring Days – John Humphreys § Developers keep re-solving the same problems. • The point of coding is to build your business value-added services; be they your trading algorithms, your music service, etc. • Any time spent doing anything else is (usually) wasted. § Development with Java is mostly boiler-plate. • Web-applications are very common and require lots of configuration/setup. • Packaging, deployment, and monitoring take time (every time!). This is a waste to your productivity; they are tangential to your business logic. • There are too many custom variations of essentially the same configuration, project layout, and deployment (makes standardization/training hard).
- 5. 5 What is SpringBoot? An introduction to the framework Spring Boot Actuators – Spring Days – John Humphreys
- 6. 6 According to theproject itself: Spring Boot Actuators – Spring Days – John Humphreys “ Spring Boot makes it easy to create standalone, production-grade Spring based applications that you can just run. Spring.io
- 7. 7 Spring BootActuators – Spring Days – John Humphreys “ We take an opinionated view of the platform and third-party libraries so that you can get started with minimum fuss. Spring.io According to the project itself:
- 8. 8 Key Features Spring BootActuators – Spring Days – John Humphreys § Get Spring web-services running with just couple lines of code (literally). § Embed Tomcat or Undertow directly into them, providing a runnable JAR. § Automatically configure Spring wherever possible (you can actually run without any configuration out of the box). § Make your WAR function as an init.d service. § Add standard metrics, health checks, and externalized configuration. § Integrate with a huge number of things out of the box; for example: • Consul for discoverability/distributed configuration. • Admin console for managing spring apps.
- 9. 9 How Do WeUse It? A brief introduction. Spring Boot Actuators – Spring Days – John Humphreys
- 10. 10 Bare Application Code SpringBoot Actuators – Spring Days – John Humphreys You can actually start up a Spring Boot web-app with just this code (and a few maven dependencies): It will properly launch a web server and pick up any configuration files you provide. But that’s all it does as we have no endpoints!
- 11. 11 Adding an Endpoint SpringBoot Actuators – Spring Days – John Humphreys To make our service useful, we need to add a controller and endpoint. Spring Boot will automatically component scan our classes (locate them and wire them together) when it finds annotations like @Controller.
- 12. 12 Maven Dependencies Spring BootActuators – Spring Days – John Humphreys To make the code we just saw work, we need just 2 things from maven. 1. Derive from Spring Boot starter parent POM. 2. Include the spring-boot starter web dependency.
- 13. 13 Configuration File Spring BootActuators – Spring Days – John Humphreys Since we are trying to read a ${custom.message} property, we also need a configuration file. But by default we don’t need one, it would just run on port 8080 out of the box; this is just specific to our code. § Add a “resources” folder under src/main § Add an application.properties file to it. § Add custom.message=Hello Spring Days!!! § You can also override the server defaults here: • server.port=[number] • server.contextpath=[/path]
- 14. 14 What Does @SpringBootApplicationDo? Spring Boot Actuators – Spring Days – John Humphreys It is syntactic sugar for multiple other powerful annotations commonly used together in Spring. From the docs: “Many Spring Boot developers always have their classes annotated with @Configuration, @EnableAutoConfiguration, and @ComponentScan…Spring Boot provides a convenient @SpringBootApplication alternative. Spring.io
- 15. 15 Spring BootActuators – Spring Days – John Humphreys § @Configuration is used to turn a class into a JavaConfig source so you can define beans in it, etc. The class used in SpringApplication.run() should be a configuration class (though XML configs are possible). § @EnableAutoConfiguration attempts to guess and configure beans that you are likely to need based on our code and class-path. E.g. if Tomcat is present due to web dependencies in the POM, it will set it up and use it for you. § @ComponentScan is used to tell Spring to automatically search for and wire up classes based on their annotations (e.g. make @Controllers register themselves, populate @Value variables, etc.) What do @SpringBootApplication’s sub-annotations do?
- 16. 16 Live Coding SessionPart #1 Let’s make the application! Spring Boot Actuators – Spring Days – John Humphreys
- 17. 17 Spring BootActuators – Spring Days – John Humphreys Before we code this, just know that Spring Initializr can do it for you! I’m just doing it to show you how easy it is J. Spring Boot InitializR
- 18. 18 Spring BootActuators – Spring Days – John Humphreys § The code is hosted on GitHub; feel free to explore it. • https://github.com/w00te/spring-days-spring-boot-example § Also, to keep things co-located, here’s the admin console code for later on. • https://github.com/w00te/spring-days-spring-boot-admin-console § What we’ll achieve • Create a new Java 1.8 Maven application using the quick-start archetype. • Add in our maven dependencies. • Add in our main class and controller. • Add a properties file. • Test our application on our own custom-defined port/context. Live Coding Session Part #1
- 19. 19 Live Coding SessionPart #2 Let’s add monitoring and deployment features! Spring Boot Actuators – Spring Days – John Humphreys
- 20. 20 Spring BootActuators – Spring Days – John Humphreys § Spring boot actuator provides production grade metrics, auditing, and monitoring features to your application. § Just adding the actuator dependency makes it available on our 8080 port. If we add hateoas as well, it will make it restfully navigable under /actuator. No code is required J. § We’ll also disable actuator endpoint security to make this demo run smoother of course J. We can do this by adding these two properties: Adding Actuator
- 21. 21 Spring BootActuators – Spring Days – John Humphreys § Live thread dumps § Live stack traces § Logger configurations § Password-masked properties file auditing § Heap dump trigger (can be disabled) § Web-request traces § Application metrics § Spring bean analysis § More! (and it’s extensible) Actuator Features to Notice
- 22. 22 Application Deployment Deploying asan init.d service on Linux Spring Boot Actuators – Spring Days – John Humphreys
- 23. 23 Spring BootActuators – Spring Days – John Humphreys § Spring Boot builds an uber-JAR by default. So, the JAR it builds has all dependencies required for your application to run. § It does this with the spring-boot-maven-plugin. § If you ask it to make the JAR executable as well, it will be runnable and will support Linux init.d services (management with “service <name> start/stop/ restart/status, auto-start with OS, etc.). Deploying as an Init.d Service (Part I)
- 24. 24 Spring BootActuators – Spring Days – John Humphreys § Once you’ve made a JAR executable, you can view it in a text editor and you will notice that there is literally a bash script at the top of your JAR above the binary section; it’s pretty interesting to see. § External configuration: • Put a <jar-name>.conf file next to the JAR (or a sym-link to one). • Define your environment variables in it (e.g. JVM size, logging and property file locations, etc). • It will automatically be picked up at run time. Deploying as an Init.d Service (Part II)
- 25. 25 Live Coding SessionPart #3 Integrating with the Admin Console Spring Boot Actuators – Spring Days – John Humphreys
- 26. 26 Spring BootActuators – Spring Days – John Humphreys § Monitors your spring-boot applications and lets you interact with them. § Is a spring-boot application itself; include parent POM and a couple dependencies, set ports in the same way. Run as a separate application. http://codecentric.github.io/spring-boot-admin/1.5.0/#getting-started § Add a client-dependency to the apps you want to monitor (like the one we just built) and set a property, and it works great! J Admin Console Server
- 27. 27 Spring BootActuators – Spring Days – John Humphreys Admin Console Server Features § Dynamically change logging levels (e.g. add trace logging to debug a request temporarily and know how to fix it in dev). § Perform JMX calls. § View your application metrics. § View web request and response pairs for your web-app (including headers). § View the environment, stack traces, etc. § Basically anything actuator exposes is beautifully represented here. § Applications are automatically detected and you get a log of when they start up, shut down, etc.
- 28. 28 Spring BootActuators – Spring Days – John Humphreys
- 29. 29 The End Any questionsor comments? Spring Boot Actuators – Spring Days – John Humphreys