util/CloudWatch-1.0.12.1/README.TXT

   1 Amazon CloudWatch (Monitoring) Command Line Tools
   2 =================================================
   3
   4 Installation:
   5 -------------
   6
   7 1. Ensure that JAVA version 1.5 or higher is installed on your system: (java -version)
   8 2. Unzip the deployment zip file
   9 3. Set the following environment variables:
  10 3.1 AWS_CLOUDWATCH_HOME - The directory where the deployment files were copied to
  11         check with:
  12            Unix: ls ${AWS_CLOUDWATCH_HOME}/bin should list mon-list-metrics ...)
  13            Windows: dir %AWS_CLOUDWATCH_HOME%\bin should list mon-list-metrics ...)
  14 3.2 JAVA_HOME - Java Installation home directory
  15 4. Add ${AWS_CLOUDWATCH_HOME}/bin (in Windows: %AWS_CLOUDWATCH_HOME%\bin) to your path
  16
  17 Configuration:
  18 --------------
  19
  20 Provide the command line tool with your AWS user credentials.  There
  21 are two ways you can provide credentails: AWS keys, or using X.509
  22 certificates.
  23
  24 Using AWS Keys
  25 --------------
  26
  27 1. Create a credential file: The deployment includes a template file ${AWS_CLOUDWATCH_HOME}/credential-file-path.template.
  28      Edit a copy of this file to add your information.
  29      On UNIX, limit permissions to the owner of the credential file: $ chmod 600 <the file created above>.
  30 2. There are several ways to provide your credential information:
  31       a. Set the following environment variable: AWS_CREDENTIAL_FILE=<the file created in 1>
  32       b. Alternatively, provide the following option with every command --aws-credential-file <the file created in 1>
  33       c. Explicitly specify credentials on the command line: --I ACCESS_KEY --S SECRET_KEY
  34
  35 Using X.509 Certs
  36 -----------------
  37
  38 1. Save your cetificate and private keys to files: e.g. my-cert.pem
  39 and my-pk.pem.
  40
  41 2. There are two ways to provide the certificate information to the
  42 command line tool
  43     a.  Set the following environment variables:
  44         EC2_CERT=/path/to/cert/file
  45         EC2_PRIVATE_KEY=/path/to/key/file
  46     b.  Specify the files directly on command-line for every command
  47         <command> --ec2-cert-file-path=/path/to/cert/file --ec2-private-key-file-path=/path/to/key/file
  48
  49 Setting custom JVM properties
  50 -----------------------------
  51
  52 By setting the environment variable SERVICE_JVM_ARGS, you can pass arbitrary JVM properties to the command line.
  53 For example, the following line sets proxy server properties in Linux/UNIX
  54   export SERVICE_JVM_ARGS="-Dhttp.proxyHost=http://my.proxy.com -Dhttp.proxyPort=8080"
  55
  56
  57 Running:
  58 ---------
  59
  60 1. Check that your setup works properly, run the following command:
  61    $ mon-cmd --help
  62       You should see the usage page for all Monitoring commands
  63
  64    $ mon-list-metrics --headers
  65       You should see a header line. If you have any metrics defined, you should see them as well.