URL Debug Tool

Overview

Applications Manager's URL Debug Tool helps in debugging the URLs and monitors, and displays the performance of each and every components in the webpage. It executes the URL and collects the response, which is then displayed on a result page containing the results of the APIs or URL which contains the required performance metrics.

Supported monitors

Following are the list of monitors supported in the URL Debug Tool:

S.No. Monitor types Supported APIs Collected metrics
1 Apache Solr Admin cores Apache Solr availability and details of the cores.
Admin thread information Thread details and count of threads in different states.
Admin properties information Configuration details of Solr.
2 Apache Spark master API Status Node details, Memory utilization, master overview.
Monitor metrics Worker details, Application details, Memory details, RDD Details, Configuration details.
3 Apache Spark worker API Status Memory utilization, Worker overview.
Monitor metrics Executors, Memory details, RDD Details, Configuration details.
4 ElasticSearch cluster Cluster name Cluster health details, shard details, Memory details, Core details.
Cluster health Cluster health details, Node counts, shard details.
Cluster status, count of indices, count of docs in the indices Cluster health details, shard details, Memory details, Core details.
HTTP Nodes All the node's host, IP addesss, http and attribute details.
CAT Master Master node's ID, host, bound IP address, name.
CAT Nodes Cluster node details.
Stats Stats related to the shards.
Count of nodes Cluster health details, shard details, Memory details, Core details.
Nodes Complete node details of a cluster.
5 HAProxy Custom API Details of Queue, Session rate, Sessions, bytes, denied, Errors, Warnings, Server.
6 IIS Server --- Webpage content
7 Nginx Nginx status Active connections, Server request handling details.
8 Nginx Plus Connection Connection stats.
SSL SSL details (Handshake details).
Requests Request details (Total requests, current requests).
HTTP Zones HTTP Server zone details (Requests, responses by response codes).
HTTP Upstreams HTTP Upstream details (Demo-backend, trac-backend, hg-backend,lxr-backend).
Caches Cache details.
TCP/UDP Zones TCP/UDP Zones details (postgresql loadbalancer, dns loadbalancer).
TCP/UDP Upstreams TCP/UDP Upstream details (postgresql backends, dns_udp_backends, unused_tcp_backends).
9 REST API Monitor Any URL Response of the API.
10 Webpage analyzer Any URL Webpage content
11 Website Content Monitor Any URL Webpage content
12 URL Monitor Any URL Webpage content

Configuring URL Debug tool

Follow the steps given below to execute URLs in the URL debug tool:

  1. Under Settings tab, click on Self Help Tools under Tools section.
  2. Click on URL Debug link. The URL Debug tool page will be displayed.
  3. Choose the Monitor Name from the dropdown. In case you want to try new monitors/URLs, select New Monitor from the dropdown.
  4. Choose the Monitor Type for which the debug should be performed.
  5. After selecting the Monitor Type, specify the required details that are to be entered with respect to the monitor type chosen.
    • If the selected monitor type is HTTP(s) URLs, then HTTP(s) URL monitor form will be displayed along with the selected monitors data (including client certificate file).
    • If the selected monitor is URL-based like Webpage Analyzer, then a form with the corresponding monitor's URL address will be displayed.
    • If the selected monitor is API-based like ElasticSearch or Apache Solr, the corresponding form will be displayed for the selected monitor type along with the monitor's hostname, port and the list of APIs used for data collection (if any). If the particular monitor type allows customizable APIs, then an option to add custom APIs will be given.

      Note: A maximum number of 15 custom APIs can only be executed in the URL Debug tool.

  6. Based on the monitor selected, further options will be displayed. After entering all the required details, click Execute.

On clicking Execute, data collection will occur based on the specified data and the result page will be displayed. This page comprises of details such as,

  • Metric name / URL address
  • Connectivity status
  • Response code
  • Response time (in milliseconds)
  • Webpage content and its size (in bytes)
  • Detailed response time split up

You can also view and copy the webpage contents (in HTML form) by clicking over the respective icons.

Additionally, you can download the complete debug report in the form of PDF using the Export option. Also, you can make use of the Send to support option to send the report to the support via mail, which comprises of the mail subject, request details and the PDF Report of the collected response.