Package com.influxdb.client.service

Interface DebugService

public interface DebugService

  • Method Summary

    Modifier and Type
    Method
    Description
    retrofit2.Call<okhttp3.ResponseBody>
    getDebugPprofAllocs(String zapTraceSpan, Long debug, String seconds)
    Get the memory allocations runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of all past memory allocations.
    retrofit2.Call<okhttp3.ResponseBody>
    getDebugPprofAllProfiles(String zapTraceSpan, String cpu)
    Get all runtime profiles Get reports for the following [Go runtime profiles](https://pkg.go.dev/runtime/pprof): - **allocs**: All past memory allocations - **block**: Stack traces that led to blocking on synchronization primitives - **cpu**: (Optional) Program counters sampled from the executing stack.
    retrofit2.Call<okhttp3.ResponseBody>
    getDebugPprofBlock(String zapTraceSpan, Long debug, String seconds)
    Get the block runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of stack traces that led to blocking on synchronization primitives.
    retrofit2.Call<String>
    getDebugPprofCmdline(String zapTraceSpan)
    Get the command line invocation Get the command line that invoked InfluxDB.
    retrofit2.Call<okhttp3.ResponseBody>
    getDebugPprofGoroutine(String zapTraceSpan, Long debug, String seconds)
    Get the goroutines runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of all current goroutines.
    retrofit2.Call<okhttp3.ResponseBody>
    getDebugPprofHeap(String zapTraceSpan, Long debug, String seconds, Long gc)
    Get the heap runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of memory allocations for live objects.
    retrofit2.Call<okhttp3.ResponseBody>
    getDebugPprofMutex(String zapTraceSpan, Long debug, String seconds)
    Get the mutual exclusion (mutex) runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of lock contentions.
    retrofit2.Call<okhttp3.ResponseBody>
    getDebugPprofProfile(String zapTraceSpan, String seconds)
    Get the CPU runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of program counters on the executing stack.
    retrofit2.Call<okhttp3.ResponseBody>
    getDebugPprofThreadCreate(String zapTraceSpan, Long debug, String seconds)
    Get the threadcreate runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of stack traces that led to the creation of new OS threads.
    retrofit2.Call<okhttp3.ResponseBody>
    getDebugPprofTrace(String zapTraceSpan, String seconds)
    Get the runtime execution trace Trace execution events for the current program.

  • Method Details

    • getDebugPprofAllProfiles

      @GET("debug/pprof/all") retrofit2.Call<okhttp3.ResponseBody> getDebugPprofAllProfiles(@Header("Zap-Trace-Span") String zapTraceSpan, @Query("cpu") String cpu)
      Get all runtime profiles Get reports for the following [Go runtime profiles](https://pkg.go.dev/runtime/pprof): - **allocs**: All past memory allocations - **block**: Stack traces that led to blocking on synchronization primitives - **cpu**: (Optional) Program counters sampled from the executing stack. Include by passing the `cpu` query parameter with a [duration](https://docs.influxdata.com/influxdb/v2.1/reference/glossary/#duration) value. Equivalent to the report from [`GET /debug/pprof/profile?seconds=NUMBER_OF_SECONDS`](#operation/GetDebugPprofProfile). - **goroutine**: All current goroutines - **heap**: Memory allocations for live objects - **mutex**: Holders of contended mutexes - **threadcreate**: Stack traces that led to the creation of new OS threads
      Parameters:
      zapTraceSpan - OpenTracing span context (optional)
      cpu - Collects and returns CPU profiling data for the specified [duration](https://docs.influxdata.com/influxdb/v2.1/reference/glossary/#duration). (optional)
      Returns:
      Call<ResponseBody>

    • getDebugPprofAllocs

      @GET("debug/pprof/allocs") retrofit2.Call<okhttp3.ResponseBody> getDebugPprofAllocs(@Header("Zap-Trace-Span") String zapTraceSpan, @Query("debug") Long debug, @Query("seconds") String seconds)
      Get the memory allocations runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of all past memory allocations. **allocs** is the same as the **heap** profile, but changes the default [pprof](https://pkg.go.dev/runtime/pprof) display to __-alloc_space__, the total number of bytes allocated since the program began (including garbage-collected bytes).
      Parameters:
      zapTraceSpan - OpenTracing span context (optional)
      debug - - `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
      seconds - Number of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
      Returns:
      Call<ResponseBody>

    • getDebugPprofBlock

      @GET("debug/pprof/block") retrofit2.Call<okhttp3.ResponseBody> getDebugPprofBlock(@Header("Zap-Trace-Span") String zapTraceSpan, @Query("debug") Long debug, @Query("seconds") String seconds)
      Get the block runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of stack traces that led to blocking on synchronization primitives.
      Parameters:
      zapTraceSpan - OpenTracing span context (optional)
      debug - - `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
      seconds - Number of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
      Returns:
      Call<ResponseBody>

    • getDebugPprofCmdline

      @GET("debug/pprof/cmdline") retrofit2.Call<String> getDebugPprofCmdline(@Header("Zap-Trace-Span") String zapTraceSpan)
      Get the command line invocation Get the command line that invoked InfluxDB.
      Parameters:
      zapTraceSpan - OpenTracing span context (optional)
      Returns:
      Call<String>

    • getDebugPprofGoroutine

      @GET("debug/pprof/goroutine") retrofit2.Call<okhttp3.ResponseBody> getDebugPprofGoroutine(@Header("Zap-Trace-Span") String zapTraceSpan, @Query("debug") Long debug, @Query("seconds") String seconds)
      Get the goroutines runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of all current goroutines.
      Parameters:
      zapTraceSpan - OpenTracing span context (optional)
      debug - - `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
      seconds - Number of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
      Returns:
      Call<ResponseBody>

    • getDebugPprofHeap

      @GET("debug/pprof/heap") retrofit2.Call<okhttp3.ResponseBody> getDebugPprofHeap(@Header("Zap-Trace-Span") String zapTraceSpan, @Query("debug") Long debug, @Query("seconds") String seconds, @Query("gc") Long gc)
      Get the heap runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of memory allocations for live objects. To run **garbage collection** before sampling, pass the `gc` query parameter with a value of `1`.
      Parameters:
      zapTraceSpan - OpenTracing span context (optional)
      debug - - `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
      seconds - Number of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
      gc - - `0`: (Default) don't force garbage collection before sampling. - `1`: Force garbage collection before sampling. (optional)
      Returns:
      Call<ResponseBody>

    • getDebugPprofMutex

      @GET("debug/pprof/mutex") retrofit2.Call<okhttp3.ResponseBody> getDebugPprofMutex(@Header("Zap-Trace-Span") String zapTraceSpan, @Query("debug") Long debug, @Query("seconds") String seconds)
      Get the mutual exclusion (mutex) runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of lock contentions. The profile contains stack traces of holders of contended mutual exclusions (mutexes).
      Parameters:
      zapTraceSpan - OpenTracing span context (optional)
      debug - - `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
      seconds - Number of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
      Returns:
      Call<ResponseBody>

    • getDebugPprofProfile

      @GET("debug/pprof/profile") retrofit2.Call<okhttp3.ResponseBody> getDebugPprofProfile(@Header("Zap-Trace-Span") String zapTraceSpan, @Query("seconds") String seconds)
      Get the CPU runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of program counters on the executing stack.
      Parameters:
      zapTraceSpan - OpenTracing span context (optional)
      seconds - Number of seconds to collect profile data. Default is `30` seconds. (optional)
      Returns:
      Call<ResponseBody>

    • getDebugPprofThreadCreate

      @GET("debug/pprof/threadcreate") retrofit2.Call<okhttp3.ResponseBody> getDebugPprofThreadCreate(@Header("Zap-Trace-Span") String zapTraceSpan, @Query("debug") Long debug, @Query("seconds") String seconds)
      Get the threadcreate runtime profile Get a [Go runtime profile](https://pkg.go.dev/runtime/pprof) report of stack traces that led to the creation of new OS threads.
      Parameters:
      zapTraceSpan - OpenTracing span context (optional)
      debug - - `0`: (Default) Return the report as a gzip-compressed protocol buffer. - `1`: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging. `debug=1` is mutually exclusive with the `seconds` query parameter. (optional)
      seconds - Number of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. (optional)
      Returns:
      Call<ResponseBody>

    • getDebugPprofTrace

      @GET("debug/pprof/trace") retrofit2.Call<okhttp3.ResponseBody> getDebugPprofTrace(@Header("Zap-Trace-Span") String zapTraceSpan, @Query("seconds") String seconds)
      Get the runtime execution trace Trace execution events for the current program.
      Parameters:
      zapTraceSpan - OpenTracing span context (optional)
      seconds - Number of seconds to collect profile data. (optional)
      Returns:
      Call<ResponseBody>