Skip to content
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

Enabled Different options for user to select to send SampleData/ResponseData as required. #32

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Enabled Different options for user to select to send SampleData/ResponseData as required. #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
886b13c
Update AzureBackendClient.java
ssharmasurender3 Feb 10, 2023
2368b5e
Added Changes rekated to giving option to choose from
ssharmasurender3 Apr 18, 2023
79eeaa7
Create maven-publish.1yml
ssharmasurender3 Apr 18, 2023
4be0b7e
Added Steps to upload an Artifact
ssharmasurender3 Apr 18, 2023
e0a5b00
Update maven-publish.1yml
ssharmasurender3 Apr 18, 2023
a3f1cdc
Fixed the Typo in VariableName
ssharmasurender3 Apr 18, 2023
774ef61
Made Changes Related to Option Selection
ssharmasurender3 Apr 18, 2023
bb3edd8
updated image for configuration
ssharmasurender3 Apr 18, 2023
dddc573
Merge branch 'master' into master
ssharmasurender3 Apr 18, 2023
b0e6ee9
Delete maven-publish.1yml
ssharmasurender3 Apr 18, 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
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,12 @@ Then, in the Parameters table, configure the following attributes.
| *samplersList* | Optional list of samplers separated by a semi-colon (`;`) that the listener will collect and send metrics to Application Insights. If the list is empty, the listener will not filter samplers and send metrics from all of them. Defaults to an empty string. | No |
| *useRegexForSamplerList* | If set to `true` the `samplersList` will be evaluated as a regex to filter samplers. Defaults to `false`. | No |
| *responseHeaders* | Optional list of response headers separated by a semi-colon (`;`) that the listener will collect and send values to Application Insights. | No |
| *logResponseData* | Boolean to indicate whether or not the response data should be captured. If set to `true`, the response data will be captured as a string into the _ResponseData_ property. Defaults to `false`. | No |
| *logSampleData* | Boolean to indicate whether or not the sample data should be captured. If set to `true`, the sample data will be captured as a string into the _SampleData_ property. Defaults to `false`. | No |
| *logResponseDataOption* | Option to Selected "onError"/"always"/"None", if onError is selected if any sample fails ResponseData of that sample will also be logged and incase of always, responseData will be saved adlways , if selected Nothing/None, ReponseData will never be saved Defaults to `onError`. | No |
| *logSampleDataOption* | Option to Selected "onError"/"always"/"None", if onError is selected if any sample fails SanpleData of that sample will also be logged and incase of always, SampleData will be saved adlways , if selected Nothing/None, SampleData will never be saved Defaults to `onError`. | No |
| *instrumentationKey* | The Instrumentation Key of your Application Insights instance. <br>⚠️ **Deprecated**: use *connectionString* instead. | No |

*Example of configuration:*

![Screenshot of configuration](docs/configuration.jpg "Screenshot of JMeter configuration")
![image](https://user-images.githubusercontent.com/46219412/232789063-023f578e-069c-4f29-bf7c-64292f1aaa0c.png)

#### Custom properties

Expand Down
61 changes: 48 additions & 13 deletions src/main/java/io/github/adrianmo/jmeter/backendlistener/azure/AzureBackendClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,10 @@ public class AzureBackendClient extends AbstractBackendListenerClient {
private static final String KEY_CUSTOM_PROPERTIES_PREFIX = "ai.";
private static final String KEY_HEADERS_PREFIX = "aih.";
private static final String KEY_RESPONSE_HEADERS = "responseHeaders";
private static final String KEY_LOG_RESPONSE_DATA = "logResponseData";
private static final String KEY_LOG_SAMPLE_DATA = "logSampleData";
//private static final String KEY_LOG_RESPONSE_DATA = "logResponseData";
private static final String KEY_LOG_RESPONSE_DATA_OPTION = "logResponseDataOption";
//private static final String KEY_LOG_SAMPLE_DATA = "logSampleData";
private static final String KEY_LOG_SAMPLE_DATA_OPTION = "logSampleDataOption";

/**
* Default argument values.
Expand All @@ -54,8 +56,10 @@ public class AzureBackendClient extends AbstractBackendListenerClient {
private static final boolean DEFAULT_LIVE_METRICS = true;
private static final String DEFAULT_SAMPLERS_LIST = "";
private static final boolean DEFAULT_USE_REGEX_FOR_SAMPLER_LIST = false;
private static final boolean DEFAULT_LOG_RESPONSE_DATA = false;
private static final boolean DEFAULT_LOG_SAMPLE_DATA = false;
//private static final boolean DEFAULT_LOG_RESPONSE_DATA = false;
private static final String DEFAULT_LOG_RESPONSE_DATA_OPTION = "onError";
//private static final boolean DEFAULT_LOG_SAMPLE_DATA = false;
private static final String DEFAULT_LOG_SAMPLE_DATA_OPTION = "onError";

/**
* Separator for samplers list.
Expand Down Expand Up @@ -105,12 +109,21 @@ public class AzureBackendClient extends AbstractBackendListenerClient {
/**
* Whether to log the response data to the backend
*/
private boolean logResponseData;
//private boolean logResponseData;
/**
* Option value selected for response data which can be sent to the backend
*/
private String logResponseDataOption;

/**
* Whether to log the sample data to the backend
*/
private boolean logSampleData;
//private boolean logSampleData;

/**
* Option value selected for sample data which can be sent to the backend
*/
private String logSampleDataOption;

public AzureBackendClient() {
super();
Expand All @@ -124,8 +137,10 @@ public Arguments getDefaultParameters() {
arguments.addArgument(KEY_LIVE_METRICS, Boolean.toString(DEFAULT_LIVE_METRICS));
arguments.addArgument(KEY_SAMPLERS_LIST, DEFAULT_SAMPLERS_LIST);
arguments.addArgument(KEY_USE_REGEX_FOR_SAMPLER_LIST, Boolean.toString(DEFAULT_USE_REGEX_FOR_SAMPLER_LIST));
arguments.addArgument(KEY_LOG_RESPONSE_DATA, Boolean.toString(DEFAULT_LOG_RESPONSE_DATA));
arguments.addArgument(KEY_LOG_SAMPLE_DATA, Boolean.toString(DEFAULT_LOG_SAMPLE_DATA));
//arguments.addArgument(KEY_LOG_RESPONSE_DATA, Boolean.toString(DEFAULT_LOG_RESPONSE_DATA));
arguments.addArgument(KEY_LOG_RESPONSE_DATA_OPTION, DEFAULT_LOG_RESPONSE_DATA_OPTION);
//arguments.addArgument(KEY_LOG_SAMPLE_DATA, Boolean.toString(DEFAULT_LOG_SAMPLE_DATA));
arguments.addArgument(KEY_LOG_SAMPLE_DATA_OPTION, DEFAULT_LOG_SAMPLE_DATA_OPTION);

return arguments;
}
Expand All @@ -136,8 +151,13 @@ public void setupTest(BackendListenerContext context) throws Exception {
liveMetrics = context.getBooleanParameter(KEY_LIVE_METRICS, DEFAULT_LIVE_METRICS);
samplersList = context.getParameter(KEY_SAMPLERS_LIST, DEFAULT_SAMPLERS_LIST).trim();
useRegexForSamplerList = context.getBooleanParameter(KEY_USE_REGEX_FOR_SAMPLER_LIST, DEFAULT_USE_REGEX_FOR_SAMPLER_LIST);
logResponseData = context.getBooleanParameter(KEY_LOG_RESPONSE_DATA, DEFAULT_LOG_RESPONSE_DATA);
logSampleData = context.getBooleanParameter(KEY_LOG_SAMPLE_DATA, DEFAULT_LOG_SAMPLE_DATA);
//logResponseData = context.getBooleanParameter(KEY_LOG_RESPONSE_DATA, DEFAULT_LOG_RESPONSE_DATA);
logResponseDataOption = context.getParameter(KEY_LOG_RESPONSE_DATA_OPTION, DEFAULT_LOG_RESPONSE_DATA_OPTION);
//logSampleData = context.getBooleanParameter(KEY_LOG_SAMPLE_DATA, DEFAULT_LOG_SAMPLE_DATA);
logSampleDataOption = context.getParameter(KEY_LOG_SAMPLE_DATA_OPTION, DEFAULT_LOG_SAMPLE_DATA_OPTION);
log.warn("Logging Response Data on "+logResponseDataOption);
log.warn("Logging Sample Data on "+logSampleDataOption);


Iterator<String> iterator = context.getParameterNamesIterator();
while (iterator.hasNext()) {
Expand Down Expand Up @@ -213,12 +233,27 @@ private void trackRequest(String name, SampleResult sr) {
if (sr.getURL() != null) {
req.setUrl(sr.getURL());
}

if (logSampleData) {
// Verify what Option for SampleData Collection is Selected if 'onError' is Selected And Error is observed, Log it
if (logSampleDataOption.equals("onError")) {
// If There is error Reported Log the Message
if (sr.getErrorCount() != 0)
{
req.getProperties().put("SampleData", sr.getSamplerData());
}
}
// Else Check if 'always' Selected, Always Log Sample Data
else if (logSampleDataOption.equals("always")) {
req.getProperties().put("SampleData", sr.getSamplerData());
}

if (logResponseData) {
// Verify what Option for ResponseData Collection is Selected if 'onError' is Selected And Error is observed, Log it
if (logResponseDataOption.equals("onError")) {
if (sr.getErrorCount() != 0) {
properties.put("ResponseData", sr.getResponseDataAsString());
}
}
// Else Check if 'always' Selected, Always Log Response Data
else if (logResponseDataOption.equals("always")) {
properties.put("ResponseData", sr.getResponseDataAsString());
}

Expand Down