bm admin scanner trace
Description
The bm admin scanner trace command displays scanner-specific API operations occurring on the target Buckit deployment.
Use bm admin on Buckit Deployments Only
Buckit does not support using bm admin commands with other
S3-compatible services, regardless of their claimed compatibility with Buckit
deployments.
The following example returns a list of API operations related to the scanner on the mybuckit deployment.
bm admin scanner trace mybuckit
The command has the following syntax:
bm admin scanner trace ALIAS
[--filter-request] \
[--filter-response] \
[--filter-size <value>] \
[--funcname <value>] \
[--node <value>] \
[--path <value>] \
[--response-duration <value>] \
[--verbose, -v]
Brackets
[]indicate optional parameters.Parameters sharing a line are mutually dependent.
Parameters separated using the pipe
|operator are mutually exclusive.
Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.
Parameters
- --filter-request
- Optional
Trace scanner operations or calls with request size greater than the specified
--filter-sizevalue.Must be used with
--filter-sizeflag.
- --filter-response
- Optional
Trace scanner operations or calls with response size greater than the specified
--filter-sizevalue.Must be used with
--filter-sizeflag.
- --filter-size
- Optional
Filter output to request sizes or response sizes greater than the specified size.
Must be used with either
--filter-requestor--filter-responseflag.Valid units include:
Suffix
Unit Size
kKB (Kilobyte, 1000 Bytes)
mMB (Megabyte, 1000 Kilobytes)
gGB (Gigabyte, 1000 Megabytes)
tTB (Terrabyte, 1000 Gigabytes)
kiKiB (Kibibyte, 1024 Bites)
miMiB (Mebibyte, 1024 Kibibytes)
giGiB (Gibibyte, 1024 Mebibytes)
tiTiB (Tebibyte, 1024 Gibibytes)
Global Flags
This command supports any of the global flags.
Examples
Monitor all scanner API operations
Use bm admin scanner trace to monitor scanner API operations on the Buckit deployment at the alias mybuckit:
bm admin scanner trace mybuckit
Show scanner trace for a specific path
Use bm admin scanner trace to monitor API operations for a the path my-bucket/my-prefix/* on the deployment at the mybuckit alias:
bm admin scanner trace --path my-bucket/my-prefix/* mybuckit
Show scanner API operations for the scanObject function
Monitor scanner activity for the scanObject function on the mybuckit deployment:
bm admin scanner trace --funcname=scanner.ScanObject mybuckit
Show scanner operation requests greater than 1MB in size
Use bm admin scanner trace to monitor requests larger than a 1MB on the mybuckit deployment:
bm admin scanner trace --filter-request --filter-size 1MB mybuckit
Show scanner operation responses greater than 1MB in size
Use bm admin scanner trace to monitor large response sizes:
bm admin scanner trace --filter-response --filter-size 1MB mybuckit
Show scanner operations that last longer than five milliseconds
Use bm admin scanner trace to monitor long operations:
bm admin scanner trace --response-duration 5ms mybuckit
