Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Enhancement] Hotrod and Monitor Use Docker Compose V2 as Default #6523

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

zzzk1
Copy link
Contributor

@zzzk1 zzzk1 commented Jan 11, 2025

Which problem is this PR solving?

Description of the changes

  • Rename docker-compose.yml to docker-compose-v1.yml
  • update reference: script, doc, github actions, makefile

How was this change tested?

Checklist

@zzzk1 zzzk1 requested a review from a team as a code owner January 11, 2025 10:48
@zzzk1 zzzk1 requested a review from joe-elliott January 11, 2025 10:48
@dosubot dosubot bot added the docker Pull requests that update Docker code label Jan 11, 2025
@zzzk1 zzzk1 force-pushed the docker-compose-v2 branch from 1ad5347 to e9b8615 Compare January 11, 2025 10:49
@zzzk1 zzzk1 force-pushed the docker-compose-v2 branch from e9b8615 to ff0faea Compare January 11, 2025 10:53
Copy link

codecov bot commented Jan 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.29%. Comparing base (980dc31) to head (ff0faea).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6523      +/-   ##
==========================================
+ Coverage   96.27%   96.29%   +0.01%     
==========================================
  Files         372      372              
  Lines       21283    21283              
==========================================
+ Hits        20491    20494       +3     
+ Misses        605      603       -2     
+ Partials      187      186       -1     
Flag Coverage Δ
badger_v1 10.67% <ø> (ø)
badger_v2 2.78% <ø> (ø)
cassandra-4.x-v1-manual 16.57% <ø> (ø)
cassandra-4.x-v2-auto 2.71% <ø> (ø)
cassandra-4.x-v2-manual 2.71% <ø> (ø)
cassandra-5.x-v1-manual 16.57% <ø> (ø)
cassandra-5.x-v2-auto 2.71% <ø> (ø)
cassandra-5.x-v2-manual 2.71% <ø> (ø)
elasticsearch-6.x-v1 20.23% <ø> (-0.01%) ⬇️
elasticsearch-7.x-v1 20.31% <ø> (ø)
elasticsearch-8.x-v1 20.47% <ø> (+<0.01%) ⬆️
elasticsearch-8.x-v2 2.77% <ø> (ø)
grpc_v1 12.31% <ø> (ø)
grpc_v2 9.09% <ø> (ø)
kafka-3.x-v1 10.35% <ø> (ø)
kafka-3.x-v2 2.78% <ø> (ø)
memory_v2 2.78% <ø> (ø)
opensearch-1.x-v1 20.36% <ø> (+<0.01%) ⬆️
opensearch-2.x-v1 20.36% <ø> (ø)
opensearch-2.x-v2 2.77% <ø> (-0.01%) ⬇️
tailsampling-processor 0.51% <ø> (ø)
unittests 95.16% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@yurishkuro yurishkuro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, good start.

@@ -20,7 +20,7 @@ build: clean-jaeger
.PHONY: dev
dev: export JAEGER_IMAGE_TAG = dev
dev:
docker compose -f docker-compose.yml up $(DOCKER_COMPOSE_ARGS)
docker compose -f docker-compose-v1.yml up $(DOCKER_COMPOSE_ARGS)

.PHONY: dev-v2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we change the target names accordingly? And the readme.

@@ -69,7 +69,7 @@ This brings up the system necessary to use the SPM feature locally.
It uses the latest image tags from both Jaeger and OpenTelemetry.

```shell
docker compose up
docker compose -f docker-compose-v1.yml up
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's turn this around and emphasize v2 first, with a note for v1

@@ -83,7 +83,7 @@ docker compose -f docker-compose-v2.yml up
- Navigate to Jaeger UI at http://localhost:16686/ and inspect the Monitor tab. Select `redis` service from the dropdown to see more than one endpoint.
- To visualize the raw metrics stored on the Prometheus server (for debugging and local development use cases), use the built-in Prometheus UI at http://localhost:9090/query. For example, http://localhost:9090/query?g0.expr=traces_span_metrics_calls_total&g0.tab=0&g0.range_input=5m

**Warning:** The included [docker-compose.yml](./docker-compose.yml) file uses the `latest` version of Jaeger and other components. If your local Docker registry already contains older versions, which may still be tagged as `latest`, you may want to delete those images before running the full set, to ensure consistent behavior:
**Warning:** The included [docker-compose-v1.yml](./docker-compose-v1.yml) file uses the `latest` version of Jaeger and other components. If your local Docker registry already contains older versions, which may still be tagged as `latest`, you may want to delete those images before running the full set, to ensure consistent behavior:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Warning:** The included [docker-compose-v1.yml](./docker-compose-v1.yml) file uses the `latest` version of Jaeger and other components. If your local Docker registry already contains older versions, which may still be tagged as `latest`, you may want to delete those images before running the full set, to ensure consistent behavior:
**Warning:** The included ` docker compose` files use the `latest` version of Jaeger and other components. If your local Docker registry already contains older versions, which may still be tagged as `latest`, you may want to delete those images before running the full set, to ensure consistent behavior:

@@ -126,7 +126,7 @@ to emit traces to the OpenTelemetry Collector which, in turn, will aggregate the

Start the local stack needed for SPM, if not already done:
```shell
docker compose up
docker compose -f docker-compose-v2.yml up
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The v2 files need to be renamed just docker-compose, so that the user is not required to specify them on the command line.

@@ -23,7 +23,7 @@ As of Jaeger v1.42.0 this application was upgraded to use the OpenTelemetry SDK

### Run everything via `docker compose`

* Download `docker-compose.yml` from https://github.com/jaegertracing/jaeger/blob/main/examples/hotrod/docker-compose.yml
* Download `docker-compose-v1.yml` from https://github.com/jaegertracing/jaeger/blob/main/examples/hotrod/docker-compose-v1.yml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Emphasize v2 versions in the docs, not v1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docker Pull requests that update Docker code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make hotrod/docker compose v2 the default
2 participants