Install Guide

Documentation / Standard Edition / Install Guide

Table of Contents

Introduction

This document describes the installation of MyARM. First the requirements and environment needed to deploy MyARM version 1.4 for C/C++, Java, C# and Python are described. Followed by a detailed description how to install MyARM on your system and finally setting up the required license key.

Requirements

The following conditions must be fulfilled to deploy the MyARM agent and you need at least 160 MB (enterprise edition) of free disk space. Currently MyARM supports mainly 32-bit environments. Currently only on Linux 64-bit is supported. Any other operating system or 64-bit support upon request. If you need support for any other platform, database or compiler feel free to contact us.

Platforms

  1. AIX:
    • Power3 or higher.
    • AIX 5.3 TL 10, AIX 6.1
  2. Linux:
    • Intel i586 or higher CPU (Pentium, AMD), PowerPC G3/G4 or higher.
    • Linux kernel 2.4.x or 2.6.x
    • glibc 2.3.6 or higher.
  3. Solaris:
    • UltraSparc CPU or Intel i586 or higher CPU (Pentium, AMD).
    • Solaris 2.10 or higher.
  4. Windows:
    • Intel i586 or higher CPU (Pentium, AMD).
    • Windows XP, Windows 2000.

Databases

  1. MySQL 5.0-5.5
  2. MariaDB 5.5
  3. Oracle 10g
  4. SQLite3 (file based)

Compiler

  1. Any ANSI-C/C++ compliant C/C++ Compiler.
  2. Java 1.4 RTE or higher
  3. C# Visual Studio 9 or higher and .NET 3.5 for C# or higher on Windows and Mono 2.01 for Linux/Solaris.

Naming of MyARM archives

MyARM is only distributed over the net by downloading the appropriate distribution from the MyARM download page: http://myarm.com/support.html#support-dl.

The following naming scheme applies to all MyARM distribution archive files under UNIX.

myarm-version-edition-os-arch-type.extension

where the parts set in italic are:

version
the version of the MyARM distribution. The MyARM version is build with the following pattern: "<major>.<minor>.<buildid>.<revision>".
edition
the edition of MyARM. Either community for the community edition, professional for the professional edition, enterprise for the enterprise edition or client for the client edition.
os
the operating system the distribution was build for. Currently aix, linux, solaris or windows are supported.
arch
the architecture (CPU) the distribution was build for. Currently
  • x86 for Intel/AMD 32bit CPU based systems
  • amd64 for Intel/AMD 64bit CPU based systems
  • ppc for PowerPC 32bit CPU based systems
  • sparc for Sparc 32bit CPU based systems.
type
the distribution type. Either agent containing a libraries and programs needed to deploy instrumented applications, tools containing libraries and programs to analyse measured data, docs containing the documentation and manual pages of MyARM programs or sdk containing header files and examples how to use MyARM or to instrument applications with ARM. A type of bin is an archive containing the all above described archives for easy downloading.
extension
For unix systems this is a simple tar.gz file. Under windows the msi package is used.

Installing the MyARM distribution on a workstation under UNIX

Install directory

MyARM was build using the /opt/myarm directory and if used shared libraries are found automatically. We recommend to install the MyARM distribution under the directory /opt as this is the standard for programs from third-party vendors. The install procedure installs MyARM into a parent directory called myarm-1.4.2584.0. All you have to do after an installation is to create a symbolic link from /opt/myarm to the current version of MyARM you want to use:

# cd /opt
# ln -s myarm-1.4.2584.0 myarm

Therefore its easy to change to a new version of MyARM.

Archive extraction

All files and directories belonging to the MyARM distribution reside under a common parent directory named myarm-1.4.2584.0. The MyARM distribution is divided into several parts. Therefore a two step extraction exists:

  1. extract the MyARM distribution archive into a tempory directory mostly in your home directory.
  2. install the appropriate MyARM parts onto your system using either the provided installation script or manually.

If you have downloaded a MyARM professional edition for linux for Intel 32-bit you have an archive named:

myarm-1.4.2584.0-professional-linux-x86-bin.tar.gz

The following command sequence will extract the archive in a new directory named myarm-1.4.2584.0 and starts the installation process with the provided installation script:

# tar xvzf myarm-1.4.2584.0-professional-linux-x86-bin.tar.gz
# cd myarm-1.4.2584.0
# ./install.sh

Next section will guide you through the installation script. If you want to extract and install MyARM manually skip it.

Installing using provided installation script

Executing the provided install script will present you the greeting page shown in Figure "Install greeting page". It asks if you want to proceed with the installation. Enter Y and you will be prompted to anwser few questions about which parts of MyARM you want to install.


Figure: Install greeting page

You will be asked to install:

  1. the agent part; needed to deploy instrumented applications.
  2. the tools part; needed to analyse the measured data.
  3. the documentation part.
  4. the SDK part (needed to instrument own applications).
  5. the license key you received via email.
  6. and the directory where to install MyARM to.

Figure: Install questions

Figure "Install completed" shows a completed installation and you should execute the setup.sh script as recommended to setup the MyARM environment.


Figure: Install completed

Installing manually

MyARM provides an installation script for easy installation. So please use this script to install MyARM on your system. However, in some cases it might be necessary to install it manually. For this purpose MyARM is divided into the following parts:

MyARM agent
contains all necessary files to deploy an ARM instrumented application with the MyARM agent.
MyARM tools
contains all necessary files to analyse recorded ARM data.
MyARM documentation
contains all documentation of MyARM.
MyARM SDK
contains all necessary files to develop ARM instrumented applications.

All these archives extract into one tree if they are unpacked into the same directory. The following command will unpack and install MyARM, assuming archives are in the current working directory and you want to install MyARM into the current working directory. It will create a sub-directory called myarm-1.4.x.0.

tar xvzf myarm-*.tar.gz

Installing the MyARM distribution on a workstation under MS-Windows

The installation under windows is very easy and straightforward. Just double-click on the received msi package. It starts with a welcome dialog (Figure "Installation welcome dialog" ) and requires the user to press the next button several times until it is fully installed.


Figure: Installation welcome dialog

The next dialog (Figure "Installation MyARM license dialog" ) shows the license under which MyARM will be installed. You must accept hte license by clicking on the respective checkbutton. The next button can be clicked only when the license was accepted.


Figure: Installation MyARM license dialog

The license key dialog (Figure "License key dialog") allows to type in the MyARM license that was received via e-mail. This is a string with about 32 characters or more. If you did not receive a license yet leave this as is and change the license key afterwards as described in the chapter below. You will only be able to read the documentation provided as pdf and html files if you did not receive any license.

This dialog is skipped for the community edition since here no license is necessary.


Figure: License key dialog

Next the directory where MyARM will be installed can be selected in the installation directory dialog (Figure "Installation directory dialog" ). Type in the name of the directory you want to install MyARM into or use the "Change"button to open a standard directory dialog where you can select the target directory graphically.


Figure: Installation directory dialog

When you are at this stage you are almost done. You will be prompted to start the installation by clicking Next in the "finished dialog" (Figure "Installation finished dialog"). You will then see the progress in the respective dialog (Figure "Installation progress dialog")


Figure: Installation finished dialog

Figure: Installation progress dialog

When the installation has completed you will be asked to press next to finish the installation (Figure "Installation completed dialog").


Figure: Installation completed dialog

Changing the license key after installation

If you did not receive a license key before installation then you were not able to fill in the required key in the respective dialog (Figure "License key dialog"). The installation just creates the registry key with an empty value so you can easily change this by adapting this key. Just open the registry editor by typing "regedit" into the execution window. (see Figure "License key change after installation") and type in the received license key. You should then be able to execute all MyARM command line tools or the manager if you've purchased the respective license.


Figure: License key change after installation