Skip to content

Developer⚓︎

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
Usage: spp-cli [OPTIONS] COMMAND [ARGS]...

Options:
  -v, --verbose            Enable verbose mode
  -p, --platform TEXT      Source++ platform host
  -c, --certificate PATH   Source++ platform certificate
  -k, --key PATH           Source++ platform key
  -a, --access-token TEXT  Developer access token
  -h, --help               Show this message and exit

Commands:
  add        Add live instruments/views
  get        Get live instruments/views
  remove     Remove live instruments/views
  subscribe  Subscribe to live instrument/view events
  version    Display version information
  whoami     Display current user information

add breakpoint⚓︎

Description⚓︎

Add live breakpoint to running application.

Synopsis⚓︎

1
add breakpoint [OPTIONS] <source> <line>

Arguments⚓︎

Argument Description
source Qualified class name (e.g. com.company.Webapp)
line Line number

Options⚓︎

Option Description
-condition, -c Condition required to trigger live breakpoint
-expiresAt, -e Maximum time-to-live (epoch timestamp [ms])
-hitLimit, -h Maximum amount of times to trigger live breakpoint

Examples⚓︎

Basic

Input:

1
add breakpoint com.company.Webapp 42

Output:

1
2
3
4
5
6
7
8
{
  "id" : "6803a185-d1e8-41dd-8b09-250bdb606e39",
  "location" : {
    "source" : "com.company.Webapp",
    "line" : 42
  },
  "hitLimit" : 1
}

Advanced

Input:

1
add breakpoint -c 1==1 -h 5 com.company.Webapp 42

Output:

1
2
3
4
5
6
7
8
9
{
  "id" : "6803a185-d1e8-41dd-8b09-250bdb606e39",
  "location" : {
    "source" : "com.company.Webapp",
    "line" : 42
  },
  "condition" : "1==1",
  "hitLimit" : 5
}


add log⚓︎

Description⚓︎

Add live log to running application.

Synopsis⚓︎

1
add log [OPTIONS] <source> <line> <logFormat>

Arguments⚓︎

Argument Description
source Qualified class name (e.g. com.company.Webapp)
line Line number
logFormat Format to log (e.g. Hello {})

Options⚓︎

Option Description
-logArguments, -l Argument(s) to add to log format
-condition, -c Condition required to trigger live log
-expiresAt, -e Maximum time-to-live (epoch timestamp [ms])
-hitLimit, -h Maximum amount of times to trigger live log

Examples⚓︎

Basic

Input:

1
add log com.company.Webapp 42 "Hello world"

Output:

1
2
3
4
5
6
7
8
9
{
  "id" : "fee41cab-628b-4253-9bbd-b09b536418af",
  "logFormat" : "Hello world",
  "location" : {
    "source" : "com.company.Webapp",
    "line" : 42
  },
  "hitLimit" : 1
}

Advanced

Input:

1
add log -l name1 -l name2 com.company.Webapp 42 "Hello {} and {}"

Output:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id" : "fee41cab-628b-4253-9bbd-b09b536418af",
  "logFormat" : "Hello {} and {}",
  "logArguments" : [ "name1", "name2" ],
  "location" : {
    "source" : "com.company.Webapp",
    "line" : 42
  },
  "hitLimit" : 1
}


get breakpoints⚓︎

Description⚓︎

Get list of live breakpoints.

Synopsis⚓︎

1
get breakpoints

Examples⚓︎

Basic

Input:

1
get breakpoints

Output:

1
2
3
4
5
6
7
8
9
[{
  "id" : "6803a185-d1e8-41dd-8b09-250bdb606e39",
  "location" : {
    "source" : "com.company.Webapp",
    "line" : 42
  },
  "condition" : "1==1",
  "hitLimit" : 5
}]


get-logs⚓︎

Description⚓︎

Get list of live logs.

Synopsis⚓︎

1
get logs

Examples⚓︎

Basic

Input:

1
get logs

Output:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
[{
  "id" : "fee41cab-628b-4253-9bbd-b09b536418af",
  "logFormat" : "Hello {} and {}",
  "logArguments" : [ "name1", "name2" ],
  "location" : {
    "source" : "com.company.Webapp",
    "line" : 42
  },
  "hitLimit" : 1
}]


get instruments⚓︎

Description⚓︎

Get list of live instruments.

Synopsis⚓︎

1
get instruments

Examples⚓︎

Basic

Input:

1
get instruments

Output:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
[{
  "id" : "6803a185-d1e8-41dd-8b09-250bdb606e39",
  "location" : {
    "source" : "com.company.Webapp",
    "line" : 42
  },
  "condition" : "1==1",
  "hitLimit" : 5,
  "type": "BREAKPOINT"
},
{
  "id" : "fee41cab-628b-4253-9bbd-b09b536418af",
  "logFormat" : "Hello {} and {}",
  "logArguments" : [ "name1", "name2" ],
  "location" : {
    "source" : "com.company.Webapp",
    "line" : 42
  },
  "hitLimit" : 1,
  "type": "LOG"
}]


remove instrument⚓︎

Description⚓︎

Remove an existing live instrument.

Synopsis⚓︎

1
remove instrument <id>

Arguments⚓︎

Argument Description
id Existing live instrument id

Examples⚓︎

Basic

Input:

1
remove instrument 6567ee97-ec61-4b23-80d7-cef8206b629e

Output:

1
2
3
4
5
6
7
8
{
  "id" : "6567ee97-ec61-4b23-80d7-cef8206b629e",
  "location" : {
    "source" : "com.company.Webapp",
    "line" : 42
  },
  "hitLimit" : 1
}


remove instruments⚓︎

Description⚓︎

Remove existing live instruments.

Synopsis⚓︎

1
remove instruments <source> <line>

Arguments⚓︎

Argument Description
source Qualified class name (e.g. com.company.Webapp)
line Line number

Examples⚓︎

Basic

Input:

1
remove instruments com.company.Webapp 42

Output:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
[{
  "id" : "6803a185-d1e8-41dd-8b09-250bdb606e39",
  "location" : {
    "source" : "com.company.Webapp",
    "line" : 42
  },
  "condition" : "1==1",
  "hitLimit" : 5,
  "type": "BREAKPOINT"
},
{
  "id" : "fee41cab-628b-4253-9bbd-b09b536418af",
  "logFormat" : "Hello {} and {}",
  "logArguments" : [ "name1", "name2" ],
  "location" : {
    "source" : "com.company.Webapp",
    "line" : 42
  },
  "hitLimit" : 1,
  "type": "LOG"
}]



Last update: August 14, 2022