Skip to content

Commit

Permalink
add images and service links
Browse files Browse the repository at this point in the history
Signed-off-by: YANGDB <yang.db.dev@gmail.com>
  • Loading branch information
YANG-DB committed May 16, 2023
1 parent 12d52cb commit 85fefce
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 2 deletions.
24 changes: 22 additions & 2 deletions .github/architecture.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# Opensearch OTEL Demo Architecture
This document will review the OpenSearch architecture for the [OTEL demo](https://opentelemetry.io/docs/demo/) and will review how to use the new Observability capabilities
implemented into OpenSearch.
---
This diagram provides an overview of the system components, showcasing the configuration derived from the OpenTelemetry Collector (otelcol) configuration file utilized by the OpenTelemetry demo application.

Additionally, it highlights the observability data (traces and metrics) flow within the system.

![](img/otelcol-data-flow-overview.png)

---
[OTEL DEMO](https://opentelemetry.io/docs/demo/architecture/) Describes the list of services that are composing the Astronomy Shop.

They are combined of:
Expand All @@ -14,9 +21,7 @@ They are combined of:
- [Feature Flag](https://opentelemetry.io/docs/demo/services/feature-flag/)
- [Fraud Detection](https://opentelemetry.io/docs/demo/services/fraud-detection/)
- [Frontend](https://opentelemetry.io/docs/demo/services/frontend/)
- [Frontend Nginx Proxy](../src/nginx-otel/README.md) *(replacement for _Frontend-Proxy_)*
- [Kafka](https://opentelemetry.io/docs/demo/services/kafka/)
- [Load Generator](https://opentelemetry.io/docs/demo/services/load-generator/)
- [Payment](https://opentelemetry.io/docs/demo/services/payment/)
- [Product Catalog](https://opentelemetry.io/docs/demo/services/product-catalog/)
- [Quote](https://opentelemetry.io/docs/demo/services/quote/)
Expand All @@ -25,6 +30,21 @@ They are combined of:
- [Fluent-Bit](../src/fluent-bit/README.md) *(nginx's otel log exported)*
- [Integrations](../src/integrations/README.md) *(pre-canned OpenSearch assets)*

Backend supportive services
- [Load Generator](http://load-generator:8089)
- See [description](https://opentelemetry.io/docs/demo/services/load-generator/)
- [Frontend Nginx Proxy](http://nginx:90) *(replacement for _Frontend-Proxy_)*
- See [description](../src/nginx-otel/README.md)
- [OpenSearch](https://opensearch-node1:9200)
- See [description](https://github.com/YANG-DB/opentelemetry-demo/blob/12d52cbb23bbf4226f6de2dfec840482a0a7d054/docker-compose.yml#L697)
- [Dashboards](http://opensearch-dashboards:5601)
- See [description](https://github.com/YANG-DB/opentelemetry-demo/blob/12d52cbb23bbf4226f6de2dfec840482a0a7d054/docker-compose.yml#L747)
- [Prometheus](http://prometheus:9090)
- See [description](https://github.com/YANG-DB/opentelemetry-demo/blob/12d52cbb23bbf4226f6de2dfec840482a0a7d054/docker-compose.yml#L674)
- [Feature-Flag](http://feature-flag-service:8881)
- See [description](../src/featureflagservice/README.md)
- [Grafana](http://grafana:3000)
- See [description](https://github.com/YANG-DB/opentelemetry-demo/blob/12d52cbb23bbf4226f6de2dfec840482a0a7d054/docker-compose.yml#L637)

---

Expand Down
Binary file added .github/img/otelcol-data-flow-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions add_hosts_locally.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,20 @@ IP="127.0.0.1"
OPENSEARCH_HOST="opensearch-node1"
OPENSEARCH_DASHBOARD="opensearch-dashboards"
OTEL_STORE="frontend"
FEATURE_FLAG_SERVICE="feature-flag-service"
NGINX="nginx"
OTEL_LOADER="loadgenerator"
PROMETHEUS="prometheus"
LOAD_GENERATOR="load-generator"
GRAFANA="grafana"

# Add the entry to the /etc/hosts file
echo "$IP $OPENSEARCH_HOST" | sudo tee -a /etc/hosts
echo "$IP $OPENSEARCH_DASHBOARD" | sudo tee -a /etc/hosts
echo "$IP $OTEL_STORE" | sudo tee -a /etc/hosts
echo "$IP $PROMETHEUS" | sudo tee -a /etc/hosts
echo "$IP $OTEL_LOADER" | sudo tee -a /etc/hosts
echo "$IP $NGINX" | sudo tee -a /etc/hosts
echo "$IP $LOAD_GENERATOR" | sudo tee -a /etc/hosts
echo "$IP $FEATURE_FLAG_SERVICE" | sudo tee -a /etc/hosts
echo "$IP $GRAFANA" | sudo tee -a /etc/hosts
1 change: 1 addition & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,7 @@ services:
# Frontend Proxy service
nginx:
image: nginx:latest
container_name: nginx
volumes:
- ./src/nginx-otel/default.conf:/etc/nginx/conf.d/default.conf
ports:
Expand Down

0 comments on commit 85fefce

Please sign in to comment.