Add lifecycle statues to all documents

open-telemetry · Jan 28, 2021 · d6814a6 · d6814a6
1 parent ae31114
commit d6814a6
Show file tree

Hide file tree

Showing 44 changed files with 96 additions and 6 deletions.
diff --git a/specification/baggage/api.md b/specification/baggage/api.md
@@ -1,6 +1,6 @@
 # Baggage API
 
-**Status**: [Feature-freeze](../document-status.md).
+**Status**: [Stable, Feature-freeze](../document-status.md)
 
 <details>
 <summary>

diff --git a/specification/common/attribute-and-label-naming.md b/specification/common/attribute-and-label-naming.md
@@ -1,5 +1,7 @@
 # Attribute and Label Naming
 
+**Status**: [Experimental](../document-status.md)
+
 <details>
 <summary>
 Table of Contents

diff --git a/specification/common/common.md b/specification/common/common.md
@@ -1,6 +1,6 @@
 # Common specification concepts
 
-**Status**: [Feature-freeze](../document-status.md).
+**Status**: [Stable, Feature-freeze](../document-status.md)
 
 <details>
 <summary>

diff --git a/specification/context/api-propagators.md b/specification/context/api-propagators.md
@@ -1,5 +1,7 @@
 # Propagators API
 
+**Status**: [Stable, Feature-Freeze](../document-status.md)
+
 <details>
 <summary>
 Table of Contents

diff --git a/specification/context/context.md b/specification/context/context.md
@@ -1,6 +1,6 @@
 # Context
 
-**Status**: [Feature-freeze](../document-status.md).
+**Status**: [Stable, Feature-freeze](../document-status.md).
 
 <details>
 <summary>

diff --git a/specification/document-status.md b/specification/document-status.md
@@ -5,7 +5,19 @@ shown immediately after the document title. When present, the "Status" applies
 to the individual document only and not to the entire specification or any other
 documents. The following table describes what the statuses mean.
 
+## Lifecycle status
+
+The support guarantees and allowed changes are governed by the lifecycle of the document.Lifecycle stages are defined in the [Versioning and Stability](versioning-and-stability.md) document.
+
 |Status              |Explanation|
 |--------------------|-----------|
-|No explicit "Status"|Working draft, can change any time.|
-|Feature-freeze      |Document is no longer accepting new substantial changes, except when such changes are necessary to resolve a fundamental problem or inconsistency in the specification. Editorial changes are accepted. The document and the area it describes are considered feature-complete for the version of the specification the document targets. The document in this status is ready for implementation.|
+|No explicit "Status"|Equivalent to Experimental.|
+|Experimental        |Breaking changes are allowed.|
+|Stable              |Breaking changes are not longer allowed. See [stability guarantees](versioning-and-stability.md#stable) for details.|
+|Deprecated          |Changes are no longer allowed, except for editorial changes.|
+
+## Feature freeze
+
+In addition to the statuses above, documents may be marked as `Feature-freeze`. These documents are not currently accepting new feature requests, to allow the Technical Committee time to focus on other areas of the specification. Editorial changes are still accepted. Changes that address production issues with existing features are still accepted.
+
+Feature freeze is separate from a lifecycle status. The lifecycle represents the support requirements for the document, feature freeze only indicates the current focus of the specification community. The feature freeze label may be applied to a document at any lifecycle stage. By definition, deprecated documents have a feature freeze in place.
diff --git a/specification/logs/data-model.md b/specification/logs/data-model.md
@@ -1,5 +1,7 @@
 # Log Data Model
 
+**Status**: [Experimental](../document-status.md)
+
 * [Design Notes](#design-notes)
   * [Requirements](#requirements)
   * [Field Kinds](#field-kinds)

diff --git a/specification/logs/overview.md b/specification/logs/overview.md
@@ -1,5 +1,7 @@
 # OpenTelemetry Logging Overview
 
+**Status**: [Experimental](../document-status.md)
+
 * [Introduction](#introduction)
 * [Limitations of non-OpenTelemetry Solutions](#limitations-of-non-opentelemetry-solutions)
 * [OpenTelemetry Solution](#opentelemetry-solution)

diff --git a/specification/metrics/api.md b/specification/metrics/api.md
@@ -1,5 +1,7 @@
 # Metrics API
 
+**Status**: [Experimental](../document-status.md)
+
 <!-- toc -->
 
 - [Overview](#overview)

diff --git a/specification/metrics/sdk.md b/specification/metrics/sdk.md
@@ -1,5 +1,7 @@
 # Metrics SDK
 
+**Status**: [Experimental](../document-status.md)
+
 TODO: TOC
 
 ## Purpose

diff --git a/specification/metrics/semantic_conventions/README.md b/specification/metrics/semantic_conventions/README.md
@@ -1,5 +1,7 @@
 # Metrics Semantic Conventions
 
+**Status**: [Experimental](../document-status.md)
+
 <!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
 
 <!-- toc -->

diff --git a/specification/metrics/semantic_conventions/http-metrics.md b/specification/metrics/semantic_conventions/http-metrics.md
@@ -1,5 +1,7 @@
 # General
 
+**Status**: [Experimental](../document-status.md)
+
 The conventions described in this section are HTTP specific. When HTTP operations occur,
 metric events about those operations will be generated and reported to provide insight into the
 operations. By adding HTTP labels to metric events it allows for finely tuned filtering.

diff --git a/specification/metrics/semantic_conventions/openmetrics-guidelines.md b/specification/metrics/semantic_conventions/openmetrics-guidelines.md
@@ -1,5 +1,7 @@
 # Guidance for Interoperating with OpenMetrics
 
+**Status**: [Experimental](../document-status.md)
+
 **Note:** This document is work in progress and will be updated as the
 OpenMetrics specification further develops.
 

diff --git a/specification/metrics/semantic_conventions/process-metrics.md b/specification/metrics/semantic_conventions/process-metrics.md
@@ -1,5 +1,7 @@
 # Semantic Conventions for OS Process Metrics
 
+**Status**: [Experimental](../document-status.md)
+
 This document describes instruments and labels for common OS process level
 metrics in OpenTelemetry. Also consider the [general metric semantic
 conventions](README.md#general-metric-semantic-conventions) when creating

diff --git a/specification/metrics/semantic_conventions/rpc.md b/specification/metrics/semantic_conventions/rpc.md
@@ -1,5 +1,7 @@
 # General RPC conventions
 
+**Status**: [Experimental](../document-status.md)
+
 The conventions described in this section are RPC specific. When RPC operations
 occur, metric events about those operations will be generated and reported to
 provide insight into those operations. By adding RPC labels to metric events

diff --git a/specification/metrics/semantic_conventions/runtime-environment-metrics.md b/specification/metrics/semantic_conventions/runtime-environment-metrics.md
@@ -1,5 +1,7 @@
 # Semantic Conventions for Runtime Environment Metrics
 
+**Status**: [Experimental](../document-status.md)
+
 This document includes semantic conventions for runtime environment level
 metrics in OpenTelemetry. Also consider the [general
 metric](README.md#general-metric-semantic-conventions), [system

diff --git a/specification/metrics/semantic_conventions/system-metrics.md b/specification/metrics/semantic_conventions/system-metrics.md
@@ -1,5 +1,7 @@
 # Semantic Conventions for System Metrics
 
+**Status**: [Experimental](../document-status.md)
+
 This document describes instruments and labels for common system level
 metrics in OpenTelemetry. Consider the [general metric semantic
 conventions](README.md#general-metric-semantic-conventions) when creating

diff --git a/specification/protocol/exporter.md b/specification/protocol/exporter.md
@@ -1,5 +1,7 @@
 # OpenTelemetry Protocol Exporter
 
+**Status**: [Stable](../document-status.md)
+
 This document specifies the configuration options available to the OpenTelemetry Protocol ([OTLP](https://github.com/open-telemetry/oteps/blob/main/text/0035-opentelemetry-protocol.md)) Exporter as well as the retry behavior.
 
 ## Configuration Options

diff --git a/specification/protocol/otlp.md b/specification/protocol/otlp.md
@@ -1,5 +1,7 @@
 # OpenTelemetry Protocol Specification
 
+**Status**: [Stable](../document-status.md)
+
 OpenTelemetry Protocol (OTLP) specification describes the encoding, transport,
 and delivery mechanism of telemetry data between telemetry sources, intermediate
 nodes such as collectors and telemetry backends.

diff --git a/specification/resource/sdk.md b/specification/resource/sdk.md
@@ -1,5 +1,7 @@
 # Resource SDK
 
+**Status**: [Stable](../document-status.md)
+
 A [Resource](../overview.md#resources) is an immutable representation of the entity producing
 telemetry as [Attributes](../common/common.md#attributes).
 For example, a process producing telemetry that is running in a

diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md
@@ -1,5 +1,7 @@
 # Resource Semantic Conventions
 
+**Status**: [Experimental](../document-status.md)
+
 This document defines standard attributes for resources. These attributes are typically used in the [Resource](../sdk.md) and are also recommended to be used anywhere else where there is a need to describe a resource in a consistent manner. The majority of these attributes are inherited from
 [OpenCensus Resource standard](https://github.com/census-instrumentation/opencensus-specs/blob/master/resource/StandardResources.md).
 

diff --git a/specification/resource/semantic_conventions/cloud.md b/specification/resource/semantic_conventions/cloud.md
@@ -1,5 +1,7 @@
 # Cloud
 
+**Status**: [Experimental](../document-status.md)
+
 **type:** `cloud`
 
 **Description:** A cloud infrastructure (e.g. GCP, Azure, AWS).

diff --git a/specification/resource/semantic_conventions/cloud_provider/aws/README.md b/specification/resource/semantic_conventions/cloud_provider/aws/README.md
@@ -1,5 +1,7 @@
 # AWS Semantic Conventions
 
+**Status**: [Experimental](../document-status.md)
+
 This directory defines standards for resource attributes that only apply to Amazon
 Web Services (AWS) resources. If an attribute could apply to resources from more than one cloud
 provider (like account ID, operating system, etc), it belongs in the parent

diff --git a/specification/resource/semantic_conventions/cloud_provider/aws/ecs.md b/specification/resource/semantic_conventions/cloud_provider/aws/ecs.md
@@ -1,5 +1,7 @@
 # AWS ECS
 
+**Status**: [Experimental](../document-status.md)
+
 **type:** `aws.ecs`
 
 **Description:** Resources used by AWS Elastic Container Service (ECS).

diff --git a/specification/resource/semantic_conventions/cloud_provider/aws/logs.md b/specification/resource/semantic_conventions/cloud_provider/aws/logs.md
@@ -1,5 +1,7 @@
 # AWS Logs
 
+**Status**: [Experimental](../document-status.md)
+
 **Type:** `aws.log`
 
 **Description:** Log attributes for Amazon Web Services.

diff --git a/specification/resource/semantic_conventions/container.md b/specification/resource/semantic_conventions/container.md
@@ -1,5 +1,7 @@
 # Container
 
+**Status**: [Experimental](../document-status.md)
+
 **type:** `container`
 
 **Description:** A container instance.

diff --git a/specification/resource/semantic_conventions/deployment_environment.md b/specification/resource/semantic_conventions/deployment_environment.md
@@ -1,5 +1,7 @@
 # Deployment
 
+**Status**: [Experimental](../document-status.md)
+
 **type:** `deployment`
 
 **Description:** The software deployment.

diff --git a/specification/resource/semantic_conventions/faas.md b/specification/resource/semantic_conventions/faas.md
@@ -1,5 +1,7 @@
 # Function as a Service
 
+**Status**: [Experimental](../document-status.md)
+
 **type:** `faas`
 
 **Description:** A serverless instance.

diff --git a/specification/resource/semantic_conventions/host.md b/specification/resource/semantic_conventions/host.md
@@ -1,5 +1,7 @@
 # Host
 
+**Status**: [Experimental](../document-status.md)
+
 **type:** `host`
 
 **Description:** A host is defined as a general computing instance.

diff --git a/specification/resource/semantic_conventions/k8s.md b/specification/resource/semantic_conventions/k8s.md
@@ -1,5 +1,7 @@
 # Kubernetes
 
+**Status**: [Experimental](../document-status.md)
+
 Useful resources to understand Kubernetes objects and metadata:
 
 * [Namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)

diff --git a/specification/resource/semantic_conventions/os.md b/specification/resource/semantic_conventions/os.md
@@ -1,5 +1,7 @@
 # Operating System
 
+**Status**: [Experimental](../document-status.md)
+
 **type:** `os`
 
 **Description**: The operating system (OS) on which the process represented by this resource is running.

diff --git a/specification/resource/semantic_conventions/process.md b/specification/resource/semantic_conventions/process.md
@@ -1,5 +1,7 @@
 # Process and process runtime resources
 
+**Status**: [Experimental](../document-status.md)
+
 <!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
 
 <!-- toc -->

diff --git a/specification/trace/api.md b/specification/trace/api.md
@@ -1,6 +1,6 @@
 # Tracing API
 
-**Status**: [Feature-freeze](../document-status.md).
+**Status**: [Stable, Feature-freeze](../document-status.md)
 
 <details>
 <summary>

diff --git a/specification/trace/sdk.md b/specification/trace/sdk.md
@@ -1,5 +1,7 @@
 # Tracing SDK
 
+**Status**: [Stable](../document-status.md)
+
 <details>
 
 <summary>Table of Contents</summary>

diff --git a/specification/trace/sdk_exporters/jaeger.md b/specification/trace/sdk_exporters/jaeger.md
@@ -1,5 +1,7 @@
 # OpenTelemetry to Jaeger Transformation
 
+**Status**: [Stable](../document-status.md)
+
 This document defines the transformation between OpenTelemetry and Jaeger Spans.
 Jaeger accepts spans in two formats:
 

diff --git a/specification/trace/sdk_exporters/zipkin.md b/specification/trace/sdk_exporters/zipkin.md
@@ -1,5 +1,7 @@
 # OpenTelemetry to Zipkin Transformation
 
+**Status**: [Stable](../document-status.md)
+
 This document defines the transformation between OpenTelemetry and Zipkin Spans.
 Zipkin's v2 API is defined in the
 [zipkin.proto](https://github.com/openzipkin/zipkin-api/blob/master/zipkin.proto)

diff --git a/specification/trace/semantic_conventions/README.md b/specification/trace/semantic_conventions/README.md
@@ -1,5 +1,7 @@
 # Trace Semantic Conventions
 
+**Status**: [Experimental](../document-status.md)
+
 In OpenTelemetry spans can be created freely and it’s up to the implementor to
 annotate them with attributes specific to the represented operation. Spans
 represent specific operations in and between systems. Some of these operations

diff --git a/specification/trace/semantic_conventions/database.md b/specification/trace/semantic_conventions/database.md
@@ -1,5 +1,7 @@
 # Semantic conventions for database client calls
 
+**Status**: [Experimental](../document-status.md)
+
 <!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
 
 <!-- toc -->

diff --git a/specification/trace/semantic_conventions/exceptions.md b/specification/trace/semantic_conventions/exceptions.md
@@ -1,5 +1,7 @@
 # Semantic Conventions for Exceptions
 
+**Status**: [Experimental](../document-status.md)
+
 This document defines semantic conventions for recording application
 exceptions.
 

diff --git a/specification/trace/semantic_conventions/faas.md b/specification/trace/semantic_conventions/faas.md
@@ -1,5 +1,7 @@
 # Semantic conventions for FaaS spans
 
+**Status**: [Experimental](../document-status.md)
+
 This document defines how to describe an instance of a function that runs without provisioning
 or managing of servers (also known as serverless functions or Function as a Service (FaaS)) with spans.
 

diff --git a/specification/trace/semantic_conventions/http.md b/specification/trace/semantic_conventions/http.md
@@ -1,5 +1,7 @@
 # Semantic conventions for HTTP spans
 
+**Status**: [Experimental](../document-status.md)
+
 This document defines semantic conventions for HTTP client and server Spans.
 They can be used for http and https schemes
 and various HTTP versions like 1.1, 2 and SPDY.

diff --git a/specification/trace/semantic_conventions/messaging.md b/specification/trace/semantic_conventions/messaging.md
@@ -1,5 +1,7 @@
 # Messaging systems
 
+**Status**: [Experimental](../document-status.md)
+
 <!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
 
 <!-- toc -->

diff --git a/specification/trace/semantic_conventions/rpc.md b/specification/trace/semantic_conventions/rpc.md
@@ -1,5 +1,7 @@
 # Semantic conventions for RPC spans
 
+**Status**: [Experimental](../document-status.md)
+
 This document defines how to describe remote procedure calls
 (also called "remote method invocations" / "RMI") with spans.
 

diff --git a/specification/trace/semantic_conventions/span-general.md b/specification/trace/semantic_conventions/span-general.md
@@ -1,5 +1,7 @@
 # General attributes
 
+**Status**: [Experimental](../document-status.md)
+
 The attributes described in this section are not specific to a particular operation but rather generic.
 They may be used in any Span they apply to.
 Particular operations may refer to or require some of these attributes.