README.md

Gateway Service

An entry service that acts as a single access point for querying data from other services like entity-service, query-service, Attribute service.

Description

Hypertrace Query Architecture

Gateway service routes queries to corresponding downstream service based on the source of attributes and then does appropriate type conversion of data returned by downstream services.

Building locally

The Gateway service uses gradlew to compile/install/distribute. Gradle wrapper is already part of the source code. To build Gateway Service, run:

./gradlew dockerBuildImages

Testing

Running unit tests

Run ./gradlew test to execute unit tests.

Testing image

With docker-compose

To test your image using the docker-compose setup follow the steps:

• Commit you changes to a branch say gateway-service-test.
• Go to hypertrace-service and checkout the above branch in the submodule.

cd gateway-service && git checkout gateway-service-test && cd ..

• Change tag for hypertrace-service from :main to :test in docker-compose file like this.

  hypertrace-service:
    image: hypertrace/hypertrace-service:test
    container_name: hypertrace-service
    ...

• and then run docker-compose up to test the setup.

With Helm setup

Add image repository and tag in values.yaml file here like below and then run ./hypertrace.sh install again and you can test your image!

gateway-service:
  image:
    repository: "hypertrace/gateway-service"
    tagOverride: "test"

Docker Image Source:

• DockerHub > Gateway service