-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Reorganize demo feature documentation #3714
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
52 changes: 34 additions & 18 deletions
52
content/en/docs/demo/features.md → ...en/docs/demo/telemetry-features/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,53 @@ | ||
--- | ||
title: Demo Features | ||
linkTitle: Features | ||
title: Telemetry Features | ||
linkTitle: Telemetry Features | ||
aliases: [demo_features] | ||
--- | ||
|
||
- **[Kubernetes](https://kubernetes.io/)**: the app is designed to run on | ||
Kubernetes (both locally, as well as on the cloud) using a Helm chart. | ||
- **[Docker](https://docs.docker.com)**: this forked sample can also be executed | ||
only with Docker. | ||
- **[gRPC](https://grpc.io/)**: microservices use a high volume of gRPC calls to | ||
communicate to each other. | ||
- **[HTTP](https://www.rfc-editor.org/rfc/rfc9110.html)**: microservices use | ||
HTTP where gRPC is unavailable or not well supported. | ||
## OpenTelemetry | ||
|
||
- **[OpenTelemetry Traces](/docs/concepts/signals/traces/)**: all services are | ||
instrumented using OpenTelemetry available instrumentation libraries. | ||
- **[OpenTelemetry Metrics](/docs/concepts/signals/metrics/)**: Select services | ||
- **[OpenTelemetry Metrics](/docs/concepts/signals/metrics/)**: select services | ||
are instrumented using OpenTelemetry available instrumentation libraries. More | ||
will be added as the relevant SDKs are released. | ||
- **[OpenTelemetry Logs](/docs/concepts/signals/logs/)**: select services are | ||
instrumented using OpenTelemetry available instrumentation libraries. More | ||
will be added as the relevant SDKs are released. | ||
- **[OpenTelemetry Collector](/docs/collector/)**: all services are instrumented | ||
and sending the generated traces and metrics to the OpenTelemetry Collector | ||
via gRPC. The received traces are then exported to the logs and to Jaeger; | ||
received metrics and exemplars are exported to logs and Prometheus. | ||
|
||
## Observability Solutions | ||
|
||
- **[Grafana](https://grafana.com/)**: all metric dashboards are stored in | ||
Grafana. | ||
- **[Jaeger](https://www.jaegertracing.io/)**: all generated traces are being | ||
sent to Jaeger. | ||
- **Synthetic Load Generation**: the application demo comes with a background | ||
job that creates realistic usage patterns on the website using | ||
[Locust](https://locust.io/) load generator. | ||
- **[OpenSearch](https://opensearch.org/)**: all generated logs are sent to | ||
DataPrepper. OpenSearch will be used to centralize logging data from services. | ||
- **[Prometheus](https://prometheus.io/)**: all generated metrics and exemplars | ||
are scraped by Prometheus. | ||
- **[Grafana](https://grafana.com/)**: all metric dashboards are stored in | ||
Grafana. | ||
|
||
## Environments | ||
|
||
- **[Docker](https://docs.docker.com)**: this forked sample can be executed with | ||
Docker. | ||
- **[Kubernetes](https://kubernetes.io/)**: the app is designed to run on | ||
Kubernetes (both locally, as well as on the cloud) using a Helm chart. | ||
|
||
## Protocols | ||
|
||
- **[gRPC](https://grpc.io/)**: microservices use a high volume of gRPC calls to | ||
communicate to each other. | ||
- **[HTTP](https://www.rfc-editor.org/rfc/rfc9110.html)**: microservices use | ||
HTTP where gRPC is unavailable or not well supported. | ||
|
||
## Other Components | ||
|
||
- **[Envoy](https://www.envoyproxy.io/)**: Envoy is used as a reverse proxy for | ||
user-facing web interfaces such as the frontend, load generator, and feature | ||
flag service. | ||
- **[OpenSearch](https://opensearch.org/)**: OpenSearch is used to centralize | ||
logging data from services. | ||
- **[Locust](https://locust.io)**: a background job that creates realistic usage | ||
patterns on the website using a synthetic load generator. |
4 changes: 2 additions & 2 deletions
4
content/en/docs/demo/logging-features.md → ...mo/telemetry-features/logging-features.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
6 changes: 3 additions & 3 deletions
6
content/en/docs/demo/metric-features.md → ...emo/telemetry-features/metric-features.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
content/en/docs/demo/trace-features.md → ...demo/telemetry-features/trace-features.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
What was the intent here? This added alias effectively pushes a page alias outside of the Demo section, which we don't want IMHO.
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.
Let's track this via: