Skip to content

Commit

Permalink
Reorganize demo feature documentation
Browse files Browse the repository at this point in the history
- Create a nested section called features
- Organize feature index page
- Add feature flags under features subsection
- Add signal coverage under features subsection
  • Loading branch information
flands committed Dec 28, 2023
1 parent beffc8e commit 13f501a
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 21 deletions.
2 changes: 2 additions & 0 deletions .cspell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ words:
- currencyservice
- daemonset
- datadog
- dataprepper
- declarators
- discoverability
- dotnet
Expand Down Expand Up @@ -102,6 +103,7 @@ words:
- postgresql
- Pranay
- Prateek
- Prepper
- Println
- productcatalogservice
- prometheus
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,50 @@ linkTitle: 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.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Log Coverage by Service
linkTitle: Log Feature Coverage
linkTitle: Log Coverage
aliases: [log_service_features]
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Metric Feature Coverage by Service
linkTitle: Metric Feature Coverage
title: Metric Coverage by Service
linkTitle: Metric Coverage
aliases: [metric_service_features]
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Trace Feature Coverage by Service
linkTitle: Trace Feature Coverage
title: Trace Coverage by Service
linkTitle: Trace Coverage
aliases: [trace_service_features]
---

Expand Down

0 comments on commit 13f501a

Please sign in to comment.