open-telemetry · reyang · Apr 8, 2022 · Apr 8, 2022
@@ -81,7 +81,7 @@ formats is required. Implementing more than one format is optional.
 | [IdGenerators](specification/trace/sdk.md#id-generators)                                         |          | +   | +    |     | +      | +    | +      | +   | +    | +   |      | +     |
 | [SpanLimits](specification/trace/sdk.md#span-limits)                                             | X        | +   | +    |     | +      | +    | +      | +   |      | -   |      | +     |
 | [Built-in `SpanProcessor`s implement `ForceFlush` spec](specification/trace/sdk.md#forceflush-1) |          |     | +    |     | +      | +    | +      | +   | +    | +   | +    |       |
-| [Attribute Limits](specification/common/common.md#attribute-limits)                              | X        |     | +    |     |        |      | +      | +   |      |     |      |       |
+| [Attribute Limits](specification/common/README.md#attribute-limits)                              | X        |     | +    |     |        |      | +      | +   |      |     |      |       |
 | Fetch InstrumentationScope from ReadableSpan                                                     |          |     |      |     |        |      |        |     |      |     |      |       |
 
 ## Baggage

@@ -438,11 +438,11 @@ certain programming languages or systems, for example `null`, `undefined`).
 
 Required parameters:
 
-* Optional [attributes](../common/common.md#attributes).
+* Optional [attributes](../common/README.md#attribute).
 * The increment amount, which MUST be a non-negative numeric value.
 
 The [OpenTelemetry API](../overview.md#api) authors MAY decide to allow flexible
-[attributes](../common/common.md#attributes) to be passed in as arguments. If
+[attributes](../common/README.md#attribute) to be passed in as arguments. If
 the attribute names and types are provided during the [counter
 creation](#counter-creation), the [OpenTelemetry API](../overview.md#api)
 authors MAY allow attribute values to be passed in using a more efficient way
@@ -660,10 +660,10 @@ certain programming languages or systems, for example `null`, `undefined`).
 Parameters:
 
 * The amount of the `Measurement`, which MUST be a non-negative numeric value.
-* Optional [attributes](../common/common.md#attributes).
+* Optional [attributes](../common/README.md#attribute).
 
 [OpenTelemetry API](../overview.md#api) authors MAY decide to allow flexible
-[attributes](../common/common.md#attributes) to be passed in as individual
+[attributes](../common/README.md#attribute) to be passed in as individual
 arguments. [OpenTelemetry API](../overview.md#api) authors MAY allow attribute
 values to be passed in using a more efficient way (e.g. strong typed struct
 allocated on the callstack, tuple). Here are some examples that [OpenTelemetry
@@ -894,10 +894,10 @@ certain programming languages or systems, for example `null`, `undefined`).
 Parameters:
 
 * The amount to be added, can be positive, negative or zero.
-* Optional [attributes](../common/common.md#attributes).
+* Optional [attributes](../common/README.md#attribute).
 
 [OpenTelemetry API](../overview.md#api) authors MAY decide to allow flexible
-[attributes](../common/common.md#attributes) to be passed in as individual
+[attributes](../common/README.md#attribute) to be passed in as individual
 arguments. [OpenTelemetry API](../overview.md#api) authors MAY allow attribute
 values to be passed in using a more efficient way (e.g. strong typed struct
 allocated on the callstack, tuple). Here are some examples that [OpenTelemetry
@@ -1044,7 +1044,7 @@ for the interaction between the API and SDK.
 `Measurement`s encapsulate:
 
 * A value
-* [`Attributes`](../common/common.md#attributes)
+* [`Attributes`](../common/README.md#attribute)
 
 ## Compatibility requirements
 

@@ -1301,7 +1301,7 @@ The following OTLP data points MUST be dropped:
 
 #### Metric Attributes
 
-OpenTelemetry Metric Attributes MUST be converted to [Prometheus labels](https://Prometheus.io/docs/concepts/data_model/#metric-names-and-labels).  String Attribute values are converted directly to Metric Attributes, and non-string Attribute values MUST be converted to string attributes following the [attribute specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/common.md#attribute).  Prometheus metric label keys are required to match the following regex: `[a-zA-Z_:]([a-zA-Z0-9_:])*`.  Metrics from OpenTelemetry with unsupported Attribute names MUST replace invalid characters with the `_` character. This may cause ambiguity in scenarios where multiple similar-named attributes share invalid characters at the same location.  In such unlikely cases, if multiple key-value pairs are converted to have the same Prometheus key, the values MUST be concatenated together, separated by `;`, and ordered by the lexicographical order of the original keys.
+OpenTelemetry Metric Attributes MUST be converted to [Prometheus labels](https://Prometheus.io/docs/concepts/data_model/#metric-names-and-labels).  String Attribute values are converted directly to Metric Attributes, and non-string Attribute values MUST be converted to string attributes following the [attribute specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute).  Prometheus metric label keys are required to match the following regex: `[a-zA-Z_:]([a-zA-Z0-9_:])*`.  Metrics from OpenTelemetry with unsupported Attribute names MUST replace invalid characters with the `_` character. This may cause ambiguity in scenarios where multiple similar-named attributes share invalid characters at the same location.  In such unlikely cases, if multiple key-value pairs are converted to have the same Prometheus key, the values MUST be concatenated together, separated by `;`, and ordered by the lexicographical order of the original keys.
 
 #### Exemplars
 
@@ -1349,7 +1349,7 @@ other labels other than `job` and `instance`.  There MUST be at most one
 
 If info-typed metric families are not yet supported by the language Prometheus client library, a gauge-typed metric family named "target" info with a constant value of 1 MUST be used instead.
 
-To convert OTLP resource attributes to Prometheus labels, string Attribute values are converted directly to labels, and non-string Attribute values MUST be converted to string attributes following the [attribute specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/common.md#attribute).
+To convert OTLP resource attributes to Prometheus labels, string Attribute values are converted directly to labels, and non-string Attribute values MUST be converted to string attributes following the [attribute specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute).
 
 ## Footnotes
 

@@ -473,7 +473,7 @@ between two non-identical `Metric` instances having the same `name`:
 **Status**: [Stable](../document-status.md)
 
 Attributes which belong to Metrics are exempt from the
-[common rules of attribute limits](../common/common.md#attribute-limits) at this
+[common rules of attribute limits](../common/README.md#attribute-limits) at this
 time. Attribute truncation or deletion could affect identity of metric time
 series and the topic requires further analysis.
 
@@ -493,7 +493,7 @@ information:
 
 - The `value` of the `Measurement` that was recorded by the API call.
 - The `time` the API call was made to record a `Measurement`.
-- The set of [Attributes](../common/common.md#attributes) associated with the
+- The set of [Attributes](../common/README.md#attribute) associated with the
   `Measurement` not already included in a metric data point.
 - The associated [trace id and span
   id](../trace/api.md#retrieving-the-traceid-and-spanid) of the active [Span

@@ -153,8 +153,8 @@ the following state:
 
 - An operation name
 - A start and finish timestamp
-- [**Attributes**](./common/common.md#attributes): A list of key-value pairs.
-- A set of zero or more **Events**, each of which is itself a tuple (timestamp, name, [**Attributes**](./common/common.md#attributes)). The name must be strings.
+- [**Attributes**](./common/README.md#attribute): A list of key-value pairs.
+- A set of zero or more **Events**, each of which is itself a tuple (timestamp, name, [**Attributes**](./common/README.md#attribute)). The name must be strings.
 - Parent's **Span** identifier.
 - [**Links**](#links-between-spans) to zero or more causally-related **Spans**
   (via the **SpanContext** of those related **Spans**).
@@ -213,7 +213,7 @@ scenarios.
 ## Metric Signal
 
 OpenTelemetry allows to record raw measurements or metrics with predefined
-aggregation and a [set of attributes](./common/common.md#attributes).
+aggregation and a [set of attributes](./common/README.md#attribute).
 
 Recording raw measurements using OpenTelemetry API allows to defer to end-user
 the decision on what aggregation algorithm should be applied for this metric as

@@ -18,7 +18,7 @@ platform.
   `service.name`, `service.version` and 10 characters string value for each
   attribute, and attribute `service.instance.id` with a unique UUID. See
   [Service](./resource/semantic_conventions/README.md#service) for details.
-- 1 [attribute](./common/common.md#attributes) with a signed 64-bit integer
+- 1 [attribute](./common/README.md#attribute) with a signed 64-bit integer
   value.
 - 1 [event](./trace/api.md#add-events) without any attributes.
 - The `AlwaysOn` sampler should be enabled.

@@ -3,7 +3,7 @@
 **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).
+telemetry as [Attributes](../common/README.md#attribute).
 For example, a process producing telemetry that is running in a
 container on Kubernetes has a Pod name, it is in a namespace and possibly is
 part of a Deployment which also has a name. All three of these attributes can be
@@ -49,13 +49,13 @@ The SDK must support two ways to instantiate new resources. Those are:
 
 ### Create
 
-The interface MUST provide a way to create a new resource, from [`Attributes`](../common/common.md#attributes).
+The interface MUST provide a way to create a new resource, from [`Attributes`](../common/README.md#attribute).
 Examples include a factory method or a constructor for a resource
 object. A factory method is recommended to enable support for cached objects.
 
 Required parameters:
 
-- [`Attributes`](../common/common.md#attributes)
+- [`Attributes`](../common/README.md#attribute)
 - [since 1.4.0] `schema_url` (optional): Specifies the Schema URL that should be
   recorded in the emitted resource. If the `schema_url` parameter is unspecified
   then the created resource will have an empty Schema URL.

@@ -94,7 +94,7 @@ Depending on the value of `OTEL_TRACES_SAMPLER`, `OTEL_TRACES_SAMPLER_ARG` may b
 SDKs SHOULD only offer environment variables for the types of attributes, for
 which that SDK implements truncation mechanism.
 
-See the SDK [Attribute Limits](common/common.md#attribute-limits) section for the definition of the limits.
+See the SDK [Attribute Limits](common/README.md#attribute-limits) section for the definition of the limits.
 
 | Name                              | Description                          | Default | Notes |
 | --------------------------------- | ------------------------------------ | ------- | ----- |

@@ -283,7 +283,7 @@ the entire operation and, optionally, one or more sub-spans for its sub-operatio
 - A [`SpanKind`](#spankind)
 - A start timestamp
 - An end timestamp
-- [`Attributes`](../common/common.md#attributes)
+- [`Attributes`](../common/README.md#attribute)
 - A list of [`Link`s](#specifying-links) to other `Span`s
 - A list of timestamped [`Event`s](#add-events)
 - A [`Status`](#set-status).
@@ -361,7 +361,7 @@ The API MUST accept the following parameters:
   The semantic parent of the Span MUST be determined according to the rules
   described in [Determining the Parent Span from a Context](#determining-the-parent-span-from-a-context).
 - [`SpanKind`](#spankind), default to `SpanKind.Internal` if not specified.
-- [`Attributes`](../common/common.md#attributes). Additionally,
+- [`Attributes`](../common/README.md#attribute). Additionally,
   these attributes may be used to make a sampling decision as noted in [sampling
   description](sdk.md#sampling). An empty collection will be assumed if
   not specified.
@@ -415,7 +415,7 @@ Span creation.
 A `Link` is structurally defined by the following properties:
 
 - `SpanContext` of the `Span` to link to.
-- Zero or more [`Attributes`](../common/common.md#attributes) further describing
+- Zero or more [`Attributes`](../common/README.md#attribute) further describing
   the link.
 
 The Span creation API MUST provide:
@@ -474,7 +474,7 @@ propagators.
 
 #### Set Attributes
 
-A `Span` MUST have the ability to set [`Attributes`](../common/common.md#attributes) associated with it.
+A `Span` MUST have the ability to set [`Attributes`](../common/README.md#attribute) associated with it.
 
 The Span interface MUST provide:
 
@@ -507,7 +507,7 @@ An `Event` is structurally defined by the following properties:
 - Name of the event.
 - A timestamp for the event. Either the time at which the event was
   added or a custom timestamp provided by the user.
-- Zero or more [`Attributes`](../common/common.md#attributes) further describing
+- Zero or more [`Attributes`](../common/README.md#attribute) further describing
   the event.
 
 The Span interface MUST provide:

@@ -374,7 +374,7 @@ Following configuration properties should be available when creating the sampler
 
 ## Span Limits
 
-Span attributes MUST adhere to the [common rules of attribute limits](../common/common.md#attribute-limits).
+Span attributes MUST adhere to the [common rules of attribute limits](../common/README.md#attribute-limits).
 
 SDK Spans MAY also discard links and events that would increase the number of
 elements of each collection beyond the configured limit.
@@ -405,7 +405,7 @@ public final class SpanLimits {
 
 **Configurable parameters:**
 
-* [all common options applicable to attributes](../common/common.md#configurable-parameters)
+* [all common options applicable to attributes](../common/README.md#configurable-parameters)
 * `EventCountLimit` (Default=128) - Maximum allowed span event count;
 * `LinkCountLimit` (Default=128) - Maximum allowed span link count;
 * `AttributePerEventCountLimit` (Default=128) - Maximum allowed attribute per span event count;

@@ -25,7 +25,7 @@ and Zipkin.
 | Span.Kind                  | Span.kind        | See [SpanKind](#spankind) for values mapping                                                  |
 | Span.StartTime             | Span.timestamp   | See [Unit of time](#unit-of-time)                                                             |
 | Span.EndTime               | Span.duration    | Duration is calculated based on StartTime and EndTime. See also [Unit of time](#unit-of-time) |
-| Span.Attributes            | Add to Span.tags | See [Attributes](../../common/common.md#attributes) for data types for the mapping.           |
+| Span.Attributes            | Add to Span.tags | See [Attributes](../../common/README.md#attribute) for data types for the mapping.           |
 | Span.DroppedAttributesCount| Add to Span.tags | See [Dropped Attributes Count](non-otlp.md#dropped-attributes-count) for tag name to use.     |
 | Span.Events                | Span.annotations | See [Events](#events) for the mapping format.                                                 |
 | Span.DroppedEventsCount    | Add to Span.tags | See [Dropped Events Count](non-otlp.md#dropped-events-count) for tag name to use.             |