From 178706ed4a0631b402320dcf2fe9f3ea2671cc71 Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Wed, 31 Mar 2021 10:38:58 +0530 Subject: [PATCH 01/15] Update glossary.md --- content/en/docs/concepts/glossary.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index eebd732b7445..b9699d7312ce 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -23,7 +23,7 @@ others. This page captures terminology used in the project and what it means. mechanism for propagating name/value pairs to help establish a causal relationship between events and services. - **Client Library:** See `Instrumented Library`. -- **[Collector](https://opentelemetry.io/docs/concepts/overview/#collector):** +- **[Collector](https://opentelemetry.io/docs/collector/):** A vendor-agnostic implementation on how to receive, process, and export telemetry data. A single binary that can be deployed as an agent or gateway. - **Contrib:** Several `Instrumentation Libraries` and the `Collector` offer a set @@ -50,7 +50,7 @@ others. This page captures terminology used in the project and what it means. [Instrumentation Libraries](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#exporter-library) and the - [Collector](https://opentelemetry.io/docs/collector/configuration/#exporters). + [Collector](https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/docs/collector/configuration.md#basics). Exporters can be push or pull based. - **[Field](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#field-kinds):** name/value pairs added to `Log Records` (similar to `Attributes` for `Spans` and From baa90e190a997fa1e1906779b4d0152fda4a5978 Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Wed, 31 Mar 2021 10:45:37 +0530 Subject: [PATCH 02/15] Update glossary.md --- content/en/docs/concepts/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index b9699d7312ce..1c25227b8b31 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -19,7 +19,7 @@ others. This page captures terminology used in the project and what it means. `Tracing` `Data Source`. - **[Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/common.md#attributes):** Used by the `Tracing` `Data Source` to attach name/value pairs to a `Span`. -- **[Baggage](https://opentelemetry.io/docs/concepts/overview/#baggage):** A +- **[Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#baggage-signal):** A mechanism for propagating name/value pairs to help establish a causal relationship between events and services. - **Client Library:** See `Instrumented Library`. From 923516b8b8246f8851656ad849f7081307df2aae Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Wed, 31 Mar 2021 10:47:24 +0530 Subject: [PATCH 03/15] Update glossary.md --- content/en/docs/concepts/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 1c25227b8b31..2d47860f7afe 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -30,7 +30,7 @@ others. This page captures terminology used in the project and what it means. of core capabilities as well as a dedicated contrib repository for non-core capabilities including vendor `Exporters`. - **[Context - Propagation](https://opentelemetry.io/docs/concepts/overview/#context-propagation):** + Propagation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#context-propagation):** Allows all `Data Sources` to share an underlying context mechanism for storing state and accessing data across the lifespan of a `Transaction`. - **[DAG](https://en.wikipedia.org/wiki/Directed_acyclic_graph):** Directed Acyclic Graph. From 82eaec664b72bb97e4efb81b67a0535e6193b033 Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Wed, 31 Mar 2021 10:48:46 +0530 Subject: [PATCH 04/15] Update glossary.md --- content/en/docs/concepts/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 2d47860f7afe..8862b59be886 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -35,7 +35,7 @@ others. This page captures terminology used in the project and what it means. state and accessing data across the lifespan of a `Transaction`. - **[DAG](https://en.wikipedia.org/wiki/Directed_acyclic_graph):** Directed Acyclic Graph. - **[Data - Source](https://opentelemetry.io/docs/concepts/overview/#data-sources):** One + Source](https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/docs/concepts/data-sources.md):** One of `Traces`, `Metrics` or `Logs`. - **Dimension:** See `Label`. - **[Distributed From db9ad807c4bad967bc2ca29955bfa5521a302b52 Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Sat, 3 Apr 2021 09:26:45 +0530 Subject: [PATCH 05/15] Update _index.md --- content/en/community/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/community/_index.md b/content/en/community/_index.md index 9789401dcc19..d62e04abc9d0 100644 --- a/content/en/community/_index.md +++ b/content/en/community/_index.md @@ -17,7 +17,7 @@ OpenTelemetry collaborates and integrates with other open-source projects includ {{% blocks/feature icon="far fa-building" title="Vendor Supported" url="/vendors"%}} Several cloud providers and observability vendors distribute or natively support OpenTelemetry. -{{% /blocks/feature %}} + {{% /blocks/section %}} From 61d74170de3374c10c24e22c1632d892bee55bab Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Sat, 3 Apr 2021 13:38:25 +0530 Subject: [PATCH 06/15] Update _index.md --- content/en/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/_index.md b/content/en/_index.md index ad6dbc7a7114..81abbf56aec9 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -8,7 +8,7 @@ title: "OpenTelemetry"

An observability framework for cloud-native software.

-

OpenTelemetry is a collection of tools, APIs, and SDKs. You use it to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) for analysis in order to understand your software's performance and behavior.

+

OpenTelemetry is a collection of tools, APIs, and SDKs. You can use it to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) for analysis in order to understand your software's performance and behavior.


From 6286c69e6e311ba6583883feac7caa6883089a69 Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Sat, 3 Apr 2021 13:39:48 +0530 Subject: [PATCH 07/15] Added logo --- content/en/community/_index.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/en/community/_index.md b/content/en/community/_index.md index d62e04abc9d0..35bf8e33aacd 100644 --- a/content/en/community/_index.md +++ b/content/en/community/_index.md @@ -1,8 +1,10 @@ --- -title: Community +title: "Community" +linkTitle: "Community" menu: main: weight: 40 + pre: --- {{% blocks/section color="dark" %}} @@ -17,7 +19,7 @@ OpenTelemetry collaborates and integrates with other open-source projects includ {{% blocks/feature icon="far fa-building" title="Vendor Supported" url="/vendors"%}} Several cloud providers and observability vendors distribute or natively support OpenTelemetry. - +{{% /blocks/feature %}} {{% /blocks/section %}} From e7a89a5017a00d51d842badf60d1c17bef22f5c7 Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Sat, 3 Apr 2021 13:42:51 +0530 Subject: [PATCH 08/15] Adde image alt text and logo --- content/en/docs/_index.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md index 799013c47493..6634ce4dab6b 100644 --- a/content/en/docs/_index.md +++ b/content/en/docs/_index.md @@ -1,5 +1,6 @@ --- title: "Documentation" + aliases: - /csharp/ - /csharp/metrics/ @@ -19,9 +20,11 @@ aliases: - /ruby/ - /ruby/metrics/ - /ruby/tracing/ + menu: main: weight: 10 + pre: --- OpenTelemetry is a set of APIs, SDKs, tooling and integrations that are @@ -30,7 +33,7 @@ metrics, and logs. The OpenTelemetry documentation is intended to broadly cover key terms, concepts, and instructions on how to use OpenTelemetry in your software. - +Implementation of the OpenTelemetry Reference Architecture OpenTelemetry provides an implementation of all of its components as well as a reference architecture. The project is flexible and extensible to support a From c8fd4b16561ed23133518021340fff8d90ad3fe0 Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Sat, 3 Apr 2021 13:44:11 +0530 Subject: [PATCH 09/15] Added alt text and content edit --- content/en/docs/collector/_index.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/content/en/docs/collector/_index.md b/content/en/docs/collector/_index.md index a5124918ac9c..2295cf5ec34f 100644 --- a/content/en/docs/collector/_index.md +++ b/content/en/docs/collector/_index.md @@ -3,23 +3,23 @@ title: "Collector" linkTitle: "Collector" weight: 10 description: > - + Collector logo Vendor-agnostic way to receive, process and export telemetry data --- - +Otel-Collector diagram with Jaeger, OTLP and Prometheus integration The OpenTelemetry Collector offers a vendor-agnostic implementation on how to receive, process and export telemetry data. It removes the need to run, -operate, and maintain multiple agents/collectors in order to support +operate, and maintain multiple agents/collectors. This works with improved scalability and supports open-source observability data formats (e.g. Jaeger, Prometheus, Fluent Bit, etc.) sending to one or more open-source or commercial back-ends. The Collector is the default location instrumentation libraries export their telemetry data. Objectives: -- Usable: Reasonable default configuration, supports popular protocols, runs and collects out of the box. -- Performant: Highly stable and performant under varying loads and configurations. -- Observable: An exemplar of an observable service. -- Extensible: Customizable without touching the core code. -- Unified: Single codebase, deployable as an agent or collector with support for traces, metrics, and logs (future). +- *Usability*: Reasonable default configuration, supports popular protocols, runs and collects out of the box. +- *Performance*: Highly stable and performant under varying loads and configurations. +- *Observability*: An exemplar of an observable service. +- *Extensibility*: Customizable without touching the core code. +- *Unification*: Single codebase, deployable as an agent or collector with support for traces, metrics, and logs (future). From e94a67a69366ca7ef67700e84a1c97fa5aae8b48 Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Sat, 3 Apr 2021 13:45:05 +0530 Subject: [PATCH 10/15] added alt text --- content/en/docs/erlang/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/erlang/_index.md b/content/en/docs/erlang/_index.md index 5dbb4c029833..7f4981b0e368 100644 --- a/content/en/docs/erlang/_index.md +++ b/content/en/docs/erlang/_index.md @@ -2,7 +2,7 @@ title: "Erlang/Elixir" weight: 14 description: > - + Erlang logo A language-specific implementation of OpenTelemetry in Erlang/Elixir. --- From 873c4047c853d809a637615d152e5d4ecccbf558 Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Sat, 3 Apr 2021 13:49:47 +0530 Subject: [PATCH 11/15] Added alt text --- content/en/docs/java/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/java/_index.md b/content/en/docs/java/_index.md index 235be913d1b3..b1fed23ec6f1 100644 --- a/content/en/docs/java/_index.md +++ b/content/en/docs/java/_index.md @@ -2,7 +2,7 @@ title: "Java" weight: 18 description: > - + Java logo A language-specific implementation of OpenTelemetry in Java. --- From 87e7b99d9b3810756d5927f5d3b6de94cda3e7ed Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Sat, 3 Apr 2021 13:50:36 +0530 Subject: [PATCH 12/15] added logo alt text --- content/en/docs/js/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/js/_index.md b/content/en/docs/js/_index.md index 8124c87cea24..fd55fc434f78 100644 --- a/content/en/docs/js/_index.md +++ b/content/en/docs/js/_index.md @@ -2,7 +2,7 @@ title: "Javascript" weight: 20 description: > - + JavaScript logo A language-specific implementation of OpenTelemetry in JavaScript (for Node.JS & the browser). --- From bd3573dfd6d55f7b7bb8e2b34d875e8acbed3cac Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Sat, 3 Apr 2021 13:52:16 +0530 Subject: [PATCH 13/15] Improved content --- content/en/docs/js/instrumentation_examples.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/js/instrumentation_examples.md b/content/en/docs/js/instrumentation_examples.md index 19b3c5535abf..dcff2984e9e2 100644 --- a/content/en/docs/js/instrumentation_examples.md +++ b/content/en/docs/js/instrumentation_examples.md @@ -3,7 +3,7 @@ title: "Instrumentation Examples" weight: 4 --- -Here are Some of the resources for Opentelemetry Instrumentation Examples +Here are some resources for Opentelemetry Instrumentation Examples ## Community Resources @@ -11,7 +11,7 @@ Here are Some of the resources for Opentelemetry Instrumentation Examples Project demonstrating Complete Observability Stack utilizing [Prometheus](https://prometheus.io/), [Loki](https://grafana.com/oss/loki/) (_For distributed logging_), [Tempo](https://grafana.com/oss/tempo/) (_For Distributed tracing, this basically uses Jaeger Internally_), [Grafana](https://grafana.com/grafana/) for **NodeJs** based applications (_With OpenTelemetry auto / manual Instrumentation_) involving microservices with DB interactions. -Checkout [nodejs-opentelemetry-tempo](https://github.com/mnadeem/nodejs-opentelemetry-tempo) and get started +Checkout [nodejs-opentelemetry-tempo](https://github.com/mnadeem/nodejs-opentelemetry-tempo) and get started! ````bash docker-compose up --build From 41e31f9428b3943659bab08128dd3c5e15de1b59 Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Sat, 3 Apr 2021 13:53:19 +0530 Subject: [PATCH 14/15] added alt text --- content/en/docs/net/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/net/_index.md b/content/en/docs/net/_index.md index 24a39bf0654b..0ba8c4643f2d 100644 --- a/content/en/docs/net/_index.md +++ b/content/en/docs/net/_index.md @@ -2,7 +2,7 @@ title: ".NET" weight: 12 description: > - + NET logo A language-specific implementation of OpenTelemetry in .NET. --- From 0dceae21de0d04100d826e3ee790e96ad22e1c92 Mon Sep 17 00:00:00 2001 From: Harshita Srinivas <60603854+harshita19244@users.noreply.github.com> Date: Sat, 3 Apr 2021 13:54:22 +0530 Subject: [PATCH 15/15] Added logo alt text --- content/en/docs/ruby/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/ruby/_index.md b/content/en/docs/ruby/_index.md index af25d76bbc46..e2c1a722f93b 100644 --- a/content/en/docs/ruby/_index.md +++ b/content/en/docs/ruby/_index.md @@ -2,7 +2,7 @@ title: "Ruby" weight: 24 description: > - + Ruby logo A language-specific implementation of OpenTelemetry in Ruby. ---