Docs / Capability guide

Enricher extension

Add contextual segments while preserving the signals already on a request.

All capabilities · Related guide · Agent prompt for this capability

When to use this example

Use an Enricher when targeting needs a contextual signal that is not already present. The example shows how to add a segment without overwriting known geography or inventing missing data.

What the example gives you

The starter adds a coarse mobile-context segment when the User-Agent contains mobile and preserves supplied geography. It makes no lookup requests. A more precise classifier or data provider requires your own implementation and privacy checks.

Before you start

Go for local tests. Host installation also requires a supported kind, reachable gRPC address, matching descriptor/entitlement and an installed stack product. Read the packaged README for policy configuration.

Run the example

Download extension-sidecar

Extract the archive and follow README.md for setup, commands, and expected results. Start with go run . -kind enricher -addr 127.0.0.1:50051. Local tests use sample data.

Follow the archive's service configuration and deployment steps before registering or installing it in Riptide. The prerequisites above describe the access and connectivity it needs.

Connect it to your application

  1. Run go test -race ./... in the downloaded starter, then start -kind enricher. Read the corresponding fixture and configure the policy before testing live requests.

  2. Enricher uses ExtensionService Describe, Health and Invoke with method Enrich. Add configured contextual facts only when the input leaves them unset. Preserve existing authoritative fields and leave unknown geography or consent values unset.

  3. Run the gRPC smoke tests, then install using the stack-product workflow. Verify timeout and fallback behavior and remove the activation to test rollback.

Check the result

The descriptor matches the selected kind, gRPC calls return the documented result, and malformed/unsupported requests fail explicitly. A host timeout skips the extension within the request budget.

API operations