DiagnosticsMixin Service APIv1

Understanding the DiagnosticsMixin service APIv1, as known as ntt.mixins.diagnostics.v1.

Here is the list of resources supported in DiagnosticsMixin service APIv1:

DiagnosticsMixin Service Shared Methods and Messages

DiagnosticsMixin Service Shared Methods

Here is the list of DiagnosticsMixin service shared methods:

Healthcheck Method

Healthcheck

rpc Healthcheck(HealthcheckRequest) returns (HealthcheckResponse)

EnableProfiler Method

EnableProfiler

rpc EnableProfiler(EnableProfilerRequest) returns (EnableProfilerResponse)

GetMemoryStats Method

GetMemoryStats

rpc GetMemoryStats(GetMemoryStatsRequest) returns (GetMemoryStatsResponse)

ForceMemRelease Method

ForceMemRelease

rpc ForceMemRelease(ForceMemReleaseRequest) returns (ForceMemReleaseResponse)

SetMemoryLimit Method

SetMemoryLimit

rpc SetMemoryLimit(SetMemoryLimitRequest) returns (SetMemoryLimitResponse)

GetCallStats Method

GetCallStats

rpc GetCallStats(GetCallStatsRequest) returns (GetCallStatsResponse)

GetFailedCalls Method

GetFailedCalls

rpc GetFailedCalls(GetFailedCallsRequest) returns (GetFailedCallsResponse)

GetSlowestCalls Method

GetSlowestCalls

rpc GetSlowestCalls(GetSlowestCallsRequest) returns (GetSlowestCallsResponse)

DiagnosticsMixin Service Shared Messages

Here is the list of DiagnosticsMixin service shared messages:

CallData Message

Name	Type	Description
full_method	string
request	.google.protobuf.Struct
start_time	.google.protobuf.Timestamp
end_time	.google.protobuf.Timestamp
duration	.google.protobuf.Duration
exit_code	int32
exit_message	string
call_id	string
principal	string
root_span	CallData.SpanData

CallData.SpanData Message

Name	Type	Description
name	string
start_time	.google.protobuf.Timestamp
end_time	.google.protobuf.Timestamp
duration	.google.protobuf.Duration
exit_msg	string
exit_code	int32
attrs	.google.protobuf.Struct
checkpoints	repeated CallData.SpanData.Checkpoint
kids	repeated CallData.SpanData

CallData.SpanData.Checkpoint Message

Name	Type	Description
name	string
evt_time	.google.protobuf.Timestamp
elapsed	.google.protobuf.Duration

EnableProfilerRequest Message

Request message for method [EnableProfiler][ntt.mixins.diagnostics.v1.EnableProfiler]

Name	Type	Description
enable	bool

EnableProfilerResponse Message

Response message for method [EnableProfiler][ntt.mixins.diagnostics.v1.EnableProfiler]

Name	Type	Description
pod_id	string
enabled	bool

ForceMemReleaseRequest Message

Request message for method [ForceMemRelease][ntt.mixins.diagnostics.v1.ForceMemRelease]

Name	Type	Description
none	none	none

ForceMemReleaseResponse Message

Response message for method [ForceMemRelease][ntt.mixins.diagnostics.v1.ForceMemRelease]

Name	Type	Description
pod_id	string

GetCallStatsRequest Message

Request message for method [GetCallStats][ntt.mixins.diagnostics.v1.GetCallStats]

Name	Type	Description
none	none	none

GetCallStatsResponse Message

Response message for method [GetCallStats][ntt.mixins.diagnostics.v1.GetCallStats]

Name	Type	Description
pod_id	string
active_conns	int64
cumulative_conns	int64
active_unary_calls	int64
cumulative_unary_calls	int64
active_stream_calls	int64
cumulative_stream_calls	int64

GetFailedCallsRequest Message

Request message for method [GetFailedCalls][ntt.mixins.diagnostics.v1.GetFailedCalls]

Name	Type	Description
full_method	string
codes	repeated int32

GetFailedCallsResponse Message

Response message for method [GetFailedCalls][ntt.mixins.diagnostics.v1.GetFailedCalls]

Name	Type	Description
pod_id	string
calls	repeated CallData

GetMemoryStatsRequest Message

Request message for method [GetMemoryStats][ntt.mixins.diagnostics.v1.GetMemoryStats]

Name	Type	Description
none	none	none

GetMemoryStatsResponse Message

Response message for method [GetMemoryStats][ntt.mixins.diagnostics.v1.GetMemoryStats]

Name	Type	Description
pod_id	string
goroutines_count	int64
mallocs	int64	Cumulative, total heap objects allocated
frees	int64	Cumulative, total heap objects released
heap_sys	double	largest heap size that had been (obtained from OS)
heap_alloc	double	Alloc from Golang MemStats (heap object bytes)
heap_idle	double	Idle heap span sizes. With heap_released, it tells how much can be returned to OS
heap_inuse	double	Memory in in-use heap spans.
heap_released	double	Heap memory released back to the OS
heap_objects	int64	Heap objects gauge
heap_alloc_total	double	heap alloc (cumulative)
stack_inuse	double	Bytes for in use stack spans
stack_sys	double	Bytes of stack memory allocated from OS
mspan_inuse	double	bytes of off-heap spans
mspan_sys	double	bytes of off heap allocated from OS
mcache_inuse	double	bytes of off-heap for mcache structs
mcache_sys	double	bytes of off heap mcache structs allocated from OS
buck_hashsys	double	Bytes of profiling bucket hash tables
gc_sys	double	Bytes for gabage collector metadata
other_sys	double	Other off heap
next_gc	double	Next target heap size for GC
last_gc_time	.google.protobuf.Timestamp	last time gc has run
pause_total_ms	int64	Stop-the-world cumulative time for GC (milliseconds)
num_gc	int64	Number times GC has run
num_forcedgc	int64	Number of forced GC times
gccpu_fraction	double	Amount of CPU fraction used by GC
sys	double	Total memory obtained from the OS.

GetSlowestCallsRequest Message

Request message for method [GetSlowestCalls][ntt.mixins.diagnostics.v1.GetSlowestCalls]

Name	Type	Description
full_method	string

GetSlowestCallsResponse Message

Response message for method [GetSlowestCalls][ntt.mixins.diagnostics.v1.GetSlowestCalls]

Name	Type	Description
pod_id	string
calls	repeated CallData

HealthcheckRequest Message

Request message for method [Healthcheck][ntt.mixins.diagnostics.v1.Healthcheck]

Name	Type	Description
none	none	none

HealthcheckResponse Message

Response message for method [Healthcheck][ntt.mixins.diagnostics.v1.Healthcheck]

Name	Type	Description
status	string

SetMemoryLimitRequest Message

Request message for method [SetMemoryLimit][ntt.mixins.diagnostics.v1.SetMemoryLimit]

Name	Type	Description
limit_megabytes	int64
gc_percent	int32

SetMemoryLimitResponse Message

Response message for method [SetMemoryLimit][ntt.mixins.diagnostics.v1.SetMemoryLimit]

Name	Type	Description
pod_id	string