From fcc0b569041e394cf16716dd7e95d56ad99a706f Mon Sep 17 00:00:00 2001 From: Cijo Thomas Date: Mon, 30 Nov 2020 10:27:04 -0800 Subject: [PATCH] Readme updates (#1631) * Readme updates * typos * keep main readme simple * less verbose in getting started * length * Update docs/metrics/getting-started.md Co-authored-by: Reiley Yang * link fix * link fix Co-authored-by: Reiley Yang --- README.md | 6 ++++-- docs/metrics/getting-started.md | 3 +++ docs/trace/getting-started/README.md | 16 ++++++++++++++++ src/OpenTelemetry.Api/README.md | 3 ++- 4 files changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a4d94a6c4..2c4d9b3cc 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,10 @@ Framework](https://dotnet.microsoft.com/download/dotnet-framework) except for ## Getting Started -If you are new here, please see [get started in 5 -minutes](./docs/trace/getting-started/README.md). +If you are new here, please see getting started docs for +[logs](./docs/logs/getting-started/README.md), +[metrics](./docs/metrics/getting-started.md), and +[trace](./docs/trace/getting-started/README.md). This repository includes multiple installable components, available on [NuGet](https://www.nuget.org/profiles/OpenTelemetry). Each component has its diff --git a/docs/metrics/getting-started.md b/docs/metrics/getting-started.md index 6e6fb8feb..2b7597244 100644 --- a/docs/metrics/getting-started.md +++ b/docs/metrics/getting-started.md @@ -6,6 +6,9 @@ Metrics API and SDK is in alpha/experimental stage, and are not recommended for any production use. Both the API, and SDK implementation is subject to significant changes. +Please check the [Metric support +plan](https://github.com/open-telemetry/opentelemetry-dotnet/issues/1501). + ## Sample usage Check diff --git a/docs/trace/getting-started/README.md b/docs/trace/getting-started/README.md index 793471f24..1b5d48c52 100644 --- a/docs/trace/getting-started/README.md +++ b/docs/trace/getting-started/README.md @@ -56,3 +56,19 @@ An OpenTelemetry is configured to subscribe to the activities from the source `MyCompany.MyProduct.MyLibrary`, and export it to `ConsoleExporter`. `ConsoleExporter` simply displays it on the console. + +## OpenTelemetry .NET and relation with .NET Activity API + +If you tried the above program, you may have already noticed that the terms +`ActivitySource` and `Activity` were used instead of `Tracer` and `Span` from +OpenTelemetry specification. This results from the fact that, OpenTelemetry .NET +is a somewhat unique implementation of the OpenTelemetry project, as parts of +the tracing API are incorporated directly into the .NET runtime itself. From a +high level, what this means is that the `Activity` and `ActivitySource` classes +from .NET runtime represent the OpenTelemetry concepts of +[Span](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/api.md#span) +and +[Tracer](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/api.md#tracer) +respectively. Read +[this](../../../src/OpenTelemetry.Api/README.md#introduction-to-opentelemetry-net-tracing-api) +to learn more. diff --git a/src/OpenTelemetry.Api/README.md b/src/OpenTelemetry.Api/README.md index 551631997..28156b166 100644 --- a/src/OpenTelemetry.Api/README.md +++ b/src/OpenTelemetry.Api/README.md @@ -6,6 +6,7 @@ * [Installation](#installation) * [Introduction](#introduction) * [Tracing API](#tracing-api) + * [Logging API](#logging-api) * [Metrics API](#metrics-api) * [Introduction to OpenTelemetry .NET Tracing API](#introduction-to-opentelemetry-net-tracing-api) @@ -70,7 +71,7 @@ with the intent to produce continuous summaries of those measurements. _**Warning:** OpenTelemetry .NET has a prototype Metrics API implementation only and is not recommended for any production use. The API is expected to change -heavily._ +heavily. Please check the [Metric support plan](https://github.com/open-telemetry/opentelemetry-dotnet/issues/1501)._ ## Introduction to OpenTelemetry .NET Tracing API