Integrations

Integrations allow to configure connections with various data sources such as Grafana, InfluxDB, and so forth. It's crucial to properly set up these connections, as this tool operates closely with them.

InfluxDB

The InfluxDB configuration allows you to connect to InfluxDB, modify it, and utilize it in reporting.

How to add

1. First, open the "Integrations" tab.
2. Choose "InfluxDB" tab.
3. Then click on "Add new config".
4. Fill in all necessary fields.
5. Click "Save" button.

info

Currently, PerForge supports two versions of JMeter backend listeners:

• org.apache.jmeter.visualizers.backend.influxdb.InfluxdbBackendListenerClient: This is the standard one provided out of the box.
• mderevyankoaqa: A custom one that sends raw data and needs to be downloaded separately (jmeter-influxdb2-listener-plugin).

Backend listeners determine the data structure in InfluxDB, so it's crucial to choose the correct one. If you use a different backend listener, you won't be able to use this tool. We recommend to use the default one.

info

Much of the communication logic relies on influxdb tags. In the standard listener, you will need to include an additional TAG_testTitle: value tag. Please refrain from renaming this tag because the tool will stop working without it. In a custom listener, adding new tags is not necessary.

info

The timezone will be used when generating timestamps in a human-readable format. If no timezone is specified, UTC will be used by default. For example, a timestamp might use 'US/Eastern'. More available timezones can be found here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Grafana

The Grafana configuration enables us to establish a connection with a rendering plugin. This plugin is capable of rendering Grafana screenshots. Which then will be used in reports.

How to add

1. First, open the "Integrations" tab.
2. Choose "Grafana" tab.
3. Then click on "Add new config".
4. Fill in all necessary fields.
5. Click "Save" button.

info

Alongside PerForge, we provide several Grafana dashboards that should be used for reporting. Indeed, you can use your own dashboards and add them as well. However, to ensure they work correctly, it's crucial to utilize the same variables and names as in the provided dashboards.

warning

If you're using your own Grafana instance, you'll need to install the rendering plugin. Learn more about it here: grafana-image-renderer

To render a Grafana screenshot, please specify the appropriate tag names for the test title, app name, and baseline test title used on your dashboards. If you are using our default dashboards, you can leave the default values. If you are using custom dashboards, ensure that the current test title has the same tag name across all dashboards.

The dashboard URL can be taken from the Grafana URL:

https://10.10.10.10:3000/d/jmeter-test-results-standard-listener/jmeter-test-results-standard-listener

• /d/jmeter-test-results-standard-listener/jmeter-test-results-standard-listener is the Dashboard URL.

SMTP Mail

Mail is one of the target sources where the tool can create a report.

How to add

1. First, open the "Integrations" tab.
2. Choose "SMTP Mail" tab.
3. Then click on "Add new config".
4. Fill in all necessary fields.
5. Click "Save" button.

info

Instructions for using Google SMTP Server:

1. Generate an App Password: You will first need to obtain an 'App Password' from your Google account. Use the 'App Password' in the password field when setting up the integration SMTP Mail.

2. Enable POP and IMAP: Ensure that both POP and IMAP options are enabled on your Google account. This allows the application to communicate with your email account.

Detailed instructions for generating an App Password and enabling POP and IMAP can be found here: gmail-smtp.

3. For the server, use the following address: smtp.gmail.com.

4. Depending on your security requirements, you have the option to use either one of two ports:

• Port 465 (if secure connection is required, set SSL: true, and TLS: false)

Atlassian Confluence

Atlassian Confluence is one of the target sources where the tool can create a report.

How to add

1. First, open the "Integrations" tab.
2. Choose "Confluence" tab.
3. Then click on "Add new config".
4. Fill in all necessary fields.
5. Click "Save" button.

info

There are two types of tokens: one is an API token, which acts as a password, and the other is a Personal Access Token, which acts as both an email and a password. Be careful when creating a token; make sure to specify which type of token it is.

To create a Personal Access Token, please follow these instructions: personal-access-token-to-authenticate.

To create a API token, please follow these instructions: api-token-to-authenticate.

All necessary parameters can be taken from the URL of the page where the reports will be created:

https://easyreport.atlassian.net/wiki/spaces/MFS/pages/557057/JMeter+tests

• https://easyreport.atlassian.net is the Organization URL
• MFS is the Space key
• 557057 is the Parent ID

Atlassian Jira

Atlassian Jira is one of the target sources where the tool can create a report.

How to add

1. First, open the "Integrations" tab.
2. Choose "Jira" tab.
3. Then click on "Add new config".
4. Fill in all necessary fields.
5. Click "Save" button.

info

There are two types of tokens: one is an API token, which acts as a password, and the other is a Personal Access Token, which acts as both an email and a password. Be careful when creating a token; make sure to specify which type of token it is.

To create a Personal Access Token, please follow these instructions: personal-access-token-to-authenticate.

To create a API token, please follow these instructions: api-token-to-authenticate.

Project parameter can be taken from the URL of the projects board:

https://easyreport.atlassian.net/jira/software/projects/PF/boards/1

• PF is the Project

The Epic field and Epic name are used to link a ticket to a specific epic.

Azure Wiki

Azure Wiki is one of the target sources where the tool can create a report.

How to add

1. First, open the "Integrations" tab.
2. Choose "Azure" tab.
3. Then click on "Add new config".
4. Fill in all necessary fields.
5. Click "Save" button.

info

To create a personal access token, please follow these instructions: access-tokens-to-authenticate.

If the specified path does not exist, it will be automatically created.

All necessary parameters can be taken from the URL of the page where the reports will be created:

https://dev.azure.com/perfroge/PERFORGEPROJECT/_wiki/wikis/PERFORGEPROJECT.wiki/59/JMETER-REPORTS

• https://dev.azure.com/perfroge is the Wiki Organization Url
• PERFORGEPROJECT is the Wiki Project
• PERFORGEPROJECT.wiki is the Wiki Identifier

AI Support

AI Support allows you to use AI to analyze performance test results, create summaries for aggregated data and graphs.

How to add

1. First, open the "Integrations" tab.
2. Choose "AI Support" tab.
3. Then click on "Add new config".
4. Fill in all necessary fields.
5. Click "Save" button.

info

We support the use of OpenAI, Azure OpenAI and Google Gemini models. You can use any available models with your token.

For OpenAI, the following models are recommended:

1. Text model: gpt-4 or gpt-4-turbo or gpt-4o
2. Image model: gpt-4-turbo or gpt-4o

For Azure OpenAI, you also need to specify the Azure URL and API version, and the model names correspond to the deployment in Azure.

We have tested the following default deployments in Azure OpenAI, but you should verify if they are available to you:

1. Text model: gpt-4-32k or gpt-4-turbo-2024-04-09 or gpt-4o-2024-05-13
2. Image model: gpt-4-turbo-2024-04-09 or gpt-4o-2024-05-13

For Gemini, we have tested and recommend using the following models:

1. Text model: gemini-1.5-flash
2. Image model: gemini-1.5-flash

OpenAI

Azure OpenAI