Skip to content

Service will interface with the entities document store, currently MongoDB

License

Notifications You must be signed in to change notification settings

hypertrace/entity-service

Repository files navigation

Entity Service

Service that provides CRUD operations for differently identified entities of observed applications.

Description

space-1.jpg
Hypertrace Query Architecture
  • A service layer manages a life cycle of the identified entities of observed applications.
  • Provides CRUD operations for raw or enriched entities, for its types, and their relations.

Building locally

The Entity service uses gradlew to compile/install/distribute. Gradle wrapper is already part of the source code. To build Entity 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 entity-service-test.
  • Go to hypertrace-service and checkout the above branch in the submodule.
cd entity-service && git checkout entity-service-test && cd ..
  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!

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

Docker Image Source: