Add ATM dev environment docker-compose and API doc #3171
Conversation
Signed-off-by: albertteoh <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #3171 +/- ##
==========================================
+ Coverage 95.89% 95.95% +0.05%
==========================================
Files 239 239
Lines 14649 14649
==========================================
+ Hits 14048 14056 +8
+ Misses 523 517 -6
+ Partials 78 76 -2
Continue to review full report at Codecov.
|
docker-compose/monitor/README.md
Outdated
| @@ -0,0 +1,173 @@ | |||
| # atm-dev | |||
| Development environment for ATM | |||
There was a problem hiding this comment.
what is ATM? Please spell out.
There was a problem hiding this comment.
Thanks for picking up on this, I've elaborated a little more on what ATM stands for, the architecture of the development/demo environment and explanation of each component with relevant links, and an illustration of how the components interact with one another.
Signed-off-by: albertteoh <[email protected]>
Signed-off-by: albertteoh <[email protected]>
Signed-off-by: albertteoh <[email protected]>
Signed-off-by: albertteoh <[email protected]>
| curl http://localhost:16686/api/metrics/minstep | jq . | ||
| ``` | ||
|
|
||
| # HTTP API |
There was a problem hiding this comment.
I'm planning to add this section into https://www.jaegertracing.io/docs/latest/apis/, would that be an appropriate place or is it sufficient to leave this API doc here?
There was a problem hiding this comment.
It would be there as well, IMO.
Signed-off-by: albertteoh <[email protected]>
| curl http://localhost:16686/api/metrics/minstep | jq . | ||
| ``` | ||
|
|
||
| # HTTP API |
There was a problem hiding this comment.
It would be there as well, IMO.
| jaeger: | ||
| networks: | ||
| - backend | ||
| image: jaegertracing/all-in-one:latest |
There was a problem hiding this comment.
Is this file being tested via CI? If not, it might be better to use a fixed version.
There was a problem hiding this comment.
Is this file being tested via CI?
Nope.
it might be better to use a fixed version.
I'd like to consider one hypothetical scenario, keeping in mind that the ATM/Monitor feature is still under active development (the UI isn't ready yet).
We set the jaeger all-in-one tag to v1.24 here. If someone makes a change now and merges to master before v1.25 is released, if I understand correctly, will users need to wait until v1.26 to obtain/use the features just merged?
| otel_collector: | ||
| networks: | ||
| - backend | ||
| image: otel/opentelemetry-collector-contrib:latest |
Signed-off-by: albertteoh <[email protected]>
|
Thanks for the review Yuri/Juca! |
Signed-off-by: albertteoh [email protected]
Which problem is this PR solving?
Resolves #3107
Short description of the changes