# AppOpticsAPM Gem Configuration

## Environment Variables

The following environment variables are detected by the appoptics_apm gem and affect how the gem functions.

### General

Name | Description | Default
---- | ----------- | -------
`APPOPTICS_SERVICE_KEY` | API token + service name combination, mandatory for metrics and traces to show in my.appoptics.com | 
`IGNORE_APPOPTICS_WARNING` | tells the appoptics_apm gem to __not__ output the _missing AppOpticsAPM libraries_ message on stack initialization | `false`
`APPOPTICS_GEM_VERBOSE` | sets the verbose flag (`AppOpticsAPM::Config[:verbose]`) early in the gem loading process which may output valuable information | `false`
`APPOPTICS_CUUID` | Allows specifying the customer ID via environment variable to override/bypass the value in `/etc/tracelytics.conf` | `nil`

# Related to Tests

Name | Description | Default
---- | ----------- | -------
`APPOPTICS_GEM_TEST` | puts the gem in test mode.  Traces are written to /tmp/trace_output.bson. | `false`
`DBTYPE` | For tests on Ruby on Rails, specifies the database type to test against.  `postgres`, `mysql` and `mysql2` are valid options. | `postgres`
`APPOPTICS_CASSANDRA_SERVER` | specifies the Cassandra server to test against. | `127.0.0.1:9160`
`APPOPTICS_MONGO_SERVER` | specifies the Mongo server to test against. | `127.0.0.1:27017`
`APPOPTICS_RABBITMQ_SERVER` | specifies the RabbitMQ server to test against. | `127.0.0.1`
`APPOPTICS_RABBITMQ_PORT` | port for the RabbitMQ connection. | `5672`
`APPOPTICS_RABBITMQ_USERNAME` | username for the RabbitMQ connection | `guest`
`APPOPTICS_RABBITMQ_PASSWORD` | password for the RabbitMQ connection | `guest`

## AppOpticsAPM::Config

`AppOpticsAPM::Config` is a nested hash used by the appoptics_apm gem to store preferences and switches.

See [this Rails generator template file](https://github.com/librato/ruby-appoptics/blob/master/lib/rails/generators/appoptics_apm/templates/appoptics_initializer.rb) for documentation on all of the supported values.