< img height="1" width="1" style="display:none;" alt="" src="https://px.ads.linkedin.com/collect/?pid=3131724&fmt=gif" />

View Cluster Gateway Details

This section introduces how to view cluster gateway details.

Prerequisites

  • KubeSphere Gateway should have been installed and enabled.

  • You should be a member of a cluster and have the cluster-admin role in the cluster. For more information, please refer to Cluster Members and Cluster Roles.

Steps

  1. Log in to the KubeSphere web console with a user who has the cluster-admin role.

  2. Click Cluster Settings > Gateway Settings in the left navigation pane.

  3. On the right side of the page, select Manage > View Details to open the gateway details page.

  4. On the gateway details page, view the resource attributes of the gateway in the Attributes area on the left.

    ParameterDescription

    Cluster

    The cluster to which the gateway belongs.

    Creation Time

    The creation time of the gateway.

    Update Time

    The update time of the gateway.

    Creator

    The user who enabled the gateway.

  5. On the gateway details page, click the Configuration Options tab to view the configuration options of the gateway. The gateway functionality of KubeSphere is based on Nginx Ingress Controller. For more information about gateway configuration options, please refer to the Nginx Ingress Controller Documentation.

  6. On the right side of the page, click the Monitoring tab to view the request data of the gateway.

    Note

    To use the gateway monitoring function, the WhizardTelemetry Monitoring extension should be installed and enabled.

    • The Overview area provides the following information:

      ParameterDescription

      Total Requests

      The total number of requests received by the gateway within the specified time range.

      Request Count

      The number of requests with response status codes of 4XX or 5XX within the specified time range. Click the dropdown list to view the number of 4XX requests and 5XX requests separately.

      Successful Requests

      The percentage of successful requests within the specified time range.

      Average Latency

      The average latency of all requests within the specified time range.

      P50 Latency

      The median latency of all requests within the specified time range.

      P95 Latency

      The 95th percentile latency of all requests within the specified time range, i.e., 95% of the requests have a latency less than or equal to this value.

      P99 Latency

      The 99th percentile latency of all requests within the specified time range, i.e., 99% of the requests have a latency less than or equal to this value.

    • The line charts at the bottom of the page display dynamic request data.

      ParameterDescription

      Request Count

      The number of requests per second received by the gateway within the specified time range.

      Connection Count

      The number of connections per second received by the gateway within the specified time range.

      Request Latency

      The median latency, 95th percentile latency, 99th percentile latency, and average latency of all requests within the specified time range.

      Failed Request Count

      The number of failed requests received by the gateway within the specified time range.

      Network Traffic

      The inbound traffic per second of the gateway within the specified time range.

    • Click timed-task in the upper right corner to set the time range.

    • Click start/pause in the upper right corner to enable/disable real-time data refresh.

    • Click refresh in the upper right corner to refresh data manually.

  7. On the gateway details page, click the Gateway Logs tab to view the logs of the gateway.

    Note

    To use the gateway log search function, the WhizardTelemetry Logging extension should be installed and enabled.

    • Click the search box at the top of the Gateway Logs tab and set the search conditions to search for log data by keywords, pods, or time range.

    • Click start-dark/stop-dark-white to start/stop real-time data refresh.

    • Click Refresh Interval to set the data refresh interval to 5s, 10s, or 20s.

    • Click export to download the log file to your local machine.

  8. On the gateway details page, click the Resource Status tab to view the number of pod replicas, container ports, and pods of the gateway workload.

    ParameterDescription

    Replicas

    The current and expected pod replica count of the workload.

    Ports

    The port name, protocol, and port number of the containers managed by the workload.

    Pods

    All the pods running in the workload.

    • Click chevron-down to view information about the containers running in the pod.

    • Click the name of the pod to view container details.

    • Enter keywords in the search box above the pod list to search for pods whose names contain specific keywords.

    • Click Refresh in the upper-right corner of the pod list to refresh the information.

  9. On the gateway details page, click the Metadata tab to view the annotations of the gateway service.

Receive the latest news, articles and updates from KubeSphere


Thanks for the feedback. If you have a specific question about how to use KubeSphere, ask it on Slack. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.

What’s on this Page