drpcli debug¶
drpcli debug¶
Gather [type] of debug information and save it to [target]
Synopsis¶
This command gathers various different types of runtime profile data from a running dr-provision server, provided it has the /api/v3/debug or /api/v3/drp_debug. The types of data that can be gathered are:
profile: CPU utilization profile information. Tracks how much CPU time is being used in which
functions, based on sampling which functions are running every 10 ms. If the
--seconds flag is unspecified, profile will gather 30 seconds worth of data.
trace: Execution trace information, including information on where execution is blocked on
various types of IO and synchronization primitives. If the --seconds flag is unspecified,
trace will gather 1 second of data.
heap: Memory tracing information for all live data in memory. heap is always point-in-time data.
heapdump: All live objects in the system. Use only as directed by support.
allocs: Memory tracing of all memory that has been allocated since the start of the program
This includes memory that has been garbage-collected. alloc is always point-in-time data.
block: Stack traces of all goroutines that have blocked on synchronization primitives.
block is always point-in-time data.
mutex: Stack traces of all holders of contended mutexes. mutex is always point-in-time data.
threadcreate: Stack traces of all goroutines that led to the creation of a new OS thread.
threadcreate is always point-in-time data.
goroutine: Stack traces of all current goroutines. goroutine is always point-in-time data.
index: Returns the indexes of the stacks with the flags of the object.
Options¶
-h, --help help for debug
--prefix string Limits the index call to just this prefix type.
--seconds int How much debug data to gather, for types that gather data over time.
Options inherited from parent commands¶
--ca-cert string CA certificate used to verify the server certs (with the system set)
-c, --catalog string The catalog file to use to get product information (default "https://repo.rackn.io")
--catalog-path string The path to where the catalog file exists on the drp server. By default and historically this has been /files/rebar-catalog. For example, if no catalog urls are provided, the complete path will be https://drp-ip:8090/files/rebar-catalog (default "/files/rebar-catalog")
-S, --catalog-source string A location from which catalog items can be downloaded. For example, in airgapped mode it would be the local catalog
--client-cert string Client certificate to use for communicating to the server - replaces RS_KEY, RS_TOKEN, RS_USERNAME, RS_PASSWORD
--client-key string Client key to use for communicating to the server - replaces RS_KEY, RS_TOKEN, RS_USERNAME, RS_PASSWORD
-C, --colors string The colors for JSON and Table/Text colorization. 8 values in the for 0=val,val;1=val,val2... (default "0=32;1=33;2=36;3=90;4=34,1;5=35;6=95;7=32;8=92")
-d, --debug Whether the CLI should run in debug mode
-D, --download-proxy string HTTP Proxy to use for downloading catalog and content
-E, --endpoint string The Digital Rebar Provision API endpoint to talk to (default "https://127.0.0.1:8092")
-X, --exit-early Cause drpcli to exit if a command results in an object that has errors
--fetch-catalogs all Determines which catalog urls to use to fetch the catalog. If set to all, all the catalog urls defined with catalog_url and catalog_urls as well as the default catalog will be used. If set to server, only the catalog urls defined on the server will be used. If set to cli, then the specific url specified with the -c flag will be used. It defaults to `all`. Allowed values `all, `server`, `cli`. (default "all")
-f, --force When needed, attempt to force the operation - used on some update/patch calls
--force-new-session Should the client always create a new session
-F, --format string The serialization we expect for output. Can be "json" or "yaml" or "text" or "table" (default "json")
--http-request-retry-count int Specifies the number of retries for downloads in case of failure
--http-request-retry-delay-max int Specifies the maximum delay (in seconds) between HTTP/HTTPS retry attempts (default 60)
--ignore-unix-proxy Should the client ignore unix proxies
-N, --no-color Whether the CLI should output colorized strings
-H, --no-header Should header be shown in "text" or "table" mode
-x, --no-token Do not use token auth or token cache
-P, --password string password of the Digital Rebar Provision user (default "r0cketsk8ts")
-p, --platform string Platform to filter details by. Defaults to current system. Format: arch/os
-J, --print-fields string The fields of the object to display in "text" or "table" mode. Comma separated
-r, --ref string A reference object for update commands that can be a file name, yaml, or json blob
--server-verify Should the client verify the server cert
-T, --token string token of the Digital Rebar Provision access
-t, --trace string The log level API requests should be logged at on the server side
-Z, --trace-token string A token that individual traced requests should report in the server logs
-j, --truncate-length int Truncate columns at this length (default 40)
-u, --url-proxy string URL Proxy for passing actions through another DRP
-U, --username string Name of the Digital Rebar Provision user to talk to (default "rocketskates")
SEE ALSO¶
- drpcli - A CLI application for interacting with the DigitalRebar Provision API