Skip to content

Update README.md #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tammergalal merged 2 commits into from
Jul 8, 2025
Merged

Update README.md #96

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0088491
Update README.md
spottsdd Jul 3, 2025
a98c6ef
changed order of features
spottsdd Jul 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,19 @@ These variables control the upstream configuration for the ads services in the N

There are several features that can be enabled by setting environment variables and feature flags.

### A/B Testing Ads services

Run two Ads services and split traffic between them. The amount of traffic sent to each service is set with a percent value.

**How to use**
1. Add a second Ads service to the `docker-compose.yml`
1. Add and set these environment variables to the `service-proxy` service:
- `ADS_A_UPSTREAM`: Host and port for the primary (A) ads service (default: `ads:3030`)
- `ADS_B_UPSTREAM`: Host and port for the secondary (B) ads service (default: `ads-python:3030`)
- `ADS_B_PERCENT`: Percentage of traffic to route to the B (Python) ads service (default: `0`). The remainder goes to the A (Java) ads service.
- Set to a value between `0` and `100` to control the split.
1. Start the app via `docker compose up`

### Feature flags
Some capabilities are hidden behind feature flags, which can be controlled via `services/frontend/site/featureFlags.config.json`.

Expand Down Expand Up @@ -256,19 +269,6 @@ This will swap out the product card component with a version that doesn't have t

Modify this functionality in `services/frontend/components/Product/ProductCard.tsx` and `services/frontend/components/Product/ProductCard-v2.tsx`.

### A/B Testing Ads services

Run two Ads services and split traffic between them. The amount of traffic sent to each service is set with a percent value.

**How to use**
1. Add a second Ads service to the `docker-compose.yml`
1. Add and set these environment variables to the `service-proxy` service:
- `ADS_A_UPSTREAM`: Host and port for the primary (A) ads service (default: `ads:3030`)
- `ADS_B_UPSTREAM`: Host and port for the secondary (B) ads service (default: `ads-python:3030`)
- `ADS_B_PERCENT`: Percentage of traffic to route to the B (Python) ads service (default: `0`). The remainder goes to the A (Java) ads service.
- Set to a value between `0` and `100` to control the split.
1. Start the app via `docker compose up`

## Image publication
Images are stored in GHCR. On PR merges, only the affected services will be pushed to GHCR, using the `latest` tag. For example, if you only made changes to the `backend` service, then only the `backend` Github workflow will trigger and publish `ghcr.io/datadog/storedog/backend:latest`.

Expand Down