Merge pull request #71 from Blazemeter/RELEASE_DOC_2.5.1

Documentation release v2.5.1
Blazemeter · Jul 3, 2024 · b7b1821 · b7b1821
2 parents 4de5f21 + daf6cf8
commit b7b1821
Show file tree

Hide file tree

Showing 21 changed files with 327 additions and 288 deletions.
diff --git a/docs/package.json b/docs/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "CorrelationRecorder",
+  "name": "AutoCorrelationRecorder",
   "version": "2.0.",
-  "description": "Effortlessly handle dynamic values in JMeter with the Correlation recorder plugin.",
+  "description": "Effortlessly handle dynamic values in JMeter with the Auto Correlation Recorder plugin.",
   "main": "index.js",
   "authors": {
     "name": "",

diff --git a/docs/src/.vuepress/config.js b/docs/src/.vuepress/config.js
@@ -1,28 +1,35 @@
-const { description } = require("../../package");
+const {description} = require("../../package");
 const REPO_URL = "https://github.com/Blazemeter/CorrelationRecorder";
+const BASE_PATH = buildBaseUrl();
+
+function buildBaseUrl() {
+  return process.env.CI_PAGES_URL
+      ? "/jmeter-siebel-plugin/"
+      : "/CorrelationRecorder/";
+}
 
 module.exports = {
   /**
    * Ref：https://v1.vuepress.vuejs.org/config/#title
    */
-  title: "Correlation Recorder",
+  title: "Auto Correlation Recorder",
   /**
    * Ref：https://v1.vuepress.vuejs.org/config/#description
    */
   description: description,
-  base: "/CorrelationRecorder/",
+  base: BASE_PATH,
 
   /**
    * Extra tags to be injected to the page HTML `<head>`
    *
    * ref：https://v1.vuepress.vuejs.org/config/#head
    */
   head: [
-    ["meta", { name: "theme-color", content: "#00ace6" }],
-    ["meta", { name: "apple-mobile-web-app-capable", content: "yes" }],
+    ["meta", {name: "theme-color", content: "#00ace6"}],
+    ["meta", {name: "apple-mobile-web-app-capable", content: "yes"}],
     [
       "meta",
-      { name: "apple-mobile-web-app-status-bar-style", content: "black" },
+      {name: "apple-mobile-web-app-status-bar-style", content: "black"},
     ],
   ],
 

diff --git a/docs/src/guide/README.md b/docs/src/guide/README.md
@@ -4,7 +4,7 @@ next: /guide/installation-guide.md
 
 # User Guide
 
-Correlations Recorder it's a [JMeter's](http://jmeter.apache.org/usermanual/get-started.html) plugin that simplifies
+Auto Correlation Recorder it's a [JMeter's](http://jmeter.apache.org/usermanual/get-started.html) plugin that simplifies
 the process of recording for applications with Dynamic Variables by providing automatic **correlations of variables**.
 
 You can perform exploratory detections of dynamic variables and create **correlation rules** to correlate them
@@ -32,18 +32,18 @@ Additional Features:
 
 ## Benefits
 
-Here are 10 key benefits of using the JMeter's Automatic Correlation Recorder Plugin:
+Here are 10 key benefits of using the JMeter's Auto Correlation Recorder Plugin:
 
 1. Fast script creation
-2. Preloaded templates
-3. Hassle-free collaboration
-4. Customizable correlations
-5. Easy customization
-6. Streamlined collaboration
-7. Customizable extensions
-8. Dynamic value correlation
-9. Fast rule generation
-10. Reliable testing.
+1. Preloaded templates
+1. Hassle-free collaboration
+1. Customizable correlations
+1. Easy customization
+1. Streamlined collaboration
+1. Customizable extensions
+1. Dynamic value correlation
+1. Fast rule generation
+1. Reliable testing.
 
 ## System requirements
 

diff --git a/docs/src/guide/after-recording.md b/docs/src/guide/after-recording.md
@@ -86,7 +86,7 @@ If you want to know more about Enterprise Correlation Templates, please contact
 
 4. Add the JTL file of the recording (if it isn't already loaded)
 
-By default, the plugin loads the JTL file that is found in the View Result Tree of the "bzm - Correlation Recorder" element.
+By default, the plugin loads the JTL file that is found in the View Result Tree of the "bzm - Auto Correlation Recorder" element.
 If you want to use a different JTL file, you can click on the "Browse" button and select the file you want to use.
 
 ::: warning

diff --git a/docs/src/guide/analysis-configuration.md b/docs/src/guide/analysis-configuration.md
@@ -3,9 +3,9 @@ prev: /guide/after-recording.md
 next: /guide/before-recording.md
 ---
 
-# Configuring the Correlation Recorder Plugin
+# Configuring the Auto Correlation Recorder Plugin
 
-The Correlation Recorder plugin in JMeter allows you to automatically correlate dynamic values in your
+The Auto Correlation Recorder plugin in JMeter allows you to automatically correlate dynamic values in your
 HTTP requests. The plugin provides several configurations that can be customized to meet your specific needs.
 
 ## Available Configurations
@@ -95,7 +95,7 @@ With this, the plugin will ignore any request that has `example.com` in its doma
 
 ### Exclude small values
 
-Don't want the Correlation Recorder Plugin to pick up certain small values? We get it! Sometimes those tiny arguments,
+Don't want the Auto Correlation Recorder Plugin to pick up certain small values? We get it! Sometimes those tiny arguments,
 like "amount" with a value of "100", just aren't worth correlating.
 
 If you're using Automatic Correlation analysis by Correlation Templates, this particular element probably won't be
@@ -115,7 +115,7 @@ correlation.configuration.min_value_length=10
 ### Exclude certain file types from correlation
 
 Let's say that you have a web application that serves different types of files such as images, PDFs, or CSS files.
-When recording your test scenario, you notice that the Correlation Recorder plugin is also capturing some of these
+When recording your test scenario, you notice that the Auto Correlation Recorder plugin is also capturing some of these
 files as dynamic values. Since these files are not part of the application's business logic, you may want to exclude
 them from the correlation analysis.
 

diff --git a/docs/src/guide/before-recording.md b/docs/src/guide/before-recording.md
@@ -72,7 +72,7 @@ requests, not only possible, but also easier than if you manage to do it, alone,
 
 Assuming you know [how Correlations works](#basic-concepts), lets jump into adding and configuring your rules.
 
-Go to _bzm - Correlation Recorder_ > click the Rules Tab.
+Go to _bzm - Auto Correlation Recorder_ > click the Rules Tab.
 
 You will be presented with multiple options to add, move and delete your Correlation Rules Groups, any rule that you want to add must be inside a group
 
@@ -348,7 +348,7 @@ This section will be divided into cases, from simple and common cases to unusual
 
 ## Variable Replacement
 
-The replacement of dynamic or static data in a request for JMeter Variables is one of the main objectives of the **Correlation Recorder**.
+The replacement of dynamic or static data in a request for JMeter Variables is one of the main objectives of the **Auto Correlation Recorder**.
 
 Mainly, the idea is to replace data for variables, therefore, we get a proper correlated script.
 The data we want to replace needs to match a certain regex, condition or even a criteria.

diff --git a/docs/src/guide/concepts.md b/docs/src/guide/concepts.md
@@ -66,24 +66,24 @@ requests with the JMeter variable containing the captured value. This ensures th
 a unique value.
 
 Manual correlation can be a time-consuming process, particularly when dealing with large or complex test scenarios
-that involve multiple dynamic values. This is where Automatic Correlation recorder comes in handy.
-The Automatic Correlation recorder provides several methods for automatically detecting and correlating dynamic
+that involve multiple dynamic values. This is where Auto Correlation Recorder comes in handy.
+The Auto Correlation Recorder provides several methods for automatically detecting and correlating dynamic
 values, including the use of regular expressions and JSON Path expressions.
 
-Here are some of the Automatic Correlation methods supported by Correlation Recorder:
+Here are some of the Automatic Correlation methods supported by Auto Correlation Recorder:
 
 1. RegEx (Regular Expression) Extractor
 1. JSON Extractor
 
-By using the Automatic Correlation recorder, however, you can simplify the process of correlating dynamic values and save time when creating test scripts.
+By using the Auto Correlation Recorder, however, you can simplify the process of correlating dynamic values and save time when creating test scripts.
 
 Please take a look at previous sections in the guide, where you can learn about the different mechanisms for
 automatically correlating dynamic values, either after the recording is being done or after the whole recording
 is done.
 
 ## Correlation Rule
 
-The Correlation Recorder plugin provides a powerful feature called "Correlation Rules" that simplifies the process of
+The Auto Correlation Recorder plugin provides a powerful feature called "Correlation Rules" that simplifies the process of
 making correlations in JMeter scripts. A Correlation Rule consists of three key components:
 
 Reference Variable: This variable is used to store the dynamic value that will be extracted from a response and
@@ -104,23 +104,23 @@ refer to the "Correlation Rules" section of the JMeter User Manual.
 
 ## Correlation Template
 
-The Correlation Recorder Plugin in JMeter utilizes Correlation Templates to maintain a simplified versioning of
+The Auto Correlation Recorder Plugin in JMeter utilizes Correlation Templates to maintain a simplified versioning of
 Correlation Rules and to store and organize them together. A Correlation Template includes essential information
 such as version number, name, description, and changes log.
 
-The Correlation Template serves as the foundation for the Automatic Correlation Analysis in the Correlation Recorder
+The Correlation Template serves as the foundation for the Automatic Correlation Analysis in the Auto Correlation Recorder
 Plugin. It allows the user to keep track of the version of the Correlation Rules being used for the analysis.
 This feature ensures that the user is always working with the latest version of the Correlation Rules and helps
 to maintain the accuracy of the results.
 
 Additionally, BlazeMeter provides several Correlation Templates that are designed for different technologies and
 protocols. These templates can be used to facilitate the correlation process for specific types of applications
-and make it easier for users to get started with the Correlation Recorder Plugin. To learn more about how to use
+and make it easier for users to get started with the Auto Correlation Recorder Plugin. To learn more about how to use
 Correlation Templates and benefit from this powerful feature, refer to the JMeter User Manual.
 
 ## Correlation Repository
 
-The Correlation Repository is a powerful mechanism used by the Correlation Recorder Plugin in JMeter to keep your set
+The Correlation Repository is a powerful mechanism used by the Auto Correlation Recorder Plugin in JMeter to keep your set
 of Correlation Templates up-to-date. This feature allows for continuous updates of Correlation Templates from external
 sources.
 

diff --git a/docs/src/guide/configuring-correlation-rules.md b/docs/src/guide/configuring-correlation-rules.md
@@ -4,12 +4,12 @@ sidebar: auto
 
 # Correlation Rules
 
-Correlation rules are the mechanism that allows you to define how to the Correlation Recorder will detect dynamic values, extract and replacement them in your recorded flow.
+Correlation rules are the mechanism that allows you to define how to the Auto Correlation Recorder will detect dynamic values, extract and replacement them in your recorded flow.
 
 ## Concepts
 
-A Correlation Rule consists of three elements: a **Reference variable name**, an **Extractor**, and a **Replacement**. 
+A Correlation Rule consists of three elements: a **Reference variable name**, an **Extractor**, and a **Replacement**.
 
 It's important to note that while the **Reference variable name must be defined,** it doesn't have to be unique. You can create **multiple** correlation rules with **the same name**.
 
-You can create a Correlation Rule with only an Extractor or only a Replacement, but at least one of them must be defined. If you create multiple rules with the same reference variable name, but different extractors or replacements, you'll be able to extract or replace the same dynamic value in different ways.
+You can create a Correlation Rule with only an Extractor or only a Replacement, but at least one of them must be defined. If you create multiple rules with the same reference variable name, but different extractors or replacements, you'll be able to extract or replace the same dynamic value in different ways.
diff --git a/docs/src/guide/correlation-process.md b/docs/src/guide/correlation-process.md
@@ -28,11 +28,11 @@ This process is repeated on each failed request until all the dynamic values are
 the dynamic values are not easy to locate, and sometimes, they might even have different values for the same argument
 within the same recording.
 
-When performing this process manually, it can be very time-consuming and frustrating. That's why we created the Correlation Recorder plugin, to automate this process and make it easier for you.
+When performing this process manually, it can be very time-consuming and frustrating. That's why we created the Auto Correlation Recorder plugin, to automate this process and make it easier for you.
 
 ## Methods of Correlation
 
-The Correlation Recorder plugin offers different methods of correlation, each one with its own advantages and disadvantages. In this section, we will cover all of them divided into two categories: Before the Recording and After the Recording.
+The Auto Correlation Recorder plugin offers different methods of correlation, each one with its own advantages and disadvantages. In this section, we will cover all of them divided into two categories: Before the Recording and After the Recording.
 
 ### Before the Recording
 
@@ -41,11 +41,13 @@ When we say 'Before the Recording,' it refers to the process between loading the
 Once you have finished configuring the rules, you can start the recording, and the plugin will automatically compare each request and response with the configured rules.
 
 Pros:
+
 - It is the most flexible method since you can configure it to your needs.
 - It is the most efficient method since it is the only one that does not require you to replay the recording.
 - It supports extensibility, allowing you to develop your own rules according to your needs.
 
 Cons:
+
 - It requires you to configure the rules before the recording is done.
 - It requires prior knowledge of potential dynamic values and how to configure the rules to extract them.
 - It requires a re-recording to test the changes made to the rules.
@@ -69,12 +71,14 @@ Let's see what each one of these methods has to offer.
 This method involves analyzing a recording using different Correlation Templates to automatically detect dynamic values. It generates a list of Correlation Suggestions based on those values and lets you choose which ones to apply in the Test Plan.
 
 Pros:
+
 - This is the most reliable method as it only correlates the dynamic values found with the rules in the Correlation Template.
 - It lets you test any set of Correlation Rules before applying them to the Test Plan.
 - You can easily roll-back changes made to the Test Plan as it stores it in a separate file.
 - It integrates with the Correlation Repository feature, allowing you to use the Correlation Templates from BlazeMeter, GitHub, or any other sources, aside from your local ones.
 
 Cons:
+
 - It still requires Rules to properly correlate the dynamic values.
 - It does not detect dynamic values that are not present in the Correlation Templates.
 
@@ -83,19 +87,21 @@ Cons:
 This method involves analyzing the results of a recording replay by comparing them with the original recording. It only focuses on the arguments of the requests that failed in the replay. By doing so, it generates a list of Correlation Suggestions based on the differences found, allowing you to select which ones to apply in the Test Plan.
 
 Pros:
+
 - It is pretty flexible since it detects dynamic values that you might not be aware of.
 - It is customizable since you can configure how the analysis is done.
 
 Cons:
+
 - It is not 100% bullet-proof since it might correlate dynamic values that are not dynamic.
 - It requires your input of which of the detected dynamic values you are interested in correlating. Otherwise, it will end up correlating values that you might not be interested in.
 
 While they both have their own advantages and disadvantages, we recommend you use the **Correlation by Using Correlation Templates** method as it is the most reliable one. With that being said, the **Correlation by Replay and Compare** method can be pretty useful when you are not sure where the dynamic values are present in the recording.
 
-In conclusion, the Correlation Process is a crucial step in JMeter testing, and the Correlation Recorder plugin provides several methods to make it easier and more efficient. By following the recommended methods, you can save time and effort and ensure a more accurate and reliable test plan.
+In conclusion, the Correlation Process is a crucial step in JMeter testing, and the Auto Correlation Recorder plugin provides several methods to make it easier and more efficient. By following the recommended methods, you can save time and effort and ensure a more accurate and reliable test plan.
 
 If you are new to JMeter, we recommend you start with the basics of recording and gradually move on to the more advanced topics of correlation. Take your time to learn and practice the different methods, and find the one that works best for your specific scenario.
 
 Also, keep in mind that correlation is not a one-time process. Dynamic values can change over time, and you may need to update your correlation rules or templates accordingly. So, make sure to regularly review and update your test plan to ensure its accuracy and reliability.
 
-In summary, the correlation process is a crucial part of JMeter testing, and the Correlation Recorder plugin provides valuable tools to make it easier and more efficient. By mastering the different methods and techniques, you can create accurate and reliable test plans that can help you identify performance issues and optimize your applications.
+In summary, the correlation process is a crucial part of JMeter testing, and the Auto Correlation Recorder plugin provides valuable tools to make it easier and more efficient. By mastering the different methods and techniques, you can create accurate and reliable test plans that can help you identify performance issues and optimize your applications.