Qlik Sense Proxy Health Check Endpoint(s)

[Andre_Sostizzo]

This article will outline approaches for an administrator to add monitoring of the uptime/health of the Qlik Sense Proxy Service. There will not be specific recommendations for how to implement the endpoints on the network appliance.

Resolution:

Option 1:

• Monitor https://sense.company.com{/virtualproxy}/qps/user (Documentation on the endpoint)
  • Example: GET https://qlikserver.domain.local/qps/user
• Expected return (since there is no authentication and thus no user session):
  • HTTP 200 Response
  • Content: {"session": "inactive"}

Option 2:

• Setup an anonymous virtual proxy
  • Do not worry about load balancing to an engine
  • Do not worry about allocating tokens, those aren’t needed
• Request a small JS / CSS file. Example paths:
  • /resources/assets/client/dialogs/measure-dialog/edit-measure/edit-measure.css is 0KB
  • /resources/autogenerated/product-info.js is 4.7KB
  • Example end points:
    • GET https://qlikserver.domain.local/resources/assets/client/dialogs/measure-dialog/edit-measure/edit-mea...
  • Expected return:
    • HTTP 200 Response
    • Content: (blank)

[Emmanuelle__Bustos]

Hi Andre and thank you.

Currently we are having an issue like this with a customer and I would appreciate if you could share a steps list to make the above procedure because is not clear to me. I was pointed by qlik Support to this article.

[Sonja_Bauernfeind]

Hello @Emmanuelle__Bustos 

Option 1 is similar to an example you can find in Qlik Sense QRS API using Xrfkey header in PowerShell - a customization example would be:

$hdrs = @{​​​​​​​​}​​​​​​​​
$url = "https://qlikserver1.domain.local/qps/user"
Invoke-RestMethod -Uri $url -Method Get -Headers $hdrs -UseDefaultCredentials

Option 2 can be used by simply opening the page in a web-browser to check and ensuring you get a reply.

[vegard_bakke]

Be careful about creating a anonymous virtual proxy. Default security rules for streams make alle streams open to anonymous users.

Check DevHub's Single Configurator after creating a anonymous v.proxy to see if you expose any streams you don't want to expose.

Assuming the anonymous v.proxy is named 'public', go to: https://qlik.company.com/public/dev-hub/single-configurator, and check if any apps are exposed.

This applies to security rules like:  ((user.name = ""))