web monitoring variables are not URL-encoded (ZBXNEXT-2074)

[ZBXNEXT-3747] Documentation for URL-encoded variables Created: 2017 Mar 20  Updated: 2024 Apr 10  Resolved: 2017 Apr 01

Status: Closed
Project: ZABBIX FEATURE REQUESTS
Component/s: Documentation (D)
Affects Version/s: None
Fix Version/s: 3.4.0alpha1, 3.4 (plan)

Type: Change Request (Sub-task) Priority: Major
Reporter: Rostislav Palivoda Assignee: Unassigned
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Team: Team A
Sprint: Sprint 1, Sprint 2, Sprint 3, Sprint 4, Sprint 5, Sprint 6

 Comments   
Comment by Martins Valkovskis [ 2017 Mar 23 ]

Updated documentation:

vso Punycode is only applied to domain name, the rest which is path is URL-encoded
https://www.w3.org/International/articles/idn-and-iri/

This is a bit misleading in what's new and steps.

Specifying URLs in Unicode characters is now supported in web scenario steps. Unicode characters are automatically punycode-converted to ASCII when executing a web scenario step.

For more details, see web monitoring steps.

martins-v Changed the wording - 'Domain name' instead of 'URL'.

vso CLOSED

Comment by Vladislavs Sokurenko [ 2017 Mar 27 ]

(1) Everything in example should be URL-encoded.

For example
Web scenario step 4
query fields are directly in URL instead of query fields.

martins-v RESOLVED

vso CLOSED

Comment by Vladislavs Sokurenko [ 2017 Mar 27 ]

(2) Screenshots are not properly cut. for example there are half of P displayed and input fields do not have borders on the right side.

martins-v RESOLVED

vso CLOSED

Comment by Vladislavs Sokurenko [ 2017 Mar 27 ]

(3) A little bit outdated and confusing description of variables
Here:
https://www.zabbix.com/documentation/3.4/manual/web_monitoring

It says:

Note: Variables are not URL-encoded by default. They are URL-encoded when executing the web scenario steps where these variables are used.

The first sentence is from old specification and the second one just controversial.

I suggest something more specific like:
Note: variables are automatically URL-encoded when used in form data and query fields but must be URL-encoded manually when used in raw post or directly in URL.

martins-v RESOLVED

vso CLOSED

Comment by Vladislavs Sokurenko [ 2017 Mar 27 ]

(4) Variable description of value obtain can be improved.

Please consider.

The macros can then be referenced in the steps as {username}, {password} and {hostid}. Zabbix will automatically replace them with actual values.

Maybe it's better to say.

The macros can then be referenced in the steps as {username}, {password} and {hostid}. Zabbix will automatically replace them with actual values from previous step or scenario.

martins-v I tried to describe in a separate sentence the situation with regex variables. Also documented that step-level variables affect the following step and not the current one. Pls review. RESOLVED

vso CLOSED

Comment by Vladislavs Sokurenko [ 2017 Mar 29 ]

(5) I don't know if it's worth mentioning in what's new that when upgrading then nothing will get automatically URL-encoded, user needs to switch from raw data to form data and move query fields from URL to separate fields.

martins-v Added to upgrade notes for 3.4. RESOLVED

vso CLOSED

Generated at Fri Apr 26 07:10:11 EEST 2024 using Jira 9.12.4#9120004-sha1:625303b708afdb767e17cb2838290c41888e9ff0.