jacob-mathison/query-orchestration
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Activity

Merged in feature/docresult (pull request #105)

Browse Source 
Document Result Endpoint

* testing

* cleantesting

* progress

* query

* lint

* readme

* dockerclient

* api

* passtest

* tests

* test
This commit is contained in:
Michael McGuinness
2025-03-17 18:14:15 +00:00
parent f7c41c4ef3
commit 555b6d420b
105 changed files with 3276 additions and 2484 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/readme.md
+9 -6
View File
@@ -1,15 +1,18 @@
# Api related artifacts
## Prometheus metrics
Prometheus metrics are exposed for all api endpoints automatically at the standard `/metrics` endpoint. (http://localhost:8080/metrics)
## Swagger API documentation
Automatic API docs are generated and exposed for all routes at http://localhost:8080/swagger/index.html when the api server is running.
Prometheus metrics are exposed for all api endpoints automatically at the standard `/metrics` endpoint. (`http://localhost:8080/metrics`)
## Swagger API documentation
Automatic API docs are generated and exposed for all routes at `http://localhost:8080/swagger/index.html` when the api server is running.
## Logging
## Logging
Structured logging is built into all API routes automatically.
So for example here is a what a few API hits on queryService look like in the logs when using text (as opposed to json)
So for example here is a what a few API hits on queryAPI look like in the logs when using text (as opposed to json)
```bash
____ __
@@ -29,4 +32,4 @@ time=2025-02-05T13:38:39.807-08:00 level=INFO msg="HTTP request" method=GET uri=
time=2025-02-05T13:38:39.871-08:00 level=INFO msg="HTTP request" method=GET uri=/swagger/doc.json status=200 latency=1.163167ms error=<nil> remote_ip=::1
time=2025-02-05T13:38:39.871-08:00 level=INFO msg="HTTP request" method=GET uri=/swagger/favicon-32x32.png status=200 latency=60.875µs error=<nil> remote_ip=::1
```
```