---
title: Set up App and API Protection for Ruby on macOS
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: >-
  Docs > Datadog Security > App and API Protection > Enabling App and API
  Protection > Enabling AAP for Ruby > Set up App and API Protection for Ruby on
  macOS
---

# Set up App and API Protection for Ruby on macOS

{% callout %}
# Important note for users on the following Datadog sites: app.ddog-gov.com

{% alert level="danger" %}
This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site.md). ().
{% /alert %}

{% /callout %}

## Overview{% #overview %}

App and API Protection works by leveraging the [Datadog Ruby library](https://github.com/DataDog/dd-trace-rb/) to monitor and secure your Ruby service. The library integrates seamlessly with your existing application without requiring code changes.

For detailed compatibility information, including supported Ruby versions, frameworks, and deployment environments, see [Ruby Compatibility Requirements](https://docs.datadoghq.com/security/application_security/setup/ruby/compatibility.md).

This guide explains how to set up App and API Protection (AAP) for Ruby applications. The setup involves:

1. Installing the Datadog Agent
1. Enabling App and API Protection monitoring
1. Run Your Application
1. Verifying the setup

## Prerequisites{% #prerequisites %}

- macOS operating system
- Ruby application
- Homebrew (recommended for Agent installation)
- Administrator privileges for some configuration steps
- Your Datadog API key
- Datadog Ruby tracing library (see [version requirements](https://docs.datadoghq.com/security/application_security/setup/ruby/compatibility.md))

## 1. Installing the Datadog Agent

Install the Datadog Agent by following the [setup instructions for macOS](https://docs.datadoghq.com/agent.md?tab=macOS).

## 2. Enabling App and API Protection monitoring

Install and configure the `datadog` gem in your Ruby application.

{% collapsible-section %}
#### APM Tracing Enabled

{% tab title="Configuration file" %}
Add the `datadog` gem to your Gemfile:

```ruby
gem 'datadog', '~> 2.0'
```

Install dependencies:

```bash
bundle install
```

Configure Datadog library by adding an initializer:

```ruby
Datadog.configure do |c|
  c.service = 'your_service_name'
  c.env = Rails.env

  c.tracing.enabled = true

  # Tracing instrumentation for Rails has to be explicitly enabled
  c.tracing.instrument :rails

  c.appsec.enabled = true
  c.appsec.api_security.enabled = true

  # Rails instrumentation is required for App and API Protection
  c.appsec.instrument :rails
end
```

{% /tab %}

{% tab title="Auto-instrumentation and environment variables" %}
Add the `datadog` gem to your Gemfile and require auto-instrumentation:

```ruby
gem 'datadog', '~> 2.0', require: 'datadog/auto_instrument'
```

Install dependencies:

```bash
bundle install
```

Set environment variables for your application. Add these to your deployment configuration or shell environment:

```bash
export DD_APPSEC_ENABLED=true
export DD_API_SECURITY_ENABLED=true
export DD_SERVICE=<YOUR_SERVICE_NAME>
export DD_ENV=<YOUR_ENVIRONMENT>
```

{% /tab %}

{% /collapsible-section %}

{% collapsible-section %}
#### APM Tracing Disabled

To disable APM tracing while keeping App and API Protection enabled, you must set the APM tracing configuration to false.

{% tab title="Configuration file" %}
Add the `datadog` gem to your Gemfile:

```ruby
gem 'datadog', '~> 2.0'
```

Install dependencies:

```bash
bundle install
```

Configure Datadog library by adding an initializer:

```ruby
Datadog.configure do |c|
  c.service = 'your_service_name'
  c.env = Rails.env

  # Disable APM Tracing
  c.tracing.enabled = false

  # Tracing instrumentation for Rails has to be explicitly enabled
  c.tracing.instrument :rails

  c.appsec.enabled = true
  c.appsec.api_security.enabled = true

  # Rails instrumentation is required for App and API Protection
  c.appsec.instrument :rails
end
```

{% /tab %}

{% tab title="Auto-instrumentation and environment Variables" %}
Add the `datadog` gem to your Gemfile and require auto-instrumentation:

```ruby
gem 'datadog', '~> 2.0', require: 'datadog/auto_instrument'
```

Install dependencies:

```bash
bundle install
```

Set environment variables for your application. Add these to your deployment configuration or shell environment:

```bash
export DD_APPSEC_ENABLED=true
export DD_API_SECURITY_ENABLED=true
export DD_APM_TRACING_ENABLED=false
export DD_SERVICE=<YOUR_SERVICE_NAME>
export DD_ENV=<YOUR_ENVIRONMENT>
```

{% /tab %}

{% /collapsible-section %}

## 3: Run Your Application

Start your application with above settings.

## 4. Verify setup

To verify that App and API Protection is working correctly:

1. Send some traffic to your application.
1. Check the [App and API Protection Service Inventory](https://app.datadoghq.com/security/appsec/inventory/services) in Datadog.
1. Find your service and check that App and API protection is enabled in the **Coverage** column.

## Troubleshooting{% #troubleshooting %}

If you encounter issues while setting up App and API Protection for your Ruby application, see the [Ruby App and API Protection troubleshooting guide](https://docs.datadoghq.com/security/application_security/setup/ruby/troubleshooting.md).

## Further Reading{% #further-reading %}

- [How App and API Protection Works](https://docs.datadoghq.com/security/application_security/how-it-works.md)
- [OOTB App and API Protection Rules](https://docs.datadoghq.com/security/default_rules.md?category=cat-application-security)
- [Troubleshooting App and API Protection](https://docs.datadoghq.com/security/application_security/troubleshooting.md)