GET /serviceengine/{uuid}/metrics/debug/

/serviceengine/{uuid}/metrics/debug/

Request

URI

GET

https://{api_host}/api/serviceengine/{uuid}/metrics/debug

COPY

Path Parameters

string

uuid

Required

UUID of the object to fetch

Header Parameters

string

X-Avi-Tenant

Optional

Avi Tenant Header

string

X-Avi-Tenant-UUID

Optional

Avi Tenant Header UUID

string

X-CSRFToken

Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

string

X-Avi-Version

Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

Authentication

This operation uses the following authentication methods.

basicAuth

Responses

200

Returns MetricsRuntimeDebug of type(s) application/json

{
    "grpc_thread_last_sleep_time": 0,
    "met_grpc_target_stats": [
        {
            "dos_stream_rpc_state": "string",
            "grpc_channel_state": "string",
            "metrics_stream_rpc_state": "string",
            "num_chan_create_reqs_sent": 0,
            "num_chan_create_rsps_rcvd": 0,
            "num_chan_delete_reqs_sent": 0,
            "num_chan_delete_rsps_rcvd": 0,
            "num_chan_maint_msgs_outstanding": 0,
            "num_chan_maint_msgs_skipped": 0,
            "num_chan_reinit_reqs_sent": 0,
            "num_chan_reinit_rsps_rcvd": 0,
            "num_chan_reset_reqs_sent": 0,
            "num_chan_reset_rsps_rcvd": 0,
            "num_dos_msg_drops": 0,
            "num_dos_msgs_sent": 0,
            "num_dos_rpc_auth_attempts": 0,
            "num_dos_rpc_auth_failure": 0,
            "num_dos_rpc_auth_success": 0,
            "num_met_objects": 0,
            "num_met_rpc_auth_attempts": 0,
            "num_met_rpc_auth_failure": 0,
            "num_met_rpc_auth_success": 0,
            "num_metrics_msg_drops": 0,
            "num_metrics_msgs_sent": 0,
            "target_ip": "string",
            "target_name": "string",
            "target_port": "string"
        }
    ],
    "met_grpc_thread_stats": [
        {
            "grpc_channel_connect_timeout": 0,
            "grpc_thread_poll_timer_running": false,
            "grpc_thread_relent_time": 0,
            "max_grpc_msgs_oustanding": 0,
            "num_grpc_chan_cleanup_req_rcvd": 0,
            "num_grpc_chan_cleanup_rsps_rcvd": 0,
            "num_grpc_chan_contexts": 0,
            "num_grpc_chan_create_dup_errors": 0,
            "num_grpc_chan_create_errors": 0,
            "num_grpc_chan_create_req_rcvd": 0,
            "num_grpc_chan_create_retries": 0,
            "num_grpc_chan_create_rsps_rcvd": 0,
            "num_grpc_chan_create_success": 0,
            "num_grpc_chan_delete_errors": 0,
            "num_grpc_chan_delete_req_rcvd": 0,
            "num_grpc_chan_delete_rsps_rcvd": 0,
            "num_grpc_chan_delete_success": 0,
            "num_grpc_chan_maint_msgs_processed": 0,
            "num_grpc_chan_reinit_errors": 0,
            "num_grpc_chan_reinit_req_rcvd": 0,
            "num_grpc_chan_reinit_rsps_rcvd": 0,
            "num_grpc_chan_reset_req_rcvd": 0,
            "num_grpc_chan_reset_rsps_rcvd": 0,
            "num_grpc_dos_stream_write_errors": 0,
            "num_grpc_dos_stream_write_success": 0,
            "num_grpc_met_stream_write_errors": 0,
            "num_grpc_met_stream_write_success": 0,
            "num_grpc_msgs_outstanding": 0,
            "num_misc_errors": 0,
            "num_rpc_auth_errors": 0,
            "num_rpc_auth_success": 0
        }
    ],
    "metrics_thread_last_sleep_time": 0
}

integer As uint32 As uint32

grpc_thread_last_sleep_time

Optional

Number of milisec grpc thread took sleep last time. Field introduced in 21.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of object

met_grpc_target_stats

Optional

Per metrics-target stats. Metrics-Target is metrics-mgr-ip + metrics-port. Field introduced in 22.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of object

met_grpc_thread_stats

Optional

Stats for metrics grpc channel maintenance messaging. Field introduced in 22.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

metrics_thread_last_sleep_time

Optional

Number of milisec metrics thread took sleep last time. Field introduced in 21.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

401

Operation doesn't return any data structure

404

object not found

Operation doesn't return any data structure

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/serviceengine/{uuid}/metrics/debug

On This Page

Description

Request

Path Parameters

Header Parameters

Authentication

Response

200 Response Body

Errors

Service Engine Operations