Skip to content

Update text on the 'Record AppMaps' page #1468

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update text on the 'Record AppMaps' page #1468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82c0e84
update text on record appmaps page
Daniel-Warner-X Nov 17, 2023
aaa1dba
fix formatting issues
Daniel-Warner-X Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 51 additions & 30 deletions packages/components/src/components/install-guide/record-instructions/IntelliJ.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
<template>
<section>
<p>
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.
</p>
<br />
<p>
Use the <component :is="runConfigIcon" class="run-config-icon" /> "Start with AppMap" option
from the "Run" menu to start your run configurations with AppMap enabled.
Expand All @@ -22,6 +28,12 @@
>recommended</span
>
</h3>
<br />
<p>
Recording your test run will provide a broad range of AppMaps that trace important
behaviors.
</p>
<br />
<p>
When you run your JUnit tests with the AppMap <code class="inline">javaagent</code> JVM
argument, an AppMap will be created for each test.
Expand All @@ -31,13 +43,14 @@
<component :is="runConfigIcon" class="run-config-icon" /> "Start with AppMap". This will
add the required JVM argument to enable AppMap recording.
</p>
<br />
<p>
For more information, visit
Docs:
<a
href="https://appmap.io/docs/reference/jetbrains.html#create-appmaps-from-junit-test-runs"
target="_blank"
>AppMap docs - IntelliJ Tests recording</a
>.
>IntelliJ tests recording</a
>
</p>
</section>
<br />
Expand All @@ -48,6 +61,12 @@
<h3>
<i class="header-icon"><RemoteRecordingIcon /></i>Remote recording
</h3>
<br />
<p>
Create AppMaps as you interact with your applications UI or API. This is helpful for
tracing the backend during specific usage scenarios.
</p>
<br />
<p>
When your application uses {{ this.webFramework.name }}, and you run your application with
the AppMap <code class="inline">javaagent</code> JVM argument, remote recording is
Expand All @@ -58,12 +77,11 @@
click the "Record" button again to stop the recording and view the AppMap.
</p>
<p>
For more information, visit
<a
href="https://appmap.io/docs/reference/jetbrains.html#running-a-java-application-with-appmap"
target="_blank"
>AppMap docs - IntelliJ Remote recording</a
>.
<br />
Docs:
<a href="https://appmap.io/docs/reference/jetbrains.html#remote-recording" target="_blank"
>Java remote recording</a
>
</p>
</section>
</template>
Expand All @@ -72,52 +90,55 @@
<h3>
<i class="header-icon header-icon--disabled"><RemoteRecordingIcon /></i>Remote recording
</h3>
<br />
<p>
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.
</p>
<p>Spring was not detected in this project.</p>
</div> </template
><br />
<section class="recording-method">
<h3>
<i class="header-icon"><ProcessIcon /></i>Process recording
</h3>
<br />
<p>Record an entire Java process from startup to teardown.</p>
<br />
<p>
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
<component :is="runConfigIcon" class="run-config-icon" /> "Start with AppMap". When your
application exits, the AppMap will be saved and opened.
</p>
<br />
<p>
Visit
Docs:
<a
href="https://appmap.io/docs/reference/appmap-java.html#process-recording"
target="_blank"
>AppMap Docs - Java Process recording</a
>Java process recording</a
>
for more information.
</p>
</section>
<br />
<section class="recording-method">
<h3>
<i class="header-icon"><PlayIcon /></i>Code Block recording
<i class="header-icon"><CodeBlockIcon /></i>Code Block recording
</h3>
<br />
<p>With this method, you can control exactly which code spans are recorded.</p>
<br />
<p>
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
<component :is="runConfigIcon" class="run-config-icon" /> "Start with AppMap".
</p>
<p>
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
<component :is="runConfigIcon" class="run-config-icon" /> "Start with AppMap". Instructions
for adding the AppMap code snippet to a span of code can be
<a
href="https://appmap.io/docs/reference/appmap-java.html#code-block-recording"
target="_blank"
>AppMap Docs - Java Code Block recording</a
>
for more information.
>found in our documentation</a
>.
</p>
</section>
</section>
Expand All @@ -126,7 +147,7 @@
import TestsIcon from '@/assets/tests-icon.svg';
import RemoteRecordingIcon from '@/assets/remote-recording-icon.svg';
import ProcessIcon from '@/assets/process-icon.svg';
import PlayIcon from '@/assets/play-icon.svg';
import CodeBlockIcon from '@/assets/code-block-icon.svg';
import VRunConfigDark from '@/assets/jetbrains_run_config_execute_dark.svg';
import VRunConfigLight from '@/assets/jetbrains_run_config_execute.svg';
import VTestsPrompt from './TestsPrompt.vue';
Expand All @@ -144,7 +165,7 @@ export default {
VRunConfigDark,
VRunConfigLight,
VTestsPrompt,
PlayIcon,
CodeBlockIcon,
ProcessIcon,
RemoteRecordingIcon,
TestsIcon,
Expand Down
57 changes: 40 additions & 17 deletions packages/components/src/components/install-guide/record-instructions/Java.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
<template>
<section>
<p>
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.
</p>
<br />
<p>
Use the "Run with AppMap" debug configuration to launch your application or run your tests
through Microsoft's Test Runner for Java extension.
Expand All @@ -24,6 +30,12 @@
Tests recording
<span class="recommended-badge">recommended</span>
</h3>
<br />
<p>
Recording your test run will provide a broad range of AppMaps that trace important
behaviors.
</p>
<br />
<p>
When you run your {{ testFramework.name }} tests with the AppMap
<code class="inline">javaagent</code> JVM argument, an AppMap will be created for each
Expand All @@ -34,13 +46,14 @@
button available in the sidebar or by pressing F1 and running the
<code class="inline">Test: Run All Tests</code> command.
</p>
<br />
<p>
For more information, visit
Docs:
<a
href="https://appmap.io/docs/reference/vscode.html#create-appmaps-from-junit-test-runs"
target="_blank"
>
AppMap docs - VSCode Tests recording
VSCode Java tests recording
</a>
</p>
</section>
Expand All @@ -56,6 +69,12 @@
<i class="header-icon"><RemoteRecordingIcon /></i>
Remote recording
</h3>
<br />
<p>
Create AppMaps as you interact with your applications UI or API. This is helpful for
tracing the backend during specific usage scenarios.
</p>
<br />
<p>
When your application uses {{ this.webFramework.name }}, and you run your application with
the AppMap <code class="inline">javaagent</code> JVM argument, remote recording is
Expand All @@ -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.
</p>
<br />
<p>
For more information, visit
Docs:
<a
href="https://appmap.io/docs/reference/vscode.html#running-a-java-application-with-appmap"
target="_blank"
>AppMap docs - VSCode Remote recording</a
>VSCode Java remote recording</a
>
</p>
</section>
Expand All @@ -92,45 +112,48 @@
<h3>
<i class="header-icon"><ProcessIcon /></i>Process recording
</h3>
<br />
<p>
AppMap can record an entire Java process from start to finish. To use process recording,
modify <code class="inline">.vscode/launch.json</code> to include
<code class="inline">-Dappmap.recording.auto=true</code> in
<code class="inline">vmArgs</code>. After running this configuration, an AppMap will be
saved once your application exits.
</p>
<br />
<p>
Visit
Docs:
<a
href="https://appmap.io/docs/reference/appmap-java.html#process-recording"
target="_blank"
>
AppMap Docs - Java Process recording
Java process recording
</a>
for more information.
</p>
</section>
<br />
<section class="recording-method">
<h3>
<i class="header-icon"><PlayIcon /></i>
<i class="header-icon"><CodeBlockIcon /></i>
Code Block recording
</h3>
<br />
<p>With this method, you can control exactly which code spans are recorded.</p>
<br />
<p>
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.
</p>
<br />
<p>
Visit
Docs:
<a
href="https://appmap.io/docs/reference/appmap-java.html#code-block-recording"
target="_blank"
>
AppMap Docs - Java Code Block recording
Java code block recording
</a>
for more information.
</p>
</section>
</section>
Expand All @@ -139,7 +162,7 @@
import TestsIcon from '@/assets/tests-icon.svg';
import RemoteRecordingIcon from '@/assets/remote-recording-icon.svg';
import ProcessIcon from '@/assets/process-icon.svg';
import PlayIcon from '@/assets/play-icon.svg';
import CodeBlockIcon from '@/assets/code-block-icon.svg';
import VTestsPrompt from './TestsPrompt.vue';

export default {
Expand All @@ -152,7 +175,7 @@ export default {

components: {
VTestsPrompt,
PlayIcon,
CodeBlockIcon,
ProcessIcon,
RemoteRecordingIcon,
TestsIcon,
Expand Down
Loading