# Aspecto::OpenTelemetry

Aspecto's SDK for ruby.  
This gem is a distribution of OpenTelemetry pre-configured to use all available instrumentations and export trace data to Aspecto.

## Installation

Install the gem using:

```zsh
$ gem install aspecto-opentelemetry
```

Or, if you use [bundler](https://bundler.io), include aspecto-opentelemetry in your Gemfile.

## Usage

### Rails Applications

#### Configuration in Code

Add this code to a new file `aspecto.rb` under `config/initializers/`:

```rb
# config/initializers/aspecto.rb
require 'aspecto/opentelemetry'

Aspecto::OpenTelemetry::configure do |c|
  c.service_name = '<YOUR_SERVICE_NAME>'
  c.aspecto_auth = '<YOUR_ASPECTO_TOKEN>'
  # c.sampling_ratio = 1.0 # [optional]: defaults to 1.0, use aspecto app to configure remotely
end
```

#### Configuration via Environment Variables

In your Gemfile:

```
gem 'aspecto-opentelemetry', require: 'aspecto/auto_instrument'
```

And set environment variables:

```
OTEL_SERVICE_NAME=<YOUR_SERVICE_NAME>
ASPECTO_AUTH=<YOUR_ASPECTO_TOKEN>
# ASPECTO_SAMPLING_RATIO=1.0 # [optional]: defaults to 1.0, use aspecto app to configure remotely
```

### Ruby Applications

#### Configuration in Code

Add this code after your require other gems:

```rb
require 'aspecto/opentelemetry'

Aspecto::OpenTelemetry::configure do |c|
  c.service_name = '<YOUR_SERVICE_NAME>'
  c.aspecto_auth = '<YOUR_ASPECTO_TOKEN>'
  # c.env = '<CURRENT_ENVIRONMENT>' # [optional]: automatically detected for rails and sinatra
  # c.sampling_ratio = 1.0 # [optional]: defaults to 1.0, use aspecto app to configure remotely
end
```

#### Configuration via Environment Variables

Add this require statement after your require other gems:

```rb
require 'aspecto/auto_instrument'
```

And set environment variables:

```
OTEL_SERVICE_NAME=<YOUR_SERVICE_NAME>
ASPECTO_AUTH=<YOUR_ASPECTO_TOKEN>
# ASPECTO_ENV=<CURRENT_ENVIRONMENT> # [optional]: automatically detected for rails and sinatra
# ASPECTO_SAMPLING_RATIO=1.0 # [optional]: defaults to 1.0, use aspecto app to configure remotely
```

### Shutdown

Call this function when your application shuts down

```rb
Aspecto::OpenTelemetry::shutdown
```

## Configuration

You can set configuration via environment variables or via code. Values set in code takes precedence.
The only required config options are [`aspecto_auth`](https://app.aspecto.io/app/integration/api-key) and `service_name`.

### Configuration Options

| Option Name                          | Environment Variable                 | Type        | Default                                 | Description                                                                                                                                          |
| ------------------------------------ | ------------------------------------ | ----------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `aspecto_auth`                       | `ASPECTO_AUTH`                       | UUID string | -                                       | Aspecto's [API key for authentication](https://app.aspecto.io/app/integration/api-key)                                                               |
| `service_name`                       | `OTEL_SERVICE_NAME`                  | string      | -                                       | name of the service which is sending telemetry                                                                                                       |
| `env`                                | `ASPECTO_ENV`                        | string      | extracted from rails or sinatra if used | deployment environment: `production` / `staging` / `development`, etc.                                                                               |
| `log_level`                          | `OTEL_LOG_LEVEL`                     | string      | `ERROR`                                 | `ERROR` / `WARN` / `INFO`, etc.                                                                                                                      |
| `sampling_ratio`                     | `ASPECTO_SAMPLING_RATIO`             | float       | 1.0                                     | How many of the traces starting in this service should be sampled. set to number in range [0.0, 1.0] where 0.0 is no sampling, and 1.0 is sample all |
| `otel_exporter_otlp_traces_endpoint` | `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` | URL         | "https://otelcol.aspecto.io/v1/trace"   | Url                                                                                                                                                  |

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/aspecto-io/aspecto-opentelemetry-ruby.