From 82ba249c471071affe39cb6cb481f0343231473e Mon Sep 17 00:00:00 2001 From: Pavol Loffay Date: Fri, 17 May 2024 11:59:05 +0200 Subject: [PATCH] OTEL document empty objects Signed-off-by: Pavol Loffay --- modules/otel-collector-components.adoc | 12 +++++------ modules/otel-collector-config-options.adoc | 6 +++--- modules/otel-config-target-allocator.adoc | 2 +- modules/otel-install-cli.adoc | 12 +++++------ modules/otel-install-web-console.adoc | 14 ++++++------- ...l-migrating-from-jaeger-with-sidecars.adoc | 10 +++++----- ...igrating-from-jaeger-without-sidecars.adoc | 10 +++++----- ...etrics-to-otel-collector-with-sidecar.adoc | 6 +++--- ...ics-to-otel-collector-without-sidecar.adoc | 18 ++++++++--------- .../otel/otel-config-multicluster.adoc | 20 +++++++++---------- observability/otel/otel-forwarding.adoc | 20 +++++++++---------- 11 files changed, 65 insertions(+), 65 deletions(-) diff --git a/modules/otel-collector-components.adoc b/modules/otel-collector-components.adoc index 0d994d56f61b..9f5ec518ef6e 100644 --- a/modules/otel-collector-components.adoc +++ b/modules/otel-collector-components.adoc @@ -1557,7 +1557,7 @@ This extension supports traces, metrics, and logs. receivers: otlp: protocols: - http: + http: {} exporters: otlp: @@ -1689,7 +1689,7 @@ The Jaeger Remote Sampling Extension enables serving sampling strategies after J receivers: otlp: protocols: - http: + http: {} exporters: otlp: @@ -1774,7 +1774,7 @@ The Performance Profiler Extension enables the Go `net/http/pprof` endpoint. Dev receivers: otlp: protocols: - http: + http: {} exporters: otlp: @@ -1818,7 +1818,7 @@ The Health Check Extension provides an HTTP URL for checking the status of the O receivers: otlp: protocols: - http: + http: {} exporters: otlp: @@ -1857,7 +1857,7 @@ The Memory Ballast Extension enables applications to configure memory ballast fo receivers: otlp: protocols: - http: + http: {} exporters: otlp: @@ -1893,7 +1893,7 @@ zPages are useful for in-process diagnostics without having to depend on a back receivers: otlp: protocols: - http: + http: {} exporters: otlp: diff --git a/modules/otel-collector-config-options.adoc b/modules/otel-collector-config-options.adoc index ec2e9119305d..c456d6683d6c 100644 --- a/modules/otel-collector-config-options.adoc +++ b/modules/otel-collector-config-options.adoc @@ -37,9 +37,9 @@ spec: receivers: otlp: protocols: - grpc: - http: - processors: + grpc: {} + http: {} + processors: {} exporters: otlp: endpoint: jaeger-production-collector-headless.tracing-system.svc:4317 diff --git a/modules/otel-config-target-allocator.adoc b/modules/otel-config-target-allocator.adoc index c5fac3ab7b1c..1a3b5b9c758c 100644 --- a/modules/otel-config-target-allocator.adoc +++ b/modules/otel-config-target-allocator.adoc @@ -38,7 +38,7 @@ spec: scrape_configs: [] processors: exporters: - debug: + debug: {} service: pipelines: metrics: diff --git a/modules/otel-install-cli.adoc b/modules/otel-install-cli.adoc index b45bda5046b4..ee7d18327ddc 100644 --- a/modules/otel-install-cli.adoc +++ b/modules/otel-install-cli.adoc @@ -131,19 +131,19 @@ spec: http: jaeger: protocols: - grpc: - thrift_binary: - thrift_compact: - thrift_http: + grpc: {} + thrift_binary: {} + thrift_compact: {} + thrift_http: {} zipkin: processors: - batch: + batch: {} memory_limiter: check_interval: 1s limit_percentage: 50 spike_limit_percentage: 30 exporters: - debug: + debug: {} service: pipelines: traces: diff --git a/modules/otel-install-web-console.adoc b/modules/otel-install-web-console.adoc index 584fdbdb8a82..9732dd1d075e 100644 --- a/modules/otel-install-web-console.adoc +++ b/modules/otel-install-web-console.adoc @@ -61,19 +61,19 @@ spec: http: jaeger: protocols: - grpc: - thrift_binary: - thrift_compact: - thrift_http: - zipkin: + grpc: {} + thrift_binary: {} + thrift_compact: {} + thrift_http: {} + zipkin: {} processors: - batch: + batch: {} memory_limiter: check_interval: 1s limit_percentage: 50 spike_limit_percentage: 30 exporters: - debug: + debug: {} service: pipelines: traces: diff --git a/modules/otel-migrating-from-jaeger-with-sidecars.adoc b/modules/otel-migrating-from-jaeger-with-sidecars.adoc index 4910bba09661..e43afd16a584 100644 --- a/modules/otel-migrating-from-jaeger-with-sidecars.adoc +++ b/modules/otel-migrating-from-jaeger-with-sidecars.adoc @@ -30,12 +30,12 @@ spec: receivers: jaeger: protocols: - grpc: - thrift_binary: - thrift_compact: - thrift_http: + grpc: {} + thrift_binary: {} + thrift_compact: {} + thrift_http: {} processors: - batch: + batch: {} memory_limiter: check_interval: 1s limit_percentage: 50 diff --git a/modules/otel-migrating-from-jaeger-without-sidecars.adoc b/modules/otel-migrating-from-jaeger-without-sidecars.adoc index 5cc7841e20f2..32816326d993 100644 --- a/modules/otel-migrating-from-jaeger-without-sidecars.adoc +++ b/modules/otel-migrating-from-jaeger-without-sidecars.adoc @@ -95,12 +95,12 @@ spec: receivers: jaeger: protocols: - grpc: - thrift_binary: - thrift_compact: - thrift_http: + grpc: {} + thrift_binary: {} + thrift_compact: {} + thrift_http: {} processors: - batch: + batch: {} k8sattributes: memory_limiter: check_interval: 1s diff --git a/modules/otel-send-traces-and-metrics-to-otel-collector-with-sidecar.adoc b/modules/otel-send-traces-and-metrics-to-otel-collector-with-sidecar.adoc index 8d54e7037c91..c8a7e630af2b 100644 --- a/modules/otel-send-traces-and-metrics-to-otel-collector-with-sidecar.adoc +++ b/modules/otel-send-traces-and-metrics-to-otel-collector-with-sidecar.adoc @@ -89,10 +89,10 @@ spec: receivers: otlp: protocols: - grpc: - http: + grpc: {} + http: {} processors: - batch: + batch: {} memory_limiter: check_interval: 1s limit_percentage: 50 diff --git a/modules/otel-send-traces-and-metrics-to-otel-collector-without-sidecar.adoc b/modules/otel-send-traces-and-metrics-to-otel-collector-without-sidecar.adoc index 8dd9cd25e0fc..f4d01ae3a735 100644 --- a/modules/otel-send-traces-and-metrics-to-otel-collector-without-sidecar.adoc +++ b/modules/otel-send-traces-and-metrics-to-otel-collector-without-sidecar.adoc @@ -86,19 +86,19 @@ spec: receivers: jaeger: protocols: - grpc: - thrift_binary: - thrift_compact: - thrift_http: + grpc: {} + thrift_binary: {} + thrift_compact: {} + thrift_http: {} opencensus: otlp: protocols: - grpc: - http: - zipkin: + grpc: {} + http: {} + zipkin: {} processors: - batch: - k8sattributes: + batch: {} + k8sattributes: {} memory_limiter: check_interval: 1s limit_percentage: 50 diff --git a/observability/otel/otel-config-multicluster.adoc b/observability/otel/otel-config-multicluster.adoc index d66a19674846..735a1c34d5e2 100644 --- a/observability/otel/otel-config-multicluster.adoc +++ b/observability/otel/otel-config-multicluster.adoc @@ -171,19 +171,19 @@ spec: receivers: jaeger: protocols: - grpc: - thrift_binary: - thrift_compact: - thrift_http: + grpc: {} + thrift_binary: {} + thrift_compact: {} + thrift_http: {} opencensus: otlp: protocols: - grpc: - http: - zipkin: + grpc: {} + http: {} + zipkin: {} processors: - batch: - k8sattributes: + batch: {} + k8sattributes: {} memory_limiter: check_interval: 1s limit_percentage: 50 @@ -240,7 +240,7 @@ spec: key_file: /certs/server.key client_ca_file: /certs/ca.crt exporters: - logging: + logging: {} otlp: endpoint: "tempo--distributor:4317" # <2> tls: diff --git a/observability/otel/otel-forwarding.adoc b/observability/otel/otel-forwarding.adoc index 9f528f827e78..d5b0eb837a74 100644 --- a/observability/otel/otel-forwarding.adoc +++ b/observability/otel/otel-forwarding.adoc @@ -79,19 +79,19 @@ spec: receivers: jaeger: protocols: - grpc: - thrift_binary: - thrift_compact: - thrift_http: - opencensus: + grpc: {} + thrift_binary: {} + thrift_compact: {} + thrift_http: {} + opencensus: {} otlp: protocols: - grpc: - http: - zipkin: + grpc: {} + http: {} + zipkin: {} processors: - batch: - k8sattributes: + batch: {} + k8sattributes: {} memory_limiter: check_interval: 1s limit_percentage: 50