From 84c9743603b1bf1a5564a0d3fba4d1d48874771b Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Mon, 20 Feb 2023 11:03:39 -0500 Subject: [PATCH] Relocate non-icon images from iconography (#2367) --- content/en/docs/collector/_index.md | 2 +- .../en/docs/collector/img/otel-collector.svg | 0 .../index.md} | 11 +- .../instrumenting-library/nested-spans.svg | 0 iconography/Reference_Architecture.svg | 177 ------------------ 5 files changed, 6 insertions(+), 184 deletions(-) rename iconography/Otel_Collector.svg => content/en/docs/collector/img/otel-collector.svg (100%) rename content/en/docs/concepts/{instrumenting-library.md => instrumenting-library/index.md} (97%) rename iconography/Instrumenting_Library_nested_spans.svg => content/en/docs/concepts/instrumenting-library/nested-spans.svg (100%) delete mode 100644 iconography/Reference_Architecture.svg diff --git a/content/en/docs/collector/_index.md b/content/en/docs/collector/_index.md index d7c766681c16..54b649dcf02c 100644 --- a/content/en/docs/collector/_index.md +++ b/content/en/docs/collector/_index.md @@ -8,7 +8,7 @@ cascade: weight: 10 --- -![OpenTelemetry Collector diagram with Jaeger, OTLP and Prometheus integration](https://raw.githubusercontent.com/open-telemetry/opentelemetry.io/main/iconography/Otel_Collector.svg) +![OpenTelemetry Collector diagram with Jaeger, OTLP and Prometheus integration](img/otel-collector.svg) ## Introduction diff --git a/iconography/Otel_Collector.svg b/content/en/docs/collector/img/otel-collector.svg similarity index 100% rename from iconography/Otel_Collector.svg rename to content/en/docs/collector/img/otel-collector.svg diff --git a/content/en/docs/concepts/instrumenting-library.md b/content/en/docs/concepts/instrumenting-library/index.md similarity index 97% rename from content/en/docs/concepts/instrumenting-library.md rename to content/en/docs/concepts/instrumenting-library/index.md index 01878429f6ab..704e05c644c8 100644 --- a/content/en/docs/concepts/instrumenting-library.md +++ b/content/en/docs/concepts/instrumenting-library/index.md @@ -1,7 +1,6 @@ --- -title: "Instrumenting libraries" -description: >- - Learn how to add native instrumentation to your library +title: Instrumenting libraries +description: Learn how to add native instrumentation to your library weight: 40 --- @@ -125,8 +124,6 @@ issues. ## What to instrument -![Nested database and HTTP spans in Jaeger UI](https://raw.githubusercontent.com/open-telemetry/opentelemetry.io/main/iconography/Instrumenting_Library_nested_spans.svg) - ### Public APIs Public APIs are a good candidates for tracing: spans created for public API @@ -172,13 +169,15 @@ private Response selectWithTracing(Query query) { Follow conventions to populate attributes! If there is no applicable one, check out [general -conventions]({{< relref "/docs/reference/specification/trace/semantic_conventions/span-general" >}}). +conventions](/docs/reference/specification/trace/semantic_conventions/span-general/). ### Nested network and other spans Network calls are usually traced with OpenTelemetry auto-instrumentations through corresponding client implementation. +![Nested database and HTTP spans in Jaeger UI](nested-spans.svg) + If OpenTelemetry does not support tracing your network client, use your best judgement, here are some considerations to help: diff --git a/iconography/Instrumenting_Library_nested_spans.svg b/content/en/docs/concepts/instrumenting-library/nested-spans.svg similarity index 100% rename from iconography/Instrumenting_Library_nested_spans.svg rename to content/en/docs/concepts/instrumenting-library/nested-spans.svg diff --git a/iconography/Reference_Architecture.svg b/iconography/Reference_Architecture.svg deleted file mode 100644 index c58e7ee55643..000000000000 --- a/iconography/Reference_Architecture.svg +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -