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.


diff --git a/content/en/community/_index.md b/content/en/community/_index.md index 9789401dcc19..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" %}} 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 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). diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index eebd732b7445..8862b59be886 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -19,23 +19,23 @@ 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`. -- **[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 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. - **[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 @@ -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 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. --- 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. --- 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). --- 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 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. --- 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. ---