Skip to content

Commit

Permalink
rename api.md to old_api.md and update links (#1674)
Browse files Browse the repository at this point in the history
  • Loading branch information
reyang authored May 6, 2021
1 parent 6763ad6 commit 12b5b27
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Technical committee holds regular meetings, notes are held
- [Propagators](specification/context/api-propagators.md)
- [Baggage](specification/baggage/api.md)
- [Tracing](specification/trace/api.md)
- [Metrics](specification/metrics/api.md)
- [Metrics](specification/metrics/new_api.md)
- SDK Specification
- [Tracing](specification/trace/sdk.md)
- [Resource](specification/resource/sdk.md)
Expand Down
4 changes: 2 additions & 2 deletions specification/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Metrics, logs, and traces exported to telemetry backends are examples of out-of-

### Manual Instrumentation

Coding against the OpenTelemetry API such as the [Tracing API](trace/api.md), [Metrics API](metrics/api.md), or others to collect telemetry from end-user code or shared frameworks (e.g. MongoDB, Redis, etc.).
Coding against the OpenTelemetry API such as the [Tracing API](trace/api.md), [Metrics API](metrics/new_api.md), or others to collect telemetry from end-user code or shared frameworks (e.g. MongoDB, Redis, etc.).

### Automatic Instrumentation

Expand Down Expand Up @@ -150,7 +150,7 @@ Synonyms: *Instrumenting Library*.
### Tracer Name / Meter Name

This refers to the `name` and (optional) `version` arguments specified when
creating a new `Tracer` or `Meter` (see [Obtaining a Tracer](trace/api.md#tracerprovider)/[Obtaining a Meter](metrics/api.md#meter-interface)).
creating a new `Tracer` or `Meter` (see [Obtaining a Tracer](trace/api.md#tracerprovider)/[Obtaining a Meter](metrics/new_api.md#meterprovider)).
The name/version pair identifies the [Instrumentation Library](#instrumentation-library).

## Logs
Expand Down
2 changes: 1 addition & 1 deletion specification/library-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,5 +129,5 @@ guidelines on the performance expectations that API implementations should meet,
Please refer to individual API specification for guidelines on what concurrency
safeties should API implementations provide and how they should be documented:

* [Metrics API](./metrics/api.md#concurrency)
* [Metrics API](./metrics/new_api.md#concurrency)
* [Tracing API](./trace/api.md#concurrency)
2 changes: 1 addition & 1 deletion specification/library-layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ api

This directory describes the API that provides in-process context propagation.

### [/metrics](./metrics/api.md)
### [/metrics](./metrics/new_api.md)

This directory describes the Metrics API that can be used to record application metrics.

Expand Down
4 changes: 2 additions & 2 deletions specification/metrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Table of Contents
* [API](#api)
* [SDK](#sdk)
* [Specifications](#specifications)
* [Metrics API](./api.md)
* [Metrics API](./new_api.md)
* Metrics SDK (not available yet)
* [Metrics Data Model and Protocol](datamodel.md)
* [Semantic Conventions](./semantic_conventions/README.md)
Expand Down Expand Up @@ -106,7 +106,7 @@ SDK](../overview.md#sdk) concept concept for more information.

## Specifications

* [Metrics API](./api.md)
* [Metrics API](./new_api.md)
* Metrics SDK (not available yet)
* [Metrics Data Model and Protocol](datamodel.md)
* [Semantic Conventions](./semantic_conventions/README.md)
Expand Down
6 changes: 3 additions & 3 deletions specification/metrics/datamodel.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ OpenTelemetry fragments metrics into three interacting models:
### Event Model

The event model is where recording of data happens. Its foundation is made of
[Instruments](api.md), which are used to record data observations via events.
[Instruments](new_api.md), which are used to record data observations via events.
These raw events are then transformed in some fashion before being sent to some
other system. OpenTelemetry metrics are designed such that the same instrument
and events can be used in different ways to generate metric streams.
Expand All @@ -164,12 +164,12 @@ compressed format rather than individual timeseries.
> Note: The above picture shows how one instrument can transform events into
> more than one type of metric stream. There are caveats and nuances for when
> and how to do this. Instrument and metric configuration are outlined
> in the [metrics API specification](api.md).
> in the [metrics API specification](new_api.md).
While OpenTelemetry provides flexibility in how instruments can be transformed
into metric streams, the instruments are defined such that a reasonable default
mapping can be provided. The exact
[OpenTelemetry instruments](api.md##metric-instruments) are more fully
[OpenTelemetry instruments](new_api.md##instrument) are more fully
detailed in the API specification.

In the Event model, the primary data are (instrument, number) points, originally
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ See also [Metric names and labels](https://prometheus.io/docs/concepts/data_mode
in the Prometheus data model documentation.

OpenMetrics does not allow metric names to begin with a digit. OpenTelemetry's
[instrument naming requirements](../api.md#instrument-naming-requirements) also
[instrument naming requirements](../new_api.md#instrument-naming-rule) also
require that the first character of a metric instrument is non-numeric.

If a metric event is generated in OpenTelemetry that does not conform to this
Expand Down
2 changes: 1 addition & 1 deletion specification/resource/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ all `Span`s produced by any `Tracer` from the provider MUST be associated with t

Analogous to distributed tracing, when used with metrics,
a resource can be associated with a `MeterProvider`.
When associated with a [`MeterProvider`](../metrics/api.md#meter-interface),
When associated with a [`MeterProvider`](../metrics/new_api.md#meter),
all metrics produced by any `Meter` from the provider will be
associated with this `Resource`.

Expand Down

0 comments on commit 12b5b27

Please sign in to comment.