https://github.com/hypertrace/entity-service
Service will interface with the entities document store, currently MongoDB
https://github.com/hypertrace/entity-service
Last synced: 7 months ago
JSON representation
Service will interface with the entities document store, currently MongoDB
- Host: GitHub
- URL: https://github.com/hypertrace/entity-service
- Owner: hypertrace
- License: other
- Created: 2020-07-06T00:45:30.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T14:48:19.000Z (over 1 year ago)
- Last Synced: 2024-05-22T19:36:06.216Z (over 1 year ago)
- Language: Java
- Size: 1.03 MB
- Stars: 5
- Watchers: 7
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Entity Service
Service that provides CRUD operations for differently identified entities of observed applications.
## Description
|  |
|:--:|
| *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](https://github.com/hypertrace/hypertrace-service) and checkout the above branch in the submodule.
```
cd entity-service && git checkout entity-service-test && cd ..
```
- Change tag for `hypertrace-service` from `:main` to `:test` in [docker-compose file](https://github.com/hypertrace/hypertrace/blob/main/docker/docker-compose.yml) like this.
```yaml
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](https://github.com/hypertrace/hypertrace/blob/main/kubernetes/platform-services/values.yaml) like below and then run `./hypertrace.sh install` again and you can test your image!
```yaml
entity-service:
image:
repository: "hypertrace/entity-service"
tagOverride: "test"
```
## Docker Image Source:
- [DockerHub > Entity service](https://hub.docker.com/r/hypertrace/entity-service)