From bdf5ea35471fed39f3f6fd434b742df79e2686d6 Mon Sep 17 00:00:00 2001 From: Cijo Thomas Date: Fri, 30 Oct 2020 07:22:02 -0700 Subject: [PATCH] Add note that metrics api is alpha (#1426) * Add note that metrics api is alpha * fix doc isue * link fix * link * fix lint --- docs/metrics/getting-started.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/metrics/getting-started.md b/docs/metrics/getting-started.md index 156566172..6e6fb8feb 100644 --- a/docs/metrics/getting-started.md +++ b/docs/metrics/getting-started.md @@ -1,3 +1,14 @@ -# Getting Started with OpenTelemetry .NET in 5 Minutes +# Getting Started with OpenTelemetry .NET for Metrics in 5 Minutes -Under construction. +## IMPORTANT NOTE + +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. + +## Sample usage + +Check +[TestPrometheusExporter.cs](../../examples/Console/TestPrometheusExporter.cs) +for an example usage of currently implemented Metrics API/SDK along with +Prometheus exporter.