Skip to content

Commit 5e56569

Browse files
authored
Make OTEP hyperlinks relative (#4408)
Related to #4284
1 parent 2eda19e commit 5e56569

26 files changed

+69
-69
lines changed

CHANGELOG.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2898,19 +2898,19 @@ Updates:
28982898

28992899
## v0.4.0 (2020-05-12)
29002900

2901-
- [OTEP-83](https://github.com/open-telemetry/oteps/blob/main/text/0083-component.md)
2901+
- [OTEP-83](oteps/0083-component.md)
29022902
Introduce the notion of InstrumentationLibrary.
2903-
- [OTEP-88](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0088-metric-instrument-optional-refinements.md)
2903+
- [OTEP-88](oteps/metrics/0088-metric-instrument-optional-refinements.md)
29042904
Metrics API instrument foundation.
2905-
- [OTEP-91](https://github.com/open-telemetry/oteps/blob/main/text/logs/0091-logs-vocabulary.md)
2905+
- [OTEP-91](oteps/logs/0091-logs-vocabulary.md)
29062906
Logs vocabulary.
2907-
- [OTEP-92](https://github.com/open-telemetry/oteps/blob/main/text/logs/0092-logs-vision.md)
2907+
- [OTEP-92](oteps/logs/0092-logs-vision.md)
29082908
Logs Vision.
2909-
- [OTEP-90](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0090-remove-labelset-from-metrics-api.md)
2909+
- [OTEP-90](oteps/metrics/0090-remove-labelset-from-metrics-api.md)
29102910
Remove LabelSet from the metrics API.
2911-
- [OTEP-98](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0098-metric-instruments-explained.md)
2911+
- [OTEP-98](oteps/metrics/0098-metric-instruments-explained.md)
29122912
Explain the metric instruments.
2913-
- [OTEP-99](https://github.com/open-telemetry/oteps/blob/main/text/0099-otlp-http.md)
2913+
- [OTEP-99](oteps/0099-otlp-http.md)
29142914
OTLP/HTTP: HTTP Transport Extension for OTLP.
29152915
- Define handling of null and empty attribute values.
29162916
- Rename Setter.put to Setter.set
@@ -2930,15 +2930,15 @@ Updates:
29302930

29312931
## v0.3.0 (2020-02-21)
29322932

2933-
- [OTEP-0059](https://github.com/open-telemetry/oteps/blob/main/text/trace/0059-otlp-trace-data-format.md)
2933+
- [OTEP-0059](oteps/trace/0059-otlp-trace-data-format.md)
29342934
Add OTLP Trace Data Format specification.
2935-
- [OTEP-0066](https://github.com/open-telemetry/oteps/blob/main/text/0066-separate-context-propagation.md)
2935+
- [OTEP-0066](oteps/0066-separate-context-propagation.md)
29362936
Separate Layer for Context Propagation.
2937-
- [OTEP-0070](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0070-metric-bound-instrument.md)
2937+
- [OTEP-0070](oteps/metrics/0070-metric-bound-instrument.md)
29382938
Rename metric instrument "Handles" to "Bound Instruments".
2939-
- [OTEP-0072](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0072-metric-observer.md)
2939+
- [OTEP-0072](oteps/metrics/0072-metric-observer.md)
29402940
Metric Observer instrument specification (refinement).
2941-
- [OTEP-0080](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0080-remove-metric-gauge.md)
2941+
- [OTEP-0080](oteps/metrics/0080-remove-metric-gauge.md)
29422942
Remove the Metric Gauge instrument, recommend use of other instruments.
29432943
- Update 0003-measure-metric-type to match current Specification.
29442944
- Update 0009-metric-handles to match current Specification.
@@ -2958,23 +2958,23 @@ Updates:
29582958

29592959
## v0.2.0 (2019-10-22)
29602960

2961-
- [OTEP-0001](https://github.com/open-telemetry/oteps/blob/main/text/0001-telemetry-without-manual-instrumentation.md)
2961+
- [OTEP-0001](oteps/0001-telemetry-without-manual-instrumentation.md)
29622962
Added Auto-Instrumentation.
2963-
- [OTEP-0002](https://github.com/open-telemetry/oteps/blob/main/text/trace/0002-remove-spandata.md):
2963+
- [OTEP-0002](oteps/trace/0002-remove-spandata.md):
29642964
Removed SpanData interface in favor of Span Start and End options.
2965-
- [OTEP-0003](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0003-measure-metric-type.md)
2965+
- [OTEP-0003](oteps/metrics/0003-measure-metric-type.md)
29662966
Consolidatesd pre-aggregated and raw metrics APIs.
2967-
- [OTEP-0008](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0008-metric-observer.md)
2967+
- [OTEP-0008](oteps/metrics/0008-metric-observer.md)
29682968
Added Metrics Observers API.
2969-
- [OTEP-0009](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0009-metric-handles.md)
2969+
- [OTEP-0009](oteps/metrics/0009-metric-handles.md)
29702970
Added Metrics Handle API.
2971-
- [OTEP-0010](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0010-cumulative-to-counter.md)
2971+
- [OTEP-0010](oteps/metrics/0010-cumulative-to-counter.md)
29722972
Rename "Cumulative" to "Counter" in the Metrics API.
2973-
- [OTEP-006](https://github.com/open-telemetry/oteps/blob/main/text/trace/0006-sampling.md)
2973+
- [OTEP-006](oteps/trace/0006-sampling.md)
29742974
Moved sampling from the API tp the SDK.
2975-
- [OTEP-0007](https://github.com/open-telemetry/oteps/blob/main/text/0007-no-out-of-band-reporting.md)
2975+
- [OTEP-0007](oteps/0007-no-out-of-band-reporting.md)
29762976
Moved support for out-of-band telemetry from the API to the SDK.
2977-
- [OTEP-0016](https://github.com/open-telemetry/oteps/blob/main/text/0016-named-tracers.md)
2977+
- [OTEP-0016](oteps/0016-named-tracers.md)
29782978
Added named providers for Tracers and Meters.
29792979
- Added design goals and requirements for a telemetry data exchange protocol.
29802980
- Added a Span Processor interface for intercepting span start and end

development/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Features in Development must be:
1414
To avoid any confusion, all files in this directory must have a note about its Development status.
1515

1616
Development status precedes the alpha version (see
17-
[OTEP 0232](https://github.com/open-telemetry/oteps/blob/main/text/0232-maturity-of-otel.md#explanation)).
17+
[OTEP 0232](../oteps/0232-maturity-of-otel.md#explanation)).
1818
All changes in the `development` folder go through the regular review process. Changes are allowed to be merged faster as completeness of a solution is not a requirement. Approval means that proposed changes are OK for experimentation.
1919

2020
When the feature or parts of it are developed far enough to declare them as an alpha version of a main project and move out of the Development status, it must go through a **new** OTEP PR and it must be expected that design and APIs will be changed. In fact, the same people who approved the experiment may likely be the most critical reviewers. It demonstrates an interest and involvement, not critique.

development/trace/zpages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
zPages are an in-process alternative to external exporters. When included, they collect and aggregate tracing and metrics information in the background; this data is served on web pages when requested.
2626

27-
The idea of "zPages" originates from one of OpenTelemetry's predecessors, [OpenCensus](https://opencensus.io/). You can read more about zPages from the OpenCensus docs [here](https://opencensus.io/zpages) or the OTEP [here](https://github.com/open-telemetry/oteps/blob/main/text/0110-z-pages.md). OpenCensus has different zPage implementations in [Java](https://opencensus.io/zpages/java/), [Go](https://opencensus.io/zpages/go/), and [Node](https://opencensus.io/zpages/node/) and there has been similar internal solutions developed at companies like Uber. Within OpenTelemetry, zPages are available in Go and Rust. The OTel Collector also has [an implementation](https://github.com/open-telemetry/opentelemetry-collector/tree/master/extension/zpagesextension) of zPages.
27+
The idea of "zPages" originates from one of OpenTelemetry's predecessors, [OpenCensus](https://opencensus.io/). You can read more about zPages from the OpenCensus docs [here](https://opencensus.io/zpages) or the OTEP [here](../../oteps/0110-z-pages.md). OpenCensus has different zPage implementations in [Java](https://opencensus.io/zpages/java/), [Go](https://opencensus.io/zpages/go/), and [Node](https://opencensus.io/zpages/node/) and there has been similar internal solutions developed at companies like Uber. Within OpenTelemetry, zPages are available in Go and Rust. The OTel Collector also has [an implementation](https://github.com/open-telemetry/opentelemetry-collector/tree/master/extension/zpagesextension) of zPages.
2828

2929
zPages are uniquely useful in a couple of different ways. One is that they're more lightweight and quicker compared to installing external tracing systems like Jaeger and Zipkin, yet they still share useful ways to debug and gain insight into instrumented applications; these uses depend on the type of zPage, which is detailed below. For high throughput applications, zPages can also analyze more telemetry with the limited set of supported scenarios than external exporters; this is because zPages are in-memory while external exporters are typically configured to send a subset of telemetry for reach analysis to save costs.
3030

oteps/0156-columnar-encoding.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
**Abstract**: This OTEP describes a new protocol, the OTelArrow protocol, which is based on a **generic columnar representation
88
for metrics, logs and traces**. This protocol significantly improves efficiency in scenarios involving the transmission
99
of large batches of metrics, logs, traces. Moreover, it provides a better representation for [multivariate time-series](#multivariate-time-series).
10-
The OTelArrow protocol also supports a fallback mechanism to the [OpenTelemetry protocol (OTEP 0035)](https://github.com/open-telemetry/oteps/blob/main/text/0035-opentelemetry-protocol.md)
10+
The OTelArrow protocol also supports a fallback mechanism to the [OpenTelemetry protocol (OTEP 0035)](0035-opentelemetry-protocol.md)
1111
in instances when one of the endpoints does not support the OTelArrow protocol.
1212

1313
**Reference implementation**: The [OTel Arrow Adapter](https://github.com/f5/otel-arrow-adapter) Go library specifies
@@ -70,7 +70,7 @@ other in memory. The main benefits of a columnar approach are:
7070

7171
![row vs column-oriented](img/0156_OTEL%20-%20Row%20vs%20Column.png)
7272

73-
This OTEP proposes to improve the [OpenTelemetry protocol (OTEP 0035)](https://github.com/open-telemetry/oteps/blob/main/text/0035-opentelemetry-protocol.md)
73+
This OTEP proposes to improve the [OpenTelemetry protocol (OTEP 0035)](0035-opentelemetry-protocol.md)
7474
with a **generic columnar representation for metrics, logs and traces based on Apache Arrow**. Compared to the existing
7575
OpenTelemetry protocol this compatible extension has the following improvements:
7676

@@ -85,7 +85,7 @@ OpenTelemetry protocol this compatible extension has the following improvements:
8585
efficiency, and data minimization require additional data processing capabilities such as data projection,
8686
aggregation, and filtering.
8787

88-
These improvements not only address the aforementioned needs but also answer the [open questions](https://github.com/open-telemetry/oteps/blob/main/text/0035-opentelemetry-protocol.md#open-questions)
88+
These improvements not only address the aforementioned needs but also answer the [open questions](0035-opentelemetry-protocol.md#open-questions)
8989
cited in OTEP 035 (i.e. cpu usage, memory pressure, compression optimization).
9090

9191
**It is important to understand that this proposal is complementary to the existing protocol. The row-oriented version
@@ -749,7 +749,7 @@ the client select between OTLP or OTel Arrow protocol depending on the nature of
749749
## Future Versions and Interoperability
750750

751751
As far as protocol evolution and interoperability mechanisms are concerned, this extension follows the
752-
[recommendations](https://github.com/open-telemetry/oteps/blob/main/text/0035-opentelemetry-protocol.md#future-versions-and-interoperability)
752+
[recommendations](0035-opentelemetry-protocol.md#future-versions-and-interoperability)
753753
outlined in the OTLP spec.
754754

755755
## Prior Art and Alternatives

oteps/0243-app-telemetry-schema-vision-roadmap.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Discoverability, Interoperability, Type-Safe Client SDKs, Client SDKs Generation,
88
CI/CD Integration, Data Governance, Data Privacy.
99

10-
**Related OTEPs**: [OTEP0152](https://github.com/open-telemetry/oteps/blob/main/text/0152-telemetry-schemas.md), [OTEP0202](https://github.com/open-telemetry/oteps/blob/main/text/0202-events-and-logs-api.md).
10+
**Related OTEPs**: [OTEP0152](0152-telemetry-schemas.md), [OTEP0202](0202-events-and-logs-api.md).
1111

1212
----
1313
_Unlike the traditional data ecosystem (OLTP and OLAP), the world of telemetry
@@ -193,7 +193,7 @@ Telemetry Schemas would replace/augment existing SchemaURL.
193193
![Use cases](./img/0243-otel-weaver-use-cases.svg)
194194

195195
Note: The relationship between Telemetry Schema v1.1
196-
([OTEP 0152](https://github.com/open-telemetry/oteps/blob/main/text/0152-telemetry-schemas.md))
196+
([OTEP 0152](0152-telemetry-schemas.md))
197197
and the Component and Resolved Telemetry Schema concepts is still being
198198
discussed. This will be clarified in future OTEPs (refer to the last section).
199199

oteps/entities/0264-resource-and-entities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ The DataModel would ensure that attributes in Resource are produced from both th
214214

215215
### ResourceEntityRef
216216

217-
The entityref data model, would have the following changes from the original [entity OTEP](https://github.com/open-telemetry/oteps/blob/main/text/entities/0256-entities-data-model.md) to denote references within Resource:
217+
The entityref data model, would have the following changes from the original [entity OTEP](0256-entities-data-model.md) to denote references within Resource:
218218

219219
| Field | Type | Description | Changes |
220220
| ----- | ---- | ----------- | ------- |

oteps/trace/0168-sampling-propagation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -441,11 +441,11 @@ data to avoid the computational cost of hashing TraceIDs.
441441

442442
Restricting parent sampling probabilities to powers of two does not limit tail
443443
Samplers from using arbitrary probabilities. The companion [OTEP
444-
170](https://github.com/open-telemetry/oteps/blob/main/text/trace/0170-sampling-probability.md) has discussed
444+
170](0170-sampling-probability.md) has discussed
445445
the use of a `sampler.adjusted_count` attribute that would not be
446446
limited to power-of-two values. Discussion about how to represent the
447447
effective adjusted count for tail-sampled Spans belongs in [OTEP
448-
170](https://github.com/open-telemetry/oteps/blob/main/text/trace/0170-sampling-probability.md), not this OTEP.
448+
170](0170-sampling-probability.md), not this OTEP.
449449

450450
Restricting parent sampling probabilities to powers of two does not limit
451451
Samplers from using arbitrary effective probabilities over a period of
@@ -465,7 +465,7 @@ propagate the `p` value when the context is not sampled, since
465465
`ParentBased` samplers will not change the decision. Although one
466466
use-case was docmented in Google's early Dapper system (known as
467467
"inflationary sampling", see
468-
[OTEP 170](https://github.com/open-telemetry/oteps/blob/main/text/trace/0170-sampling-probability.md#dappers-inflationary-sampler)), the same effect can
468+
[OTEP 170](0170-sampling-probability.md#dappers-inflationary-sampler)), the same effect can
469469
be achieved using a consistent sampling decision in this framework.
470470

471471
### Default behavior

oteps/trace/0220-messaging-semantic-conventions-span-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ scenarios and different messaging systems.
6161

6262
## Stages of producing and consuming messages
6363

64-
As previously described in [OTEP 173](https://github.com/open-telemetry/oteps/blob/main/text/trace/0173-messaging-semantic-conventions.md#scenarios.),
64+
As previously described in [OTEP 173](0173-messaging-semantic-conventions.md#scenarios),
6565
producing and consuming a message involves five stages:
6666

6767
```mermaid

specification/document-status.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The support guarantees and allowed changes are governed by the lifecycle of the
1717
|Deprecated |Changes are no longer allowed, except for editorial changes.|
1818

1919
The specification follows
20-
[OTEP 0232](https://github.com/open-telemetry/oteps/blob/main/text/0232-maturity-of-otel.md#explanation)
20+
[OTEP 0232](../oteps/0232-maturity-of-otel.md#explanation)
2121
maturity level definitions.
2222

2323
## Feature freeze

specification/logs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -453,5 +453,5 @@ standard output.
453453

454454
## References
455455

456-
- [OTEP0091 Logs: Vocabulary](https://github.com/open-telemetry/oteps/blob/main/text/logs/0091-logs-vocabulary.md)
457-
- [OTEP0092 OpenTelemetry Logs Vision](https://github.com/open-telemetry/oteps/blob/main/text/logs/0092-logs-vision.md)
456+
- [OTEP0091 Logs: Vocabulary](../../oteps/logs/0091-logs-vocabulary.md)
457+
- [OTEP0092 OpenTelemetry Logs Vision](../../oteps/logs/0092-logs-vision.md)

specification/logs/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,4 +178,4 @@ specific guarantees and safeties.
178178

179179
## References
180180

181-
- [OTEP0150 Logging Library SDK Prototype Specification](https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md)
181+
- [OTEP0150 Logging Library SDK Prototype Specification](../../oteps/logs/0150-logging-library-sdk.md)

specification/logs/data-model-appendix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -819,4 +819,4 @@ for an exhaustive list.
819819

820820
## References
821821

822-
- [OTEP0097 Log Data Model, Appendix A. Example Mappings](https://github.com/open-telemetry/oteps/blob/main/text/logs/0097-log-data-model.md#appendix-a-example-mappings)
822+
- [OTEP0097 Log Data Model, Appendix A. Example Mappings](../../oteps/logs/0097-log-data-model.md#appendix-a-example-mappings)

specification/logs/data-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ For example log format mappings, see the
501501

502502
## References
503503

504-
- Log Data Model [OTEP 0097](https://github.com/open-telemetry/oteps/blob/main/text/logs/0097-log-data-model.md)
504+
- Log Data Model [OTEP 0097](../../oteps/logs/0097-log-data-model.md)
505505

506506
- [Draft discussion of Data Model](https://docs.google.com/document/d/1ix9_4TQO3o-qyeyNhcOmqAc1MTyr-wnXxxsdWgCMn9c/edit#)
507507

specification/logs/sdk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -529,4 +529,4 @@ return a Failure result.
529529
and the destination is unavailable). [OpenTelemetry SDK](../overview.md#sdk)
530530
authors MAY decide if they want to make the shutdown timeout configurable.
531531

532-
- [OTEP0150 Logging Library SDK Prototype Specification](https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md)
532+
- [OTEP0150 Logging Library SDK Prototype Specification](../../oteps/logs/0150-logging-library-sdk.md)

specification/logs/supplementary-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,4 +117,4 @@ See
117117
[an example](https://docs.google.com/document/d/15vR7D1x2tKd7u3zaTF0yH1WaHkUr2T4hhr7OyiZgmBg/edit#heading=h.4xuru5ljcups)
118118
of how it can be done for zap logging library for Go.
119119

120-
- [OTEP0150 Logging Library SDK Prototype Specification](https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md)
120+
- [OTEP0150 Logging Library SDK Prototype Specification](../../oteps/logs/0150-logging-library-sdk.md)

specification/metrics/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,4 @@ SDK](../overview.md#sdk) concept for more information.
107107
## References
108108

109109
* Scenarios for Metrics API/SDK Prototyping ([OTEP
110-
146](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0146-metrics-prototype-scenarios.md))
110+
146](../../oteps/metrics/0146-metrics-prototype-scenarios.md))

0 commit comments

Comments
 (0)