cargo-samply 0.2.0

A cargo subcommand to automate the process of running samply for project binaries
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

# Cargo Samply

[![Continuous integration](https://github.com/PhilippPolterauer/cargo-samply/actions/workflows/ci.yml/badge.svg)](https://github.com/PhilippPolterauer/cargo-samply/actions/workflows/ci.yml)

a simple integration binary that automates the process of running `cargo build` with a certain profile and `samply` afterwards.
It installs [samply](https://github.com/mstange/samply) if it is not available using `cargo install`.

## Installation

for now you can install it from crates.io or directly from github.com

```bash
# crates.io
cargo install cargo-samply
# or from git
cargo install --git https://github.com/PhilippPolterauer/cargo-samply.git
```

## Useage

```console
$ cargo samply --help
A cargo subcommand to automate the process of running samply for project binaries

Usage: cargo-samply [OPTIONS] [TRAILING_ARGUMENTS]...

Arguments:
  [TRAILING_ARGUMENTS]...  Trailing arguments passed to the binary being profiled

Options:
  -p, --profile <PROFILE>    Build with the specified profile [default: samply]
  -b, --bin <BIN>            Binary to run
  -e, --example <EXAMPLE>    Example to run
  -f, --features <FEATURES>  Build features to enable
      --no-default-features  Disable default features
  -v, --verbose              Print extra output to help debug problems
  -h, --help                 Print help
  -V, --version              Print version

```

## Example Usage

The usage is quite simple

```console
$ cd tests
$ cargo new mybinary
     Created binary (application) `mybinary` package

```

when opening the server address (127.0.0.1:3001) the output should look like the following.
![Samply Web View](https://raw.githubusercontent.com/PhilippPolterauer/cargo-samply/main/doc/samply-web.png)

## Advanced Usecases with custom arguments

there is a test package at `test/testpackage/` which can be used for highlighting the following options.

`cargo-samply` respects the default-run argument:
<!-- 
```console
$ cargo samply
? 1
error: Failed to locate project

```

`cargo-samply` can be targeted at certain binaries e.g. `--example`

```console
$ cargo samply --example hello
? 1
error: Failed to locate project

```

or `--bin`

```console
$ cargo samply --bin another
? 1
error: Failed to locate project

```

additional arguments can be passed after `--`

```console
$ cargo samply --bin another -- 'new text'
? 1
error: Failed to locate project

``` -->