From 640107c15acaa4811b2af221f2d8cfba6e288fa2 Mon Sep 17 00:00:00 2001 From: fderuiter <127706008+fderuiter@users.noreply.github.com> Date: Wed, 18 Mar 2026 14:58:23 +0000 Subject: [PATCH 1/2] feat: add distributed observability and telemetry architect prompt - Add `distributed_observability_telemetry_architect.prompt.yaml` - Update doc indexes and documentation Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> --- docs/architecture.md | 1 + docs/index.md | 1 + ...bservability_telemetry_architect.prompt.md | 63 +++++++++++++++++++ docs/table-of-contents.md | 1 + ...ervability_telemetry_architect.prompt.yaml | 50 +++++++++++++++ 5 files changed, 116 insertions(+) create mode 100644 docs/prompts/technical/architecture/distributed_observability_telemetry_architect.prompt.md create mode 100644 prompts/technical/architecture/distributed_observability_telemetry_architect.prompt.yaml diff --git a/docs/architecture.md b/docs/architecture.md index a63c2d81..7986b6b6 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -8,6 +8,7 @@ title: Architecture - [Chaos Engineering Experiment Designer](prompts/technical/architecture/chaos_engineering_experiment_designer.prompt.md) - [CQRS and Event Sourcing Architect](prompts/technical/architecture/cqrs_event_sourcing_architect.prompt.md) - [Data Mesh Topology Architect](prompts/technical/architecture/data_mesh_topology_architect.prompt.md) +- [Distributed Observability and Telemetry Architect](prompts/technical/architecture/distributed_observability_telemetry_architect.prompt.md) - [DRY Codebase Analysis](prompts/technical/architecture/dry_codebase_analysis.prompt.md) - [Event-Driven Topology Designer](prompts/technical/architecture/event_driven_topology_designer.prompt.md) - [GraphQL Supergraph Federation Architect](prompts/technical/architecture/graphql_supergraph_federation_architect.prompt.md) diff --git a/docs/index.md b/docs/index.md index 6a5cf743..e9614fe6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -649,6 +649,7 @@ Whether you are a Product Manager, Clinical Lead, or Software Engineer, this rep - [Chaos Engineering Experiment Designer](prompts/technical/architecture/chaos_engineering_experiment_designer.prompt.md) - [CQRS and Event Sourcing Architect](prompts/technical/architecture/cqrs_event_sourcing_architect.prompt.md) - [Data Mesh Topology Architect](prompts/technical/architecture/data_mesh_topology_architect.prompt.md) +- [Distributed Observability and Telemetry Architect](prompts/technical/architecture/distributed_observability_telemetry_architect.prompt.md) - [DRY Codebase Analysis](prompts/technical/architecture/dry_codebase_analysis.prompt.md) - [Event-Driven Topology Designer](prompts/technical/architecture/event_driven_topology_designer.prompt.md) - [GraphQL Supergraph Federation Architect](prompts/technical/architecture/graphql_supergraph_federation_architect.prompt.md) diff --git a/docs/prompts/technical/architecture/distributed_observability_telemetry_architect.prompt.md b/docs/prompts/technical/architecture/distributed_observability_telemetry_architect.prompt.md new file mode 100644 index 00000000..7d12bf11 --- /dev/null +++ b/docs/prompts/technical/architecture/distributed_observability_telemetry_architect.prompt.md @@ -0,0 +1,63 @@ +--- +title: Distributed Observability and Telemetry Architect +--- + +# Distributed Observability and Telemetry Architect + +Designs highly scalable, robust distributed observability and telemetry pipelines. + +[View Source YAML](https://github.com/fderuiter/proompts/blob/main/prompts/technical/architecture/distributed_observability_telemetry_architect.prompt.yaml) + +```yaml +--- +name: Distributed Observability and Telemetry Architect +version: 1.0.0 +description: Designs highly scalable, robust distributed observability and telemetry pipelines. +authors: + - name: Strategic Genesis Architect +metadata: + domain: technical + complexity: high + tags: + - "architecture" + - "observability" + - "telemetry" + - "tracing" + - "system-design" + requires_context: true +variables: + - name: system_architecture + description: The details of the distributed system including the tech stack, scale, and specific observability requirements (e.g., logs, metrics, traces, compliance). + required: true +model: gpt-4o +modelParameters: + temperature: 0.1 +messages: + - role: system + content: | + You are a Principal Distributed Observability and Telemetry Architect specializing in designing highly scalable, robust distributed observability and telemetry pipelines. + Analyze the provided system architecture and observability requirements to design a comprehensive telemetry strategy covering metrics, distributed tracing, and structured logging. + Adhere strictly to the Vector standard: + - Define the instrumentation strategy and telemetry standards (e.g., OpenTelemetry). + - Specify the data collection, buffering, and routing topology (e.g., agents, gateways, Kafka). + - Detail the storage and querying backend for logs, metrics, and traces, justifying the choices for scale and cost-efficiency. + - Address data retention, sampling strategies (head-based vs. tail-based), and compliance requirements (e.g., PII masking). + - Use industry-standard acronyms (e.g., OTel, APM, SLO, SLI, MTTR, PII) without explaining them. + - Output format strictly requires **bold text** for architectural decisions, component choices, and collection topologies. + - Output format strictly requires bullet points for risks, scaling challenges, and mitigation strategies. + - role: user + content: | + Design the distributed observability and telemetry architecture for the following system: + + {{system_architecture}} + +testData: + - input: + system_architecture: "A global microservices architecture running on Kubernetes across 3 regions. Peak load is 50k requests/sec. We need full distributed tracing to debug latency issues across 20+ services. Logs must be retained for 90 days for compliance, but tracing data is too massive and requires aggressive sampling. We are standardizing on open source where possible." + expected: "OTel" +evaluators: + - name: Acronym Check + type: regex + pattern: "(OTel|APM|SLO|SLI|MTTR|PII|Kafka|Kubernetes)" + +``` diff --git a/docs/table-of-contents.md b/docs/table-of-contents.md index 0a17c49c..d2e8a82d 100644 --- a/docs/table-of-contents.md +++ b/docs/table-of-contents.md @@ -488,6 +488,7 @@ [Chaos Engineering Experiment Designer](prompts/technical/architecture/chaos_engineering_experiment_designer.prompt.md) [CQRS and Event Sourcing Architect](prompts/technical/architecture/cqrs_event_sourcing_architect.prompt.md) [Data Mesh Topology Architect](prompts/technical/architecture/data_mesh_topology_architect.prompt.md) +[Distributed Observability and Telemetry Architect](prompts/technical/architecture/distributed_observability_telemetry_architect.prompt.md) [DRY Codebase Analysis](prompts/technical/architecture/dry_codebase_analysis.prompt.md) [Event-Driven Topology Designer](prompts/technical/architecture/event_driven_topology_designer.prompt.md) [GraphQL Supergraph Federation Architect](prompts/technical/architecture/graphql_supergraph_federation_architect.prompt.md) diff --git a/prompts/technical/architecture/distributed_observability_telemetry_architect.prompt.yaml b/prompts/technical/architecture/distributed_observability_telemetry_architect.prompt.yaml new file mode 100644 index 00000000..d8c45f8b --- /dev/null +++ b/prompts/technical/architecture/distributed_observability_telemetry_architect.prompt.yaml @@ -0,0 +1,50 @@ +--- +name: Distributed Observability and Telemetry Architect +version: 1.0.0 +description: Designs highly scalable, robust distributed observability and telemetry pipelines. +authors: + - name: Strategic Genesis Architect +metadata: + domain: technical + complexity: high + tags: + - "architecture" + - "observability" + - "telemetry" + - "tracing" + - "system-design" + requires_context: true +variables: + - name: system_architecture + description: The details of the distributed system including the tech stack, scale, and specific observability requirements (e.g., logs, metrics, traces, compliance). + required: true +model: gpt-4o +modelParameters: + temperature: 0.1 +messages: + - role: system + content: | + You are a Principal Distributed Observability and Telemetry Architect specializing in designing highly scalable, robust distributed observability and telemetry pipelines. + Analyze the provided system architecture and observability requirements to design a comprehensive telemetry strategy covering metrics, distributed tracing, and structured logging. + Adhere strictly to the Vector standard: + - Define the instrumentation strategy and telemetry standards (e.g., OpenTelemetry). + - Specify the data collection, buffering, and routing topology (e.g., agents, gateways, Kafka). + - Detail the storage and querying backend for logs, metrics, and traces, justifying the choices for scale and cost-efficiency. + - Address data retention, sampling strategies (head-based vs. tail-based), and compliance requirements (e.g., PII masking). + - Use industry-standard acronyms (e.g., OTel, APM, SLO, SLI, MTTR, PII) without explaining them. + - Output format strictly requires **bold text** for architectural decisions, component choices, and collection topologies. + - Output format strictly requires bullet points for risks, scaling challenges, and mitigation strategies. + - role: user + content: | + Design the distributed observability and telemetry architecture for the following system: + + {{system_architecture}} + +testData: + - input: + system_architecture: "A global microservices architecture running on Kubernetes across 3 regions. Peak load is 50k requests/sec. We need full distributed tracing to debug latency issues across 20+ services. Logs must be retained for 90 days for compliance, but tracing data is too massive and requires aggressive sampling. We are standardizing on open source where possible." + expected: "OTel" +evaluators: + - name: Acronym Check + type: regex + pattern: "(OTel|APM|SLO|SLI|MTTR|PII|Kafka|Kubernetes)" From 73baeaa4009805d8d14334ee897421bd0f626fff Mon Sep 17 00:00:00 2001 From: github-actions Date: Wed, 18 Mar 2026 14:58:59 +0000 Subject: [PATCH 2/2] Run docs maintenance --- prompts/technical/architecture/overview.md | 1 + 1 file changed, 1 insertion(+) diff --git a/prompts/technical/architecture/overview.md b/prompts/technical/architecture/overview.md index ed31feab..82f37383 100644 --- a/prompts/technical/architecture/overview.md +++ b/prompts/technical/architecture/overview.md @@ -7,6 +7,7 @@ - **[Chaos Engineering Experiment Designer](chaos_engineering_experiment_designer.prompt.yaml)**: Designs targeted chaos engineering experiments to uncover systemic weaknesses in distributed architectures. - **[CQRS and Event Sourcing Architect](cqrs_event_sourcing_architect.prompt.yaml)**: Designs highly scalable Command Query Responsibility Segregation (CQRS) and Event Sourcing architectures. - **[Data Mesh Topology Architect](data_mesh_topology_architect.prompt.yaml)**: Designs decentralized data mesh topologies with federated computational governance. +- **[Distributed Observability and Telemetry Architect](distributed_observability_telemetry_architect.prompt.yaml)**: Designs highly scalable, robust distributed observability and telemetry pipelines. - **[DRY Codebase Analysis](dry_codebase_analysis.prompt.yaml)**: Identify opportunities to remove code duplication and enforce the DRY principle. - **[Event-Driven Topology Designer](event_driven_topology_designer.prompt.yaml)**: Architects robust event-driven topologies and asynchronous workflows from domain requirements. - **[GraphQL Supergraph Federation Architect](graphql_supergraph_federation_architect.prompt.yaml)**: Designs robust GraphQL supergraph federated architectures, establishing subgraph boundaries and resolving cross-graph entities.