The AppMap Client CLI provides utility commands for working with AppMaps.
The AppMap Client CLI is written in Node.JS, so you install and manage this CLI using
npm install -g @appland/cli
$ appmap-cli inspect --help appmap-cli inspect <code-object> Search AppMaps for references to a code object (package, function, class, query, route, etc) and print available event info. Positionals: code-object identifies the code-object to inspect [required] Options: --version Show version number [boolean] -v, --verbose Run with verbose logging [boolean] --help Show help [boolean] --appmap-dir directory to recursively inspect for AppMaps [default: "tmp/appmap"] -i, --interactive interact with the output via CLI [boolean]
You can use this command to search and display events and associated data from across all the AppMaps in a directory (recursively explored).
code-object argument is a required argument, composed of a type and identifier. The inspect command will find all events that match this code object across all the AppMaps. Whether an event matches the
code-object argument is defined as follows:
|code-object type||match criteria|
|function||The event is a call to the specified function|
|class||The event is a call to any function on the specified class|
|package||The event is a call to any function on any class in the specified package|
|database||The event is a SQL query|
|table||The event is a SQL query which includes the specified table|
|query||The event is a SQL query which, when normalized, matches the specified query|
|route||The event is an HTTP server request which matches the specified route method and normalized path.|
Examples of supported search syntax:
route:REQUEST_METHOD /route/:id(HTTP request method followed by normalized path)
query:SELECT * FROM tables WHERE some_column = ?(normalized SQL)
--interactive option, the results are presented in table form, and you can refine and drill into the data using the command line.
--interactive option, all matching results are printed as JSON. This mode is suitable for searching AppMaps and printing results that can be piped into other scripts (e.g. using jq) for further processing.
The home screen is displayed at the beginning of interactive mode. The
(h)ome command will generally return you to the home screen, when you are in other parts of the app.
The home screen presents the following data:
|Field index||Field name||Description|
|1||Events||A list of AppMaps and event indices that match the initial search term and filters.|
|2||Return values||Enumeration of all the different values returned by the matching object (most applicable when searching for a function).|
|3||HTTP server requests||Distinct routes in which the code object is found. Each listed result is a unique request method, normalized path, and status code.|
|4||SQL queries||Unique normalized SQL which is a descendant (or self) of the matching code object.|
|5||SQL tables||Unique tables which are found in the SQL queries, as defined in field 4.|
|6||Callers||Unique functions which are the parent of each matching code object.|
|7||Ancestors||Unique HTTP server requests and labeled functions which appear as an ancestor of a matching code object.|
|8||Descendants||Unique labeled functions which appear as a descendant of a matching code object.|
|9||Package trigrams||Unique combinations of caller → code-object → calee, converted to package names.|
|10||Class trigrams||Unique combinations of caller → code-object → calee, converted to class names.|
|11||Function trigrams||Unique combinations of caller → code-object → calee, as functions, SQL, or HTTP client requests.|
On the home screen, a field is displayed if there are only a small number of distinct values. Otherwise, the number of distinct values is shown, and you can use the
(p)rint command to see the full details.
Prints the full details of a numbered field. Unlike the
(h)ome view, which will summarize fields with many values, the
(p)rint command will always print out all the distinct values of a field (even if there are thousands of them…).
Applies a filter to the result set. You can use this command to reduce the number of search matches that are displayed, both on the
(h)ome screen and in the
When you choose the
(f)ilter command, you’re first prompted to select which field you want to choose the filter value from. For example, you may see a table that includes
(2) Return values (3) HTTP server requests (6) Callers. On choosing one of these fields, you are then prompted to select a value. The values will be the same as if you chose to
(p)rint the selected field. Each field value is numbered; enter the number of the field value to activate it as a filter.
The result set is then recomputed, matching only events that match BOTH the main code-object argument that you initially provided to the search command, AND the filter.
For example, if you searched for
table:users and then filtered by
request:GET /user 200, the search would match every query that accesses the users table within an HTTP
GET request to
/user that returns status code
If you apply another filter, then BOTH filter conditions must match each result.
Un-apply the most recently applied filter.
Remove all filters.
Quit the interactive program.