Installing Method R Workbench

Using Method R Workbench does not require you to install or change anything on your database server. Most people install Method R Workbench on a separate computer and then transport .trc files from the computer running Oracle to the computer running the Workbench application.

Occasionally, people will also install Workbench on the database server so that they can filter trace files before transporting them to another computer for analysis.

Prerequisites

  1. Method R Workbench runs on only the following platforms:
    • Microsoft Windows 7 or newer on x86_64
    • macOS 10.9 (Mavericks) or newer on x86_64 (Intel)
    • macOS 11 (Big Sur) or newer on ARM64 (Apple silicon)
    • Linux with glibc 2.15 or a compatible GNU C Library on x86_64
  2. Method R Workbench requires the following Java version:
    • Windows. Method R Workbench for Windows requires 64-bit Java SE 8 or newer (JRE or JDK).
    • macOS x86_64. Method R Workbench for macOS x86_64 requires Java SE 8 or newer (JRE or JDK).
    • macOS ARM64. Method R Workbench for macOS ARM64 requires JDK 17 or newer.
    • Linux. Method R Workbench for Linux requires 64-bit Java SE 8 or newer (JRE or JDK).

Upgrading

If you are upgrading an existing Method R Workbench installation, use the application’s Help › Check for Updates… feature.

However, if you are changing your architecture (for example, from an x86_64 macOS machine to a new ARM64 “Apple silicon” machine), then follow the Installing steps below.

Installing

  1. Download the Method R Workbench distribution file for your platform.
  2. Inflate the distribution file in a directory for which you have read+write permission:
    • Windows. Method R Workbench for Windows is distributed as a .zip file. To unzip the distribution file, just double-click it and move the resulting directory to Program Files (for example). Run the Workbench application by double-clicking the Workbench icon (mrworkbench.exe).
    • macOS. Method R Workbench for macOS is distributed as a .dmg file. To install it, open the DMG and drag the application icon to your Applications folder (for example). Then close and eject the DMG. Run the Workbench application by double-clicking the Workbench icon (Method R Workbench.app).
    • Linux. Method R Workbench for Linux is distributed as a .tar.gz file. To install it, use tar ‑xzf to inflate the distribution file into /opt/local (for example). Run the Workbench application by executing mrworkbench from a shell or a .desktop file.
  3. Obtain an activation key. Enter your activation key in the application’s Help › Activation Key dialog. If your key’s details display in the dialog, then you’re good to go.

Troubleshooting

If you have trouble opening Method R Workbench, you’ll find helpful debugging information in the log:

  • Windows. Look for mrworkbench_launcher.log in the top-level folder where mrworkbench.exe is. If you can’t get mrworkbench.exe to work, you can run bin\mrworkbench.cmd from the command line as a temporary workaround.
  • macOS. Look for $HOME/.method-r/mrworkbench_launcher.log. If it’s not there, look in /tmp. If you can’t get Method R Workbench.app to work, you can run bin/mrworkbench from the command line as a temporary workaround.
  • Linux. There is no Method R Workbench launcher for Linux. The log is written to stderr and stdout of your mrworkbench execution (the console by default).

If the log doesn’t help you cross the finish line on your own, then please open a support case. Bypassing the launcher is okay in a pinch, but being able to drag .trc files onto the application icon is an important workflow feature of the application, so we want to make sure it’s working for you.

Once the Workbench application opens, the application will log its execution progress to a separate log file that you can access by clicking Help › Diagnostics. If you ever open a support case with us about Workbench application behavior, please include this log file.

Controlling Your Java Version

In case you ever want to use a Java version other than the one that Method R Workbench finds automatically, we make it easy to do:

  • Windows. Workbench for Windows uses the WinRun4J configurable Java launcher. You can control WinRun4J by editing mrworkbench.ini.
  • macOS. Workbench for macOS uses a configurable Java launcher. You can control the launcher by editing the file called Info.plist. The launcher log (mrworkbench_launcher.log) shows you how.
  • Linux. Open a command shell, set your PATH so that java ‑version reports the Java version you want, and then run mrworkbench.

Uninstalling

To uninstall Method R Workbench:

  1. Delete the Method R Workbench application folder that you created when you inflated our distribution file.
  2. Delete the .method-r folder in your home directory.