Merge branch 'main' into identical-inst

open-telemetry · Jul 12, 2023 · 60b3b2a · 60b3b2a
2 parents 6873fab + 9206132
commit 60b3b2a
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 13 deletions.
diff --git a/.markdown_link_check_config.json b/.markdown_link_check_config.json
@@ -6,8 +6,12 @@
   ],
   "replacementPatterns": [
     {
-        "pattern": "^/",
-        "replacement": "{{BASEURL}}/"
+      "pattern": "^/",
+      "replacement": "{{BASEURL}}/"
+    },
+    {
+      "pattern": "^https://github.com/open-telemetry/opentelemetry-specification/(blob|tree)/[^/]+/(specification|supplementary-guidelines)/",
+      "replacement": "LINK-CHECK-ERROR-USE-LOCAL-PATH-TO-DOC-PAGE-NOT-EXTERNAL-URL/"
     }
   ],
   "retryOn429": true,

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -40,6 +40,7 @@ release.
 
 - Prometheus: Do not add `_total` suffix if the metric already ends in `_total`.
   ([#3581](https://github.com/open-telemetry/opentelemetry-specification/pull/3581))
+- Prometheus type and unit suffixes are not trimmed by default. ([#3580](https://github.com/open-telemetry/opentelemetry-specification/pull/3580))
 
 ### OpenTelemetry Protocol
 
@@ -1704,7 +1705,7 @@ Added telemetry schemas documents to the specification ([#2008](https://github.c
 - Implementations can ignore links with invalid SpanContext([#1492](https://github.com/open-telemetry/opentelemetry-specification/pull/1492))
 - Add `none` as a possible value for OTEL_TRACES_EXPORTER to disable export
   ([#1439](https://github.com/open-telemetry/opentelemetry-specification/pull/1439))
-- Add [`ForceFlush`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#forceflush) to SDK's `TracerProvider` ([#1452](https://github.com/open-telemetry/opentelemetry-specification/pull/1452))
+- Add [`ForceFlush`](/specification/trace/sdk.md#forceflush) to SDK's `TracerProvider` ([#1452](https://github.com/open-telemetry/opentelemetry-specification/pull/1452))
 
 ### Metrics
 

diff --git a/specification/common/README.md b/specification/common/README.md
@@ -1,6 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 aliases: [/docs/reference/specification/common/common]
 --->
+
 # Common specification concepts
 
 **Status**: [Stable, Feature-freeze](../document-status.md)

diff --git a/specification/compatibility/opencensus.md b/specification/compatibility/opencensus.md
@@ -1,3 +1,7 @@
+<!--- Hugo front matter used to generate the website version of this page:
+linkTitle: OpenCensus
+--->
+
 # OpenCensus Compatibility
 
 **Status**: [Stable](../document-status.md), Unless otherwise specified.

diff --git a/specification/compatibility/opentracing.md b/specification/compatibility/opentracing.md
@@ -1,3 +1,7 @@
+<!--- Hugo front matter used to generate the website version of this page:
+linkTitle: OpenTracing
+--->
+
 # OpenTracing Compatibility
 
 **Status**: [Stable](../document-status.md).

diff --git a/specification/compatibility/prometheus_and_openmetrics.md b/specification/compatibility/prometheus_and_openmetrics.md
@@ -1,3 +1,10 @@
+<!--- Hugo front matter used to generate the website version of this page:
+linkTitle: Prometheus and OpenMetrics
+aliases:
+  - /docs/reference/specification/compatibility/openmetrics
+  - /docs/specs/otel/compatibility/openmetrics
+--->
+
 # Prometheus and OpenMetrics Compatibility
 
 **Status**: [Experimental](../document-status.md)
@@ -48,13 +55,10 @@ OpenTelemetry metric data. Since OpenMetrics has a superset of Prometheus' types
 ### Metric Metadata
 
 The [OpenMetrics MetricFamily Name](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#metricfamily)
-MUST be added as the Name of the OTLP metric after the removal of unit and type
-suffixes described below.
+MUST be added as the Name of the OTLP metric.  By default, the name MUST be unaltered, but translation SHOULD provide configuration which, when enabled, removes type (e.g. `_total`) and unit (e.g. `_seconds`) suffixes.
 
 The [OpenMetrics UNIT metadata](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#metricfamily),
-if present, MUST be converted to the unit of the OTLP metric.  After trimming
-type-specific suffixes, such as `_total` for counters, the unit MUST be trimmed
-from the suffix as well, if the metric suffix matches the unit. The unit SHOULD
+if present, MUST be converted to the unit of the OTLP metric.  The unit SHOULD
 be translated from Prometheus conventions to OpenTelemetry conventions by:
 
 * Converting from full words to abbreviations (e.g. "milliseconds" to "ms").
@@ -71,15 +75,15 @@ metadata follow rules for [unknown-typed](#unknown-typed) metrics below.
 
 ### Counters
 
-A [Prometheus Counter](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#counter) MUST be converted to an OTLP Sum with `is_monotonic` equal to `true`.  If the counter has a `_total` suffix, it MUST be removed.
+A [Prometheus Counter](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#counter) MUST be converted to an OTLP Sum with `is_monotonic` equal to `true`.
 
 ### Gauges
 
 A [Prometheus Gauge](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#gauge) MUST be converted to an OTLP Gauge.
 
 ### Info
 
-An [OpenMetrics Info](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#info) metric MUST be converted to an OTLP Non-Monotonic Sum unless it is the target_info metric, which is used to populate [resource attributes](#resource-attributes). An OpenMetrics Info can be thought of as a special-case of the OpenMetrics Gauge which has a value of 1, and whose labels generally stays constant over the life of the process. It is converted to a Non-Monotonic Sum, rather than a Gauge, because the value of 1 is intended to be viewed as a count, which should be summed together when aggregating away labels.  If it has an `_info` suffix, the suffix MUST be removed from the metric name.
+An [OpenMetrics Info](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#info) metric MUST be converted to an OTLP Non-Monotonic Sum unless it is the target_info metric, which is used to populate [resource attributes](#resource-attributes). An OpenMetrics Info can be thought of as a special-case of the OpenMetrics Gauge which has a value of 1, and whose labels generally stays constant over the life of the process. It is converted to a Non-Monotonic Sum, rather than a Gauge, because the value of 1 is intended to be viewed as a count, which should be summed together when aggregating away labels.
 
 ### StateSet
 

diff --git a/specification/configuration/sdk-environment-variables.md b/specification/configuration/sdk-environment-variables.md
@@ -1,7 +1,9 @@
 <!--- Hugo front matter used to generate the website version of this page:
 title: Environment Variable Specification
 linkTitle: Env var
-aliases: [/docs/reference/specification/sdk-environment-variables]
+aliases:
+  - /docs/reference/specification/sdk-environment-variables
+  - /docs/specs/otel/sdk-environment-variables
 --->
 
 # OpenTelemetry Environment Variable Specification

diff --git a/specification/context/README.md b/specification/context/README.md
@@ -1,6 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 aliases: [/docs/reference/specification/context/context]
 --->
+
 # Context
 
 **Status**: [Stable, Feature-freeze](../document-status.md).

diff --git a/specification/logs/noop.md b/specification/logs/noop.md
@@ -1,5 +1,5 @@
 <!--- Hugo front matter used to generate the website version of this page:
-linkTitle: noop
+linkTitle: No-Op
 --->
 
 # Logs Bridge API No-Op Implementation

diff --git a/specification/metrics/noop.md b/specification/metrics/noop.md
@@ -1,5 +1,5 @@
 <!--- Hugo front matter used to generate the website version of this page:
-linkTitle: noop
+linkTitle: No-Op
 --->
 
 # Metrics No-Op API Implementation