@stigg/sidecar v2.414.3

Stigg Sidecar Service

What does Stigg Sidecar do?

Stigg Sidecar is a tiny service that runs alongside the main application, acting as a proxy between the host and the Stigg API, while ensuring low latency entitlement checks, handles caching and provides simplified access to real-time data.

The benefits of deploying the Sidecar:

• Less CPU consumption and memory footprint for the host application when compared to embedding the SDK directly
• Language neutral API via Protocol Buffers and gRPC
• Support for in-memory cache or external cache (Redis) for entitlements and usage data
• Scaled together with the main application, or independently if deployed as a standalone service
• Synergy with persistent-cache-service if external cache is in use
• Easy generation of SDK clients in multiple languages, backed by well-known RPC frameworks and tools

Architecture

Prerequisites:

• Docker
• Redis instance, if redis cache is used

Usage:

Login to AWS ECR:

aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws/stigg

Run the service:

docker run  --rm --name stigg-sidecar --memory=1gb --cpus="1" \
  --publish=8443:8443 --publish=8080:8080 \
  -e SERVER_API_KEY="<SERVER_API_KEY>" \
  public.ecr.aws/stigg/sidecar:latest

Configuration:

*Required fields

Health and Metrics:

The service exposes health and metrics endpoints on HTTP server (default port 8080).

GET /livez

Returns 200 if the service is alive.

Healthy response: {"status":"UP"}

GET /readyz

Returns 200 if the service is ready.

Healthy response: { "status": "UP" }

GET /metrics

Returns Prometheus metrics in text format.