+ The more AppMaps you record, the more information you will have about your running + application. No matter which method you start with, you can add more AppMaps or remove old + AppMaps at any time. +
+
Use the
+
+ Recording your test run will provide a broad range of AppMaps that trace important + behaviors. +
+
When you run your JUnit tests with the AppMap javaagent JVM
argument, an AppMap will be created for each test.
@@ -31,13 +43,14 @@
- For more information, visit + Docs: AppMap docs - IntelliJ Tests recording. + >IntelliJ tests recording
+ Create AppMaps as you interact with your applications UI or API. This is helpful for + tracing the backend during specific usage scenarios. +
+
When your application uses {{ this.webFramework.name }}, and you run your application with
the AppMap javaagent JVM argument, remote recording is
@@ -58,12 +77,11 @@
click the "Record" button again to stop the recording and view the AppMap.
- For more information, visit
- AppMap docs - IntelliJ Remote recording.
+
+ Docs:
+ Java remote recording
- Did you know? When you run a Spring app, you can make AppMaps of all the HTTP requests - served by your app. Spring wasn't detected in this project, though. + When you run a Spring app, you can make AppMaps of all the HTTP requests served by your + app.
+Spring was not detected in this project.
Record an entire Java process from startup to teardown.
+
- AppMap can record an entire Java process from start to finish. To use process recording, run
- your application using
+ To use process recording, run your application using
- Visit + Docs: AppMap Docs - Java Process recordingJava process recording - for more information.
With this method, you can control exactly which code spans are recorded.
+
- You can use the AppMap Java library directly to record a specific span of code. With this
- method, you can control exactly what code is recorded, and where the recording is saved. To
- use code block recording, add an AppMap code snippet to the section of code you want to
- record, then run your application using
-
- Visit
+ You can use the AppMap Java library directly to record a specific span of code. To use code
+ block recording, add an AppMap code snippet to the section of code you want to record, then
+ run your application using
+
+ The more AppMaps you record, the more information you will have about your running + application. No matter which method you start with, you can add more AppMaps or remove old + AppMaps at any time. +
+
Use the "Run with AppMap" debug configuration to launch your application or run your tests
through Microsoft's Test Runner for Java extension.
@@ -24,6 +30,12 @@
Tests recording
recommended
+
+
+ Recording your test run will provide a broad range of AppMaps that trace important + behaviors. +
+
When you run your {{ testFramework.name }} tests with the AppMap
javaagent JVM argument, an AppMap will be created for each
@@ -34,13 +46,14 @@
button available in the sidebar or by pressing F1 and running the
Test: Run All Tests command.
- For more information, visit + Docs: - AppMap docs - VSCode Tests recording + VSCode Java tests recording
+ Create AppMaps as you interact with your applications UI or API. This is helpful for + tracing the backend during specific usage scenarios. +
+
When your application uses {{ this.webFramework.name }}, and you run your application with
the AppMap javaagent JVM argument, remote recording is
@@ -65,12 +84,13 @@
tool such as Postman. When you are done, click the "Record" button again to save the
recording and view the AppMap.
- For more information, visit + Docs: AppMap docs - VSCode Remote recordingVSCode Java remote recording
@@ -92,6 +112,7 @@
AppMap can record an entire Java process from start to finish. To use process recording,
modify .vscode/launch.json to include
@@ -99,38 +120,40 @@
vmArgs. After running this configuration, an AppMap will be
saved once your application exits.
- Visit + Docs: - AppMap Docs - Java Process recording + Java process recording - for more information.
With this method, you can control exactly which code spans are recorded.
+- You can use the AppMap Java library directly to record a specific span of code. With this - method, you can control exactly what code is recorded, and where the recording is saved. To - use code block recording, add an AppMap code snippet to the section of code you want to - record, then run your application using the Debug Configuration with AppMap. + You can use the AppMap Java library directly to record a specific span of code. To use code + block recording, add an AppMap code snippet to the section of code you want to record, then + run your application using the Debug Configuration with AppMap.
+- Visit + Docs: - AppMap Docs - Java Code Block recording + Java code block recording - for more information.
+ The more AppMaps you record, the more information you will have about your running + application. No matter which method you start with, you can add more AppMaps or remove old + AppMaps at any time. +
+
When you run your Python code with the appmap package, AppMap
will be enabled for recording.
@@ -15,21 +21,27 @@
>recommended
+
+
+ Recording your test run will provide a broad range of AppMaps that trace important + behaviors. +
+When you run your {{ testFramework.name }} tests with AppMap enabled, an AppMap will be created for each test.
Run Pytest tests: -- For more information, visit + Docs: AppMap docs - Python Tests recording. + >Python tests recording
@@ -39,6 +51,12 @@+ Create AppMaps as you interact with your applications UI or API. This is helpful for + tracing the backend during specific usage scenarios. +
+When your application uses Django or Flask, and you run your application with AppMap enabled, HTTP server requests recording is enabled. To record requests, first run your @@ -46,26 +64,26 @@
- Start your Django server:
+ Start your Django server with AppMap enabled:
- Start your Flask server:
+ Start your Flask server with AppMap enabled:
Then, interact with your application through its user interface and/or by making API requests using a tool such as Postman. An AppMap will be created for each HTTP server request that's served by your app.
+- For more information, visit + Docs: AppMap docs - Python Requests recording. + >Python requests recording
@@ -74,17 +92,19 @@You can use the AppMap Python package directly to record a specific span of code.
+- You can use the AppMap Python package directly to record a specific span of code. With this - method, you can control exactly what code is recorded, and where the recording is saved. To - use Context manager recording, add an AppMap code snippet to the section of code you want to - record, then run your application with AppMap enabled. Visit + With this method, you can control exactly what code is recorded, and where the recording is + saved. To use Context manager recording, add an AppMap code snippet to the section of code + you want to record, then run your application with AppMap enabled. Instructions for adding + the AppMap code snippet to a span of code can be AppMap Docs - Python Context manager recording - for more information. + >found in our documentation.
diff --git a/packages/components/src/components/install-guide/record-instructions/Ruby.vue b/packages/components/src/components/install-guide/record-instructions/Ruby.vue index 1670f4aa9c..b3bc72e305 100644 --- a/packages/components/src/components/install-guide/record-instructions/Ruby.vue +++ b/packages/components/src/components/install-guide/record-instructions/Ruby.vue @@ -1,5 +1,10 @@+ The more AppMaps you record, the more information you will have about your running + application. +
+
When you run your Ruby code with the appmap gem in your bundle,
AppMap will be enabled for recording. By default, the appmap gem
@@ -12,6 +17,11 @@
environment variable DISABLE_SPRING=true.
+ No matter which method you start with, you can add more AppMaps or remove old AppMaps at any + time. +
+- When you run your {{ testFramework.name }} tests with AppMap enabled, an AppMap will be - created for each test. + Recording your test run will provide a broad range of AppMaps that trace important + behaviors. When you run your {{ testFramework.name }} tests with AppMap enabled, an AppMap + will be created for each test.
+
- Run Minitest tests:
+ Run Minitest tests with AppMap enabled:
- For more information, visit + Docs: AppMap docs - Ruby Tests recording. + >Ruby tests recording
- When your application uses {{ this.webFramework.name }}, and you run your application with - AppMap enabled, HTTP server request recording will be enabled. To record requests, first - run your application: + Create AppMaps as you interact with your applications UI or API. This is helpful for + tracing the backend during specific usage scenarios. When your application uses + {{ this.webFramework.name }}, and you run your application with AppMap enabled, HTTP + server request recording will be enabled.
+
- Start your Rails server:
+ First, start your Rails server with AppMap enabled:
- Interact with your application, through its user interface and/or by making API requests - using a tool such as Postman. An AppMap will be created for each HTTP server request - that's served by your app. + Second, interact with your application, through its user interface and/or + by making API requests using a tool such as Postman. An AppMap will be created for each + HTTP server request that's served by your app.
+- For more information, visit + Docs: AppMap docs - Ruby Requests recording. + >Ruby requests recording
@@ -92,16 +109,20 @@With this method, you can control exactly which code spans are recorded.
+- You can use the AppMap Ruby gem directly to record a specific span of code. With this - method, you can control exactly what code is recorded, and where the recording is saved. To - use Block recording, add an AppMap code snippet to the section of code you want to record, - then run your application with AppMap enabled. Visit - AppMap Docs - Ruby Block recording - for more information. + To use Block recording, add an AppMap code snippet to the section of code you want to + record, then run your application with AppMap enabled. Instructions for adding the AppMap + code snippet to a span of code can be + found in our documentation.
+- Did you know? If you use a test framework such as {{ framework }}, you can make AppMaps of all - your test cases. Tests weren't detected in this project, though. + If you use a test framework such as {{ framework }}, you can make AppMaps of all your test + cases.
+No tests were detected in this project.