From 13f501a2dde5c3952ecd01ecbae77de312ac211b Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Thu, 28 Dec 2023 08:10:05 -0500 Subject: [PATCH] Reorganize demo feature documentation - Create a nested section called features - Organize feature index page - Add feature flags under features subsection - Add signal coverage under features subsection --- .cspell.yml | 2 + .../demo/{features.md => features/_index.md} | 48 ++++++++++++------- .../docs/demo/{ => features}/feature-flags.md | 0 .../demo/{ => features}/logging-features.md | 2 +- .../demo/{ => features}/metric-features.md | 4 +- .../demo/{ => features}/trace-features.md | 4 +- 6 files changed, 39 insertions(+), 21 deletions(-) rename content/en/docs/demo/{features.md => features/_index.md} (71%) rename content/en/docs/demo/{ => features}/feature-flags.md (100%) rename content/en/docs/demo/{ => features}/logging-features.md (96%) rename content/en/docs/demo/{ => features}/metric-features.md (97%) rename content/en/docs/demo/{ => features}/trace-features.md (97%) diff --git a/.cspell.yml b/.cspell.yml index ba0ccb19a97b..f69356d7881e 100644 --- a/.cspell.yml +++ b/.cspell.yml @@ -33,6 +33,7 @@ words: - currencyservice - daemonset - datadog + - dataprepper - declarators - discoverability - dotnet @@ -102,6 +103,7 @@ words: - postgresql - Pranay - Prateek + - Prepper - Println - productcatalogservice - prometheus diff --git a/content/en/docs/demo/features.md b/content/en/docs/demo/features/_index.md similarity index 71% rename from content/en/docs/demo/features.md rename to content/en/docs/demo/features/_index.md index 1db49fbc372f..213a3490c5bb 100644 --- a/content/en/docs/demo/features.md +++ b/content/en/docs/demo/features/_index.md @@ -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. diff --git a/content/en/docs/demo/feature-flags.md b/content/en/docs/demo/features/feature-flags.md similarity index 100% rename from content/en/docs/demo/feature-flags.md rename to content/en/docs/demo/features/feature-flags.md diff --git a/content/en/docs/demo/logging-features.md b/content/en/docs/demo/features/logging-features.md similarity index 96% rename from content/en/docs/demo/logging-features.md rename to content/en/docs/demo/features/logging-features.md index acc5ca40f88a..31dbf387d725 100644 --- a/content/en/docs/demo/logging-features.md +++ b/content/en/docs/demo/features/logging-features.md @@ -1,6 +1,6 @@ --- title: Log Coverage by Service -linkTitle: Log Feature Coverage +linkTitle: Log Coverage aliases: [log_service_features] --- diff --git a/content/en/docs/demo/metric-features.md b/content/en/docs/demo/features/metric-features.md similarity index 97% rename from content/en/docs/demo/metric-features.md rename to content/en/docs/demo/features/metric-features.md index d87833e5fcbf..25d60a2551ab 100644 --- a/content/en/docs/demo/metric-features.md +++ b/content/en/docs/demo/features/metric-features.md @@ -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] --- diff --git a/content/en/docs/demo/trace-features.md b/content/en/docs/demo/features/trace-features.md similarity index 97% rename from content/en/docs/demo/trace-features.md rename to content/en/docs/demo/features/trace-features.md index cfcc0e59abb8..a4a427edb24e 100644 --- a/content/en/docs/demo/trace-features.md +++ b/content/en/docs/demo/features/trace-features.md @@ -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] ---