Opsian Installation Instructions

Prerequisites

See our Frequently Asked Questions page for details on what platforms we support.

Minimal Setup

Our JVMTI Agent has to be added to the command that executes your Java application. You also need to tell our agent what your API KEY is. For example if your API key is in an environment variable called OPSIAN_KEY and the main method of your application is called YourApplication then you would run Opsian with the following command:


java -agentpath:/path/to/libopsian.so=apiKey=$OPSIAN_KEY YourApplication
		

Further options can be added as a comma separated list, so for example to set the version of your application to 1 you would use the following:


java -agentpath:/path/to/libopsian.so=apiKey=$OPSIAN_KEY,applicationVersion=1 YourApplication
		

Options

  • apiKey - An identifier for your application that you've registered with Opsian.
  • agentId - A human readable identifier for the process in question. If not specified this defaults to the hostname of the machine.
  • applicationVersion - Freeform String. The deployed version of your software, this can be used as a query parameter in the Opsian UI.
  • errorLogPath - Filesystem Path. A log file where any errors will be reported to. Defaults to the standard error stream of your process.

Firewalls and Servers

Depending upon your system configuration you may need to add firewall rules in order for the agent to report back to our hosted collector. This will make an outbound connection to collector.opsian.com on port 50051.