https://github.com/getappmap/appmap-cli
https://github.com/getappmap/appmap-cli
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/getappmap/appmap-cli
- Owner: getappmap
- Created: 2020-12-15T18:26:34.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-01-22T14:00:59.000Z (over 5 years ago)
- Last Synced: 2025-06-24T02:04:50.150Z (12 months ago)
- Language: JavaScript
- Size: 46.9 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Installation
Pre-built binaries are available [here](https://github.com/applandinc/appmap-cli/releases).
# Usage
```sh
$ appmap
Usage: appmap [options] [command]
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
prune [options] parse an appmap file from url
help [command] display help for command
```
## Pruning
`prune` will remove large event types to meet a maximum size requirement.
```sh
Usage: appmap prune [options]
prune an appmap file down to the given size (if applicable)
Options:
-o, --output-dir specify the output directory (default: ".")
-h, --help display help for command
```
Example:
```sh
$ appmap prune appland.results.json 2MB
```
### How it works
Pruning works by finding the most repetitive calls within a given "chunk" and
removing events associated with those calls. A chunk is defined as a group of
logic, consisting of one or more full call stacks. Boundaries of these chunks
are created around application entrypoints such as inbound HTTP request.
An example list of chunks is provided below:
```
HTTP request - GET /user
Background thread processing
HTTP request - PUT /user
Background thread processing
HTTP request - GET /
```
For each chunk, aggregate the total number of unique events. Starting from the
most repetitive event type, remove instances of that event until the size of the
chunk (in byte) is less than:
```
requested size / total event array size * starting chunk size
```
In essence, we're calculating a unique exclusion list for each chunk. This
prevents an excessively noisy or repetitive call stack in one area of execution
from affecting the results of unrelated areas of execution.
Non-application events such as HTTP requests and SQL queries will always be
retained. This means that the end result can never be smaller than the total
size of these events combined.