Lightrun CLI Commands¶

$ java -jar lightrunc.jar help
Usage: LightrunC [OPTIONS]
Command line interface to Lightrun
     list-agents                 List the agents
     list-tags                   List the tags
     list-agents-by-tag <Tag>    List the agents by given tag
     list-actions <AgentId>      List the actions for the given agent id
     log <AgentId> <Filename>:<LineNumber> <Format> [-ignoreQuota] [-pipe 
     enable/disable/client]
                              Insert a log to the given agent at the given
                                   file/line with the format (text of the log)
     clog <AgentId> <Filename>:<LineNumber> <Format> [-condition <Condition>] 
     [-expireSec <ExpireSec>] [-ignoreQuota] [-pipe enable/disable/client]
                              Insert a conditional log to the given agent
                                   at the given file/line with the format
                                   (text of the log)
     snapshot <AgentId> <Filename>:<LineNumber> [-condition <Condition>] 
     [-watch <Expression>] [-expireSec <ExpireSec>] [-maxHitCount 
     <MaxHitCount>] [-ignoreQuota] [-pipe enable/disable/client]
                              Insert a snapshot to the given agent at the
                                   given file/line
     counter <AgentId> <FileName>:<LineNumber> <CounterName> [-condition 
     <Condition>] [-expireSec <ExpireSec>] [-aggregateBy <Aggregate By 
     Prefix>] [ignoreQuota] [-pipe enable/disable/client]
                              Count the number of times each thread hits
                                   the requested line.
                              This option is currently supported only for
                                   Java agents.
     customMetric <AgentId> <FileName>:<LineNumber> <MetricName> 
     <MetricExpression> [-condition <Condition>] [-expireSec <ExpireSec>] 
     [-ignoreQuota] [-pipe enable/disable/client]
                              Get metrics for the value given by the
                                   expression.
                              This option is currently supported only for
                                   Java agents.
     snapshot-data <AgentId> <SnapshotId> [<output-file>]
                              Prints the accumulated data for a snapshot or
                                   saves it to <output-file>
     rm <AgentId> <ActionId>     Removes an action from the given agent
     rm-tag <tagName>            Removes a tag from the server
     status                      Prints the current status of the backend
     detach <on|off>             Disconnects all agents and disables lightrun
                                   instantly (when on) until it's turned off
                                   again
     print-logs <AgentId> [<ActionId>] [-range <StartTimestamp-EndTimestamp 
     (milliseconds)>]
                              Print all logs for the given agent. Limited
                                   to 1000 most recent results. Optionally,
                                   you can specify the range via the 'range'
                                   argument
     print-all-logs              Print all logs for all agents. Limited to
                                   1000 most recent results. Optionally, you
                                   can specify the range via the 'range'
                                   argument
     enable-piping <AgentId>     Logs/Counters/TicTocs for this agent id will
                                   be piped to Lightrun's backend and printed
                                   on the server! Logs are available with the
                                   print-logs command.
     client-piping <AgentId>     Logs/Counters/TicTocs for this agent id will
                                   be piped to Lightrun's backend and hidden
                                   in the server! Logs are available with the
                                   print-logs command
     disable-piping <AgentId>    Logs/Counters/TicTocs for this agent id will
                                   only be printed on the server! (this
                                   doesn't stop the action)
     server-url <ServerURL>      Sets the server URL for the command line
     login                       Log in the server. The login will supply a
                                   URL for further authentication. Optionally,
                                   you can specify the user name and password
                                   via the 'email' and 'password' arguments.
     logout                      Logs out the currently logged in user on this
                                   machine
     version                     Prints the version of Lightrun CLI and the
                                   backend server
     listen                      Listens to agent/log registration events and
                                   prints them out
     -v, verbose                 Verbose mode
     user                        Prints the details on the server for the
                                   currently logged in user
     help                        Print help details
     toggle-action [AgentId] <ActionId>
                              Enable/Disable an action
     add-certificate <Certificate>
                              Add a server certificate
     show-certificates           Show all the server certificates
     rm-certificate <Certificate>
                              Remove a server certificate
     enable-pinning-status       Enable certificate pinning
     disable-pinning-status      Disable certificate pinning
     get-pinning-status          Get certificate pinning
     clear-exceptions            Clear all exceptions from history by Admin /
                                   Manager
     ignoreQuota, -ignoreQuota   Add this argument when submitting a new
                                   action in order to disable the quota limits
                                   on that action. This operation can
                                   seriously impact your performance and is
                                   only available for users with the ignore
                                   quota permission
     -pipe enable/disable/client Set Piping for action.
                              enable - enables piping in the backend.
                              disable - Stops tracking action in the
                                   backend/client
                              client - Action will be piped to the backend
                                   and hidden in the server

$ java -jar lightrunc.jar listen
Connecting to server
Listening for events
{"eventType":"CONNECTED","status":{"status":"OK","statusCode":"STATUS_OK"}}
{"eventType":"SESSION_DETAILS","metadata":{"sessionId":"ecf32a4b-43da-ea93-bce0-18ef235e962a"},"status":{"status":"OK","statusCode":"STATUS_OK"}}
{"agentDisplayName":"","eventType":"AUTHENTICATED","status":{"status":"OK","statusCode":"STATUS_OK"}}
{"actionType":"LOG","agentDisplayName":"erezk-Latitude-7400 (pid 30554)","agentId":"f4b0d260-ec00-4459-a9ed-b8ef7d4ffcf7","eventType":"LOG_DATA_ADDED","status":{"status":"OK","statusCode":"STATUS_OK"}}
{"actionType":"LOG","agentDisplayName":"erezk-Latitude-7400 (pid 30554)","agentId":"f4b0d260-ec00-4459-a9ed-b8ef7d4ffcf7","eventType":"LOG_DATA_ADDED","status":{"status":"OK","statusCode":"STATUS_OK"}}
{"actionType":"LOG","agentDisplayName":"erezk-Latitude-7400 (pid 30554)","agentId":"f4b0d260-ec00-4459-a9ed-b8ef7d4ffcf7","eventType":"LOG_DATA_ADDED","status":{"status":"OK","statusCode":"STATUS_OK"}}
{"actionType":"LOG","agentDisplayName":"erezk-Latitude-7400 (pid 30554)","agentId":"f4b0d260-ec00-4459-a9ed-b8ef7d4ffcf7","eventType":"LOG_DATA_ADDED","status":{"status":"OK","statusCode":"STATUS_OK"}}
{"actionType":"LOG","agentDisplayName":"erezk-Latitude-7400 (pid 30554)","agentId":"f4b0d260-ec00-4459-a9ed-b8ef7d4ffcf7","eventType":"LOG_DATA_ADDED","status":{"status":"OK","statusCode":"STATUS_OK"}}

$ java -jar lightrunc.jar version
CLI Client Version: 1.4
Server Version: 1.6

$ java -jar lightrunc.jar user
class UserDTO {
    activated: true
    authorities: <permissions>
    company: class CompanyDTO {
        agentAPIKey: <agent-api-key>
        agentsEnabled: true
        certificatePinningEnabled: false
        displayName: null
        dontStorePluginToken: false
        id: <id>
        inviteKey: <invite-key>
        licenseExpiry: <liscense-expiry>
        licensedAgents: 1000
        licensedUsers: 1000
        managerId: null
        managerLogin: null
        name: <name>
        subscriptionStatus: STANDARD
        uniquifier: <uniquifier>
        users: []
    }
    companyName: <company-name>
    createdBy: <accout-created-by>
    createdDate: <created-date>
    email: <email>
    firstName: <first-name>
    id: <id>
    imageUrl: null
    langKey: en
    lastModifiedBy: <account-last-modified-by>
    lastModifiedDate: <last-modified-date>
    lastName: <last-name>
    password: null
    passwordHash: null
    passwordSet: false
    registerMethod: <register-method>
    subscriptionStatus: <subscription-status>
}

$ java -jar lightrunc.jar status
Lightrun CLI Client
----------
Server URL: https://app.lightrun.com
Company Name: <company-name
Version: 1.4
Backend Version: 1.6
User: <user-email>
Licenced Agents: 1000
Licence Expiry: <liscence-expiry>
Exception Daily Limit: Not Reached

$ java -jar lightrunc.jar detach on
Agents are now detached

$ java -jar lightrunc.jar detach off
Agents are now re-enabled

Logged out successfully!

$ java -jar lightrunc.jar list-agents
0 : ID e93fccd1-9f76-46ae-b703-056e25b8092e HOST ip-172-31-50-47 PID 14507 UPDATE 1/21/21, 9:16 AM
   ACTION 4261257f-fbc0-4fc5-8fe7-e8dbf3944eb7 FILE PrimeMainMR.java LINE 10 TYPE TICTOC
   ACTION 99e8e7b0-9248-4d89-8f6f-2d3c5fa9aebc FILE PrimeMainMR.java LINE 15 TYPE LOG Hello world {java expression}gg
   ACTION b383e31b-8749-419f-a492-85a919cc0da8 FILE PrimeMainMR.java LINE 22 TYPE TICTOC
   ACTION c3f863e6-ba7d-4480-83c0-ef4a278ecddb FILE PrimeMainMR.java LINE 15 TYPE COUNTER
   ACTION e5790c99-f763-4d26-8d3f-2714c89c0fad FILE PrimeMainMR.java LINE 10 TYPE BREAKPOINT
1 : ID f93fccd1-9f75-46ae-b703-456e25b8092e HOST ip-172-31-50-47 PID 14508 UPDATE 1/21/21, 9:16 AM
   ACTION 5261257f-fbc0-4fc5-8fe7-e8dbf3944eb7 FILE PrimeMainMR.java LINE 10 TYPE TICTOC
   ACTION 49e8e7b0-9248-4d89-8f6f-2d3c5fa9aebc FILE PrimeMainMR.java LINE 15 TYPE LOG Hello world {java expression}gg
   ACTION g383e31b-8749-419f-a492-85a919cc0da8 FILE PrimeMainMR.java LINE 22 TYPE TICTOC
   ACTION a3f863e6-ba7d-4480-83c0-ef4a278ecddb FILE PrimeMainMR.java LINE 15 TYPE BREAKPOINT
   ACTION l5790c99-f763-4d26-8d3f-2714c89c0fad FILE PrimeMainMR.java LINE 10 TYPE BREAKPOINT

$ java -jar lightrunc.jar list-agents-by-tag Production
0 : ID <user-id> HOST <host> PID 10 UPDATE 7/26/22, 8:08 PM TAGS [Production]
 downloads % java -jar lightrunc.jar list-agents-by-tag Production
0 : ID <user-id> HOST <host> PID 10 UPDATE 7/26/22, 8:13 PM TAGS [Production]
 ACTION 1ecff847-db90-46f8-9493-bdac3518809b FILE PrimeMainMR.java LINE 30 TYPE LOG Hello world {expression}
 ACTION 275cae4c-ece9-4f6c-8950-594cd3ccc7fd FILE PrimeMainMR.java LINE 59 TYPE COUNTER 
 ACTION 5eaeeca1-4861-473b-8d55-b39b29af26ad FILE PrimeMainMR.java LINE 20 TYPE TICTOC ERROR Collision in breakpoint location on the same tree
 ACTION 758a36b8-50be-472c-8a6e-891eb3d31747 FILE PrimeMainMR.java LINE 78 TYPE BREAKPOINT 
 ACTION a214a929-6bc8-44ff-92f1-5c0140084038 FILE PrimeMainMR.java LINE 33 TYPE LOG Hello world {expression}

$ java -jar lightrunc.jar list-tags
Tag: Production
   ACTION 4f6f8e67-2252-4093-bcf2-9a5254f074ef FILE PrimeMainMR.java LINE 50 TYPE LOG Hello world {java expression}
   ACTION 99e8e7b0-9248-4d89-8f6f-2d3c5fa9aebc FILE PrimeMainMR.java LINE 15 TYPE LOG Hello world {java expression}gg
   ACTION e5790c99-f763-4d26-8d3f-2714c89c0fad FILE PrimeMainMR.java LINE 10 TYPE BREAKPOINT
Tag: Staging
   ACTION b383e31b-8749-419f-a492-85a919cc0da8 FILE PrimeMainMR.java LINE 22 TYPE TICTOC
   ACTION c3f863e6-ba7d-4480-83c0-ef4a278ecddb FILE PrimeMainMR.java LINE 15 TYPE COUNTER

$ java -jar lightrunc.jar list-custom-sources
Custom Source: Production (86ba64eb-89a7-445d-a3f3-e273645594b6)

$ java -jar lightrunc.jar list-agents-by-custom-source-name Staging   
0 : ID a7324611-3ab0-4ea1-8cad-bbc9fcfe3e4a HOST 6f4d43f85e53 PID 14 UPDATE 2/1/23, 7:37 AM TAGS [Production]

$ java -jar lightrunc.jar list-actions 7b5a1f54216b  
There are no actions to agent 7b5a1f54216b

$  java -jar lightrunc.jar list-actions tag:Production
There are no actions to agent tag:Production

$ java -jar lightrunc.jar client-piping da0c440b-ae8e-4011-9f61-93a07405baa2
Log tracking in progress, use print-logs to view the output

$ java -jar lightrunc.jar enable-piping da0c440b-ae8e-4011-9f61-93a07405baa2
Log tracking in progress, use print-logs to view the output

$ java -jar lightrunc.jar disable-piping da0c440b-ae8e-4011-9f61-93a07405baa2 
Log tracking is disabled

$ java -jar lightrunc.jar toggle-action da0c440b-ae8e-4011-9f61-93a07405baa2  b5f20e04-5ab1-4c14-887b-1386ee96ce1b
Action b5f20e04-5ab1-4c14-887b-1386ee96ce1b was successfully disabled

$ java -jar lightrunc.jar toggle-action da0c440b-ae8e-4011-9f61-93a07405baa2  b5f20e04-5ab1-4c14-887b-1386ee96ce1b
Action b5f20e04-5ab1-4c14-887b-1386ee96ce1b was successfully enabled

$ java -jar lightrunc.jar print-logs 0 0 -range 1615391135824-1615391135924
INFO: LOGPOINT: 197581639 is a prime number
INFO: LOGPOINT: 197581649 is a prime number
INFO: LOGPOINT: 197581651 is a prime number
INFO: LOGPOINT: 197581673 is a prime number
INFO: LOGPOINT: 197581687 is a prime number
INFO: LOGPOINT: 197581697 is a prime number
INFO: LOGPOINT: 197581717 is a prime number
INFO: LOGPOINT: breakpointId: [f188655e-7dab-42a1-acad-ce53a16a85dc]: Logpoint is paused due to high call rate until log quota is restored

$ java -jar lightrunc.jar print-all-logs
INFO: LOGPOINT: breakpointId: [786e3a7e-a60b-4e48-884e-2c126c4da8e3]: Logpoint is paused due to high call rate until log quota is restored
INFO: LOGPOINT: Hello world 24373299
INFO: LOGPOINT: Hello world 24373300
INFO: LOGPOINT: Hello world 24373301
INFO: LOGPOINT: Hello world 24373298
INFO: LOGPOINT: Hello world 24373307
INFO: LOGPOINT: Hello world 24373308
INFO: LOGPOINT: Hello world 24373309
INFO: LOGPOINT: Hello world 24373310
INFO: LOGPOINT: Hello world 24373312

$ java -jar lightrunc snapshot-data e178578f-14da-476f-a084-bc460d6ec2b0 eb5abb0a-4677-4bed-9999-ea0b76c4efd2

[class BreakpointDataDTO {
 actionId: eb5abb0a-4677-4bed-9999-ea0b76c4efd2
 agentId: e178578f-14da-476f-a084-bc460d6ec2b0
 createTime: class TimeDTO {
     nanos: 696685698
     seconds: 1611590801
 }
 dataId: 72f81a80-c415-4f00-a43d-83523a735230
 evaluatedExpressions: null
 stackFrames: [class AgentStackFrameDTO {
     arguments: [class WatchEntryDTO {
         members: null
         name: args
         status: null
         type: null
         value: null
         varTableIndex: 1
     }]
     function: PrimeMain.main
     locals: [class WatchEntryDTO {
         members: null
         name: i
         status: null
         type: int
         value: 30514481
         varTableIndex: null
     }]
     location: class LocationDTO {
         column: 0
         endOfLine: false
         line: 20
         path: PrimeMain.java
     }
 }]
 variableTable: [class WatchEntryDTO {
     members: null
     name: null
     status: class BreakpointStatusDTO {
         description: class BreakpointStatusDescriptionDTO {
             format: Buffer full. Use an expression to see more data
             parameters: null
         }
         isAccepted: false
         isError: true
         refersTo: VARIABLE_VALUE
     }
     type: null
     value: null
     varTableIndex: null
 }, class WatchEntryDTO {
     members: [class WatchEntryDTO {
         members: null
         name: length
         status: null
         type: int
         value: 0
         varTableIndex: null
     }]
     name: null
     status: null
     type: java.lang.String[]
     value: null
     varTableIndex: null
     }]
}]

$java java -jar lightrunc.jar add-pii-redaction-pattern demo Tickets com.sales.tickets BY_VALUE
Successfully added pattern to template 'demo'

java -jar lightrunc.jar list-pii-redaction-patterns demo
NAME: Tickets TYPE: BY_VALUE PATTERN: com.sales.tickets CASE-INSENSITIVE: false

$ java -jar lightrunc.jar delete-pii-redaction-pattern demo Tickets
PII redaction pattern 'Tickets' successfully deleted

$ java -jar lightrunc.jar show-certificates
ee80811b38e7e6c2dc4cc372cbea86bd86b446b012e427f2e19bf094afba5d12 (PRECONFIGURED)

$ java -jar lightrunc.jar add-certificate <certificate-sha256-public-key>
Successfully added certificate.

$ lightrunc.jar rm-certificate <certificate-sha256-public-key>
Successfully removed certificate <certificate-sha256-public-key>

$ java -jar lightrunc.jar get-pinning-status
Pinning status is disabled

$ java -jar lightrunc.jar enable-pinning-status
Certificate pinning is now enabled

$ java -jar lightrunc.jar disable-pinning-status
Certificate pinning is now disabled