move walkthrough to extension pack since it references multiple extensions

This commit is contained in:
Martin Lippert
2021-08-13 11:22:46 +02:00
parent 7f0c4a58a9
commit ec6ba09636
8 changed files with 49 additions and 47 deletions

View File

@@ -35,5 +35,53 @@
"Pivotal.vscode-spring-boot",
"vscjava.vscode-spring-initializr",
"vscjava.vscode-spring-boot-dashboard"
]
],
"contributes": {
"walkthroughs": [
{
"id": "springBootWelcome",
"title": "Getting Started with Spring Boot in VS Code",
"description": "An Overview of the Spring Tools in VS Code to get started and to work with existing Spring Boot projects in VS Code",
"primary": true,
"steps": [
{
"id": "new-project-using-initializr",
"title": "Create a new Spring Boot project",
"description": "The easiest way to create new Spring Boot projects in VS Code is to use the Spring Initializr integration. Open the command palette in VS Code, search for __Spring__ and create a new Spring Boot project from there.\n[Create New Spring Boot Project](command:spring.initializr.maven-project)",
"media": {
"image": "walkthroughs/spring-initializr-integration.png",
"altText": "Create a new Maven-based Spring Boot project"
}
},
{
"id": "navigate-your-spring-projects",
"title": "Navigate your Spring Boot projects",
"description": "The Spring Tools in your VS Code installation contribute Spring-specific symbols to help you navigate your projects. All the symbols start with `@`.\nYou can navigate to the symbols using the [Outline View](command:outline.focus) of the current file, via the [Go to Symbol in Editor...](command:workbench.action.gotoSymbol) or globally via [Go to symbol in Workspace...](command:workbench.action.showAllSymbols).\nIf you start your search with an `@`, the list of symbols will show the Spring-specific symbols only.",
"media": {
"image": "walkthroughs/spring-symbols-navigation.png",
"altText": "Go to Symbol in Workspace..."
}
},
{
"id": "run-your-spring-projects",
"title": "Run your Spring Boot projects",
"description": "Running your Spring Boot projects from within VS Code is simple: Open any Java source file from your project and press `Run` at the top right corner.\nThe second option is to [switch to the launch section](command:workbench.view.debug) of VS Code and start the app there.",
"media": {
"image": "walkthroughs/spring-run-app.png",
"altText": "Run your Spring Boot app"
}
},
{
"id": "live-information-for-your-running-spring-app",
"title": "Show live information from your running Spring Boot application",
"description": "A unique feature of the Spring Tools is the ability to vizualize live data from your running app inplace with the source code of the running application.\n",
"media": {
"markdown": "walkthroughs/live-information.md",
"altText": "Run your Spring Boot app"
}
}
]
}
]
}
}

View File

@@ -0,0 +1,29 @@
## Look inside of your running Spring Boot application
Spring Tools 4 can display live metadata information of a running Spring Boot application direclty in place in the source code.
### Configure the launch config
The live information is provided by [Spring Boot Actuators](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator), so you need to have he Spring Boot Actuator module on the classpath of your project. In addition to that the information is exchanged between the running app and the tools via JMX, so you need to enable JMX for your app. This can be done by adding a specific JVM argument to the [launch configuration](command:workbench.action.debug.configure):
`"vmArgs": "-Dspring.jmx.enabled=true"`
### Show the live information
In order to connect to a running application, you need to execute the [Manage Live Spring Boot Process Connections](vscode-spring-boot.live-hover.connect) command (e.g. via the command palette).
![](manage-live-connections.png)
Then, the command shows up a list of running processes, from which you can select the app to connect to.
![](manage-live-connections-connect.png)
Once connected, the live information shows up in place with the source code of your application.
![](https://spring.io/images/tools-img4-4257680a0b50b006044ef88d7234ca92.jpg)
### Update and disconnect
If you have VS Code connected to a running app, you can execute the same command again to refresh the information or to disconnect from the running app again. The quick pick choices will show you up with those options for connected processes.

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 190 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 251 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 938 KiB