-
Notifications
You must be signed in to change notification settings - Fork 27
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
Add info about interacting with the docker solution & configure grafana data sources automatically #552
Add info about interacting with the docker solution & configure grafana data sources automatically #552
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,6 +14,32 @@ While in the TrafficCapture directory, run the following command: | |
|
||
`./gradlew :dockerSolution:composeUp` | ||
|
||
### Interacting with the Docker Solution | ||
|
||
A sample source cluster (running Elasticsearch 7.10) is set up with the Capture Proxy running in front of it. To route | ||
calls through the Capture Proxy, send requests to `localhost:9200` with the default credentials (admin, admin), e.g.: | ||
```sh | ||
curl --insecure https://localhost:9200/_cat/indices -u 'admin:admin' | ||
``` | ||
|
||
You can send the same calls to the source cluster while bypassing the Capture Proxy (calls will not be relayed to the | ||
target cluster) via `localhost:19200`, and to the target cluster directly at `localhost:29200`. | ||
|
||
For sample data that exercises various endpoints with a range of datatypes, you can `ssh` into the Migration Console | ||
(`docker exec -i -t $(docker ps -aqf "ancestor=migrations/migration_console:latest") bash` or via the Docker console) | ||
and run `./runTestBenchmarks.sh`. By default, this runs four workloads from | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/four/four short test/ workloads. |
||
[Opensearch-Benchmark](https://github.com/opensearch-project/opensearch-benchmark) against the Capture Proxy endpoint | ||
(9200). The Migration Console contains other utility functions (`./catIndices.sh`, `kafka-tools`, etc.) to interact | ||
with the various containers of the solution. | ||
|
||
You can also access the metrics generated by the solution in Grafana. While the solution is running, go to | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would prefix this with "with the default docker-compose" configuration launched with :dockerSolution:composeUp, instrumentation containers will be started (see below for other options). |
||
[http://localhost:3000](http://localhost:3000/) and enter the default credentials (admin, admin). Connections to | ||
Jaeger and Prometheus are automatically provisioned (see them under `Connections->Data sources`), so you can go | ||
directly to `Explore` and define a query using the supplied data from either data source. | ||
|
||
Traces for the capture proxy and replayer are available via Jaeger at [http://localhost:16686](http://localhost:16686). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. With the prefix above, I'd pull this sentence into the last paragraph to bind it to the clause. |
||
|
||
|
||
### Running with different telemetry flavors. | ||
|
||
By default, composeUp will run an otel-collector that exports instrumentation to other local containers within the | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -35,6 +35,7 @@ services: | |
- "3000:3000" | ||
volumes: | ||
- ./grafana_data:/var/lib/grafana | ||
- ./grafana_datasources.yaml:/usr/share/grafana/conf/provisioning/datasources/datasources.yaml | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. thank you for figuring this out! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yep, I think you're right. This was helpful for testing, but a user is quite unlikely to need that. |
||
environment: | ||
- GF_SECURITY_ADMIN_PASSWORD=admin | ||
depends_on: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
apiVersion: 1 | ||
datasources: | ||
- name: Jaeger | ||
type: jaeger | ||
url: http://jaeger:16686 | ||
basicAuth: false | ||
isDefault: false | ||
readOnly: false | ||
jsonData: {} | ||
- name: Prometheus | ||
type: prometheus | ||
url: http://prometheus:9090 | ||
access: proxy | ||
basicAuth: false | ||
isDefault: true | ||
jsonData: | ||
httpMethod: POST | ||
prometheusType: Prometheus | ||
exemplarTraceIdDestinations: | ||
- name: trace_id | ||
urlDisplayLabel: Jaeger | ||
readOnly: false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ssh threw me here. There's no ssh involved. You could say 'exec', but that might not be clear to somebody new to Docker. Maybe s/ssh into/execute a shell within/ would be better.
ssh kept making me think that you were trying to hit some kind of a deployed cloud resource.