Class DebugAPI

Debug API

Index

Constructors

Methods

getDebugPprofAllocs getDebugPprofAllProfiles getDebugPprofBlock getDebugPprofCmdline getDebugPprofGoroutine getDebugPprofHeap getDebugPprofMutex getDebugPprofProfile getDebugPprofThreadCreate getDebugPprofTrace

Constructors

constructor

new DebugAPI(influxDB: InfluxDB): DebugAPI
Creates DebugAPI
Parameters
- influxDB: InfluxDB
  an instance that knows how to communicate with InfluxDB server
Returns DebugAPI
- Defined in apis/src/generated/DebugAPI.ts:118

Methods

getDebugPprofAllocs

getDebugPprofAllocs(
request?: GetDebugPprofAllocsRequest,
requestOptions?: RequestOptions,
): Promise<string>
Retrieve the memory allocations runtime profile. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDebugPprofAllocs
Parameters
- Optionalrequest: GetDebugPprofAllocsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/DebugAPI.ts:146

getDebugPprofAllProfiles

getDebugPprofAllProfiles(
request?: GetDebugPprofAllProfilesRequest,
requestOptions?: RequestOptions,
): Promise<string>
Retrieve all runtime profiles. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDebugPprofAllProfiles
Parameters
- Optionalrequest: GetDebugPprofAllProfilesRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/DebugAPI.ts:128

getDebugPprofBlock

getDebugPprofBlock(
request?: GetDebugPprofBlockRequest,
requestOptions?: RequestOptions,
): Promise<string>
Retrieve the block runtime profile. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDebugPprofBlock
Parameters
- Optionalrequest: GetDebugPprofBlockRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/DebugAPI.ts:167

getDebugPprofCmdline

getDebugPprofCmdline(
request?: GetDebugPprofCmdlineRequest,
requestOptions?: RequestOptions,
): Promise<string>
Retrieve the command line invocation. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDebugPprofCmdline
Parameters
- Optionalrequest: GetDebugPprofCmdlineRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/DebugAPI.ts:188

getDebugPprofGoroutine

getDebugPprofGoroutine(
request?: GetDebugPprofGoroutineRequest,
requestOptions?: RequestOptions,
): Promise<string>
Retrieve the goroutines runtime profile. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDebugPprofGoroutine
Parameters
- Optionalrequest: GetDebugPprofGoroutineRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/DebugAPI.ts:206

getDebugPprofHeap

getDebugPprofHeap(
request?: GetDebugPprofHeapRequest,
requestOptions?: RequestOptions,
): Promise<string>
Retrieve the heap runtime profile. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDebugPprofHeap
Parameters
- Optionalrequest: GetDebugPprofHeapRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/DebugAPI.ts:227

getDebugPprofMutex

getDebugPprofMutex(
request?: GetDebugPprofMutexRequest,
requestOptions?: RequestOptions,
): Promise<string>
Retrieve the mutual exclusion (mutex) runtime profile. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDebugPprofMutex
Parameters
- Optionalrequest: GetDebugPprofMutexRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/DebugAPI.ts:249

getDebugPprofProfile

getDebugPprofProfile(
request?: GetDebugPprofProfileRequest,
requestOptions?: RequestOptions,
): Promise<string>
Retrieve the CPU runtime profile. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDebugPprofProfile
Parameters
- Optionalrequest: GetDebugPprofProfileRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/DebugAPI.ts:270

getDebugPprofThreadCreate

getDebugPprofThreadCreate(
request?: GetDebugPprofThreadCreateRequest,
requestOptions?: RequestOptions,
): Promise<string>
Retrieve the threadcreate runtime profile. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDebugPprofThreadCreate
Parameters
- Optionalrequest: GetDebugPprofThreadCreateRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/DebugAPI.ts:290

getDebugPprofTrace

getDebugPprofTrace(
request?: GetDebugPprofTraceRequest,
requestOptions?: RequestOptions,
): Promise<string>
Retrieve the runtime execution trace. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDebugPprofTrace
Parameters
- Optionalrequest: GetDebugPprofTraceRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/DebugAPI.ts:311

Class DebugAPI

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DebugAPI

Methods

getDebugPprofAllocs

Parameters

Returns Promise<string>

getDebugPprofAllProfiles

Parameters

Returns Promise<string>

getDebugPprofBlock

Parameters

Returns Promise<string>

getDebugPprofCmdline

Parameters

Returns Promise<string>

getDebugPprofGoroutine

Parameters

Returns Promise<string>

getDebugPprofHeap

Parameters

Returns Promise<string>

getDebugPprofMutex

Parameters

Returns Promise<string>

getDebugPprofProfile

Parameters

Returns Promise<string>

getDebugPprofThreadCreate

Parameters

Returns Promise<string>

getDebugPprofTrace

Parameters

Returns Promise<string>

Settings

On This Page