From 5fe5c3f1eb37c6edeb82b9681faed9cd4de0eebf Mon Sep 17 00:00:00 2001 From: Alban Crequy Date: Mon, 12 Aug 2019 20:15:22 +0200 Subject: [PATCH] Fix broken links (#212) * Fix broken links Links were fixed With help from: https://github.com/remarkjs/remark-validate-links * Update work_in_progress/specification/trace/LogCorrelation.md Co-Authored-By: Armin Ruech * Update work_in_progress/specification/trace/LogCorrelation.md Co-Authored-By: Armin Ruech * Update work_in_progress/specification/trace/LogCorrelation.md Co-Authored-By: Armin Ruech --- milestones.md | 2 +- specification/api-metrics.md | 8 ++++---- specification/api-tracing.md | 13 ++++++------- specification/library-guidelines.md | 2 +- specification/overview.md | 2 +- work_in_progress/opencensus/HTTP.md | 4 ++-- work_in_progress/opencensus/StandardResources.md | 9 ++++----- .../opentracing/semantic_conventions.md | 4 ++-- work_in_progress/specification/README.md | 6 +++--- .../specification/trace/LogCorrelation.md | 6 +++--- work_in_progress/specification/trace/README.md | 4 ++-- work_in_progress/specification/trace/Span.md | 2 +- work_in_progress/typedspans/README.md | 10 +++++----- 13 files changed, 35 insertions(+), 37 deletions(-) diff --git a/milestones.md b/milestones.md index 467cb946500..1bd17e93423 100644 --- a/milestones.md +++ b/milestones.md @@ -19,7 +19,7 @@ Parity can be defined as the following features: - An SDK implementing OpenTelemetry specification. - Backwards compatibility with OpenTracing and OpenCensus. - Metadata helpers for recording common operations defined in the OpenTelemetry - [semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/master/semantic-conventions.md). + [semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-semantic-conventions.md). - Tests which provide evidence of interoperability. - Benchmarks which provide evidence of expected resource utilization. - Documentation and getting started guide. diff --git a/specification/api-metrics.md b/specification/api-metrics.md index 87cb682540b..aa15ccb3fb8 100644 --- a/specification/api-metrics.md +++ b/specification/api-metrics.md @@ -5,7 +5,7 @@ Table of Content -- [Meter](#meater) +- [Meter](#meter) - [Meter Creation](#meter-creation) - [Create Metric](#create-metric) - [Create Measure](#create-measure) @@ -20,8 +20,8 @@ Table of Content - [SetCallback](#setcallback) - [RemoveTimeSeries](#removetimeseries) - [Clear](#clear) - - [Type: Counter](#type--counter) - - [Type: Gauge](#type--gauge) + - [Type: Counter](#type-counter) + - [Type: Gauge](#type-gauge) @@ -63,7 +63,7 @@ Optional arguments: for these labels. - set of name/value pairs for the labels with the constant values. - component name that reports this `Metric`. See [semantic - convention](../semantic-conventions.md) for the examples of well-known + convention](data-semantic-conventions.md) for the examples of well-known components. - resource this `Metric` is associated with. diff --git a/specification/api-tracing.md b/specification/api-tracing.md index 980762214e0..1af452d3cbc 100644 --- a/specification/api-tracing.md +++ b/specification/api-tracing.md @@ -21,7 +21,6 @@ Table of Content * [SpanContext](#spancontext) * [Span](#span) * [Span creation](#span-creation) - * [StartSpan](#startspan) * [Span operations](#span-operations) * [Get Context](#get-context) * [IsRecordingEvents](#isrecordingevents) @@ -48,7 +47,7 @@ Table of Content * [GetContext](#getcontext) * [GetParentSpanId](#getparentspanid) * [GetResource](#getresource) - * [GetAttributes](#getattributes-1) + * [GetAttributes](#getattributes) * [GetTimedEvents](#gettimedevents) * [GetLinks](#getlinks) * [GetStatus](#getstatus) @@ -235,9 +234,9 @@ sub-operations. or null - A start timestamp - An end timestamp -- An ordered mapping of [`Attribute`s](#SetAttribute) -- A list of [`Link`s](#AddLink) to other `Span`s -- A list of timestamped [`Event`s](#AddEvent) +- An ordered mapping of [`Attribute`s](#Set-Attributes) +- A list of [`Link`s](#add-Links) to other `Span`s +- A list of timestamped [`Event`s](#add-events) The `Span`'s start and end timestamps reflect the elapsed real time of the operation. A `Span`'s start time SHOULD be set to the current time on [span @@ -331,7 +330,7 @@ with the same key as an existing attribute SHOULD overwrite the existing attribute's value. Note that the OpenTelemetry project documents certain ["standard -attributes"](../semantic-conventions.md) that have prescribed semantic meanings. +attributes"](data-semantic-conventions.md) that have prescribed semantic meanings. #### Add Events @@ -356,7 +355,7 @@ Events SHOULD preserve the order in which they're set. This will typically match the ordering of the events' timestamps. Note that the OpenTelemetry project documents certain ["standard event names and -keys"](../semantic-conventions.md) which have prescribed semantic meanings. +keys"](data-semantic-conventions.md) which have prescribed semantic meanings. #### Add Links diff --git a/specification/library-guidelines.md b/specification/library-guidelines.md index 4394a43ce8d..ff46392a485 100644 --- a/specification/library-guidelines.md +++ b/specification/library-guidelines.md @@ -4,7 +4,7 @@ This document defines common principles that will help designers create language The language libraries are expected to provide full features out of the box and allow for innovation and experimentation through extensibility points. -The document does not attempt to describe a language library API. For API specs see [specification](README.md). +The document does not attempt to describe a language library API. For API specs see [specification](../README.md). ## Requirements diff --git a/specification/overview.md b/specification/overview.md index 7fbc7068d5b..b5b5b79722b 100644 --- a/specification/overview.md +++ b/specification/overview.md @@ -178,7 +178,7 @@ backend, rely on the backend to perform validation, and pass back any errors from the backend. OpenTelemetry defines the naming convention for metric names as well as a -well-known metric names in [Semantic Conventions](semantic-conventions.md) +well-known metric names in [Semantic Conventions](data-semantic-conventions.md) document. ## DistributedContext diff --git a/work_in_progress/opencensus/HTTP.md b/work_in_progress/opencensus/HTTP.md index e145cfd6484..d387a54d741 100644 --- a/work_in_progress/opencensus/HTTP.md +++ b/work_in_progress/opencensus/HTTP.md @@ -113,7 +113,7 @@ request represents the incoming request. For a client, request represents the ou All attributes are optional, but collector should make the best effort to collect those. -> Work in progress! Please note, that the list below only contains attributes that aren't contained in the [OpenTelemetry main spec](../../semantic-conventions.md) (yet): +> Work in progress! Please note, that the list below only contains attributes that aren't contained in the [OpenTelemetry main spec](../../specification/data-semantic-conventions.md) (yet): | Attribute name | Description | Type |Example value | |---------------------------|-----------------------------|--------|---------------------------| @@ -221,4 +221,4 @@ type Handler struct { // ... } -``` \ No newline at end of file +``` diff --git a/work_in_progress/opencensus/StandardResources.md b/work_in_progress/opencensus/StandardResources.md index df648c496bb..e6d85631d9a 100644 --- a/work_in_progress/opencensus/StandardResources.md +++ b/work_in_progress/opencensus/StandardResources.md @@ -12,7 +12,6 @@ OpenCensus defines these fields. * [Host](#host) * [Environment](#environment) * [Cloud](#cloud) - * [Cluster](#cluster) ## TODOs * Add logical compute units: Service, Task - instance running in a service. @@ -28,7 +27,7 @@ Resources defining a compute unit (e.g. Container, Process, Lambda Function). ### Container **type:** `container` -**Description:** A container instance. This resource can be [merged](../specification/resource/Resource.md#Merging) with a +**Description:** A container instance. This resource can be [merged](../../specification/api-resources.md#Merge) with a deployment service resource, a compute instance resource, and an environment resource. | Label | Description | Example | @@ -43,7 +42,7 @@ Resources defining a deployment service (e.g. Kubernetes). ### Kubernetes **type:** `k8s` -**Description:** A Kubernetes resource. This resource can be [merged](../specification/resource/Resource.md#Merging) with +**Description:** A Kubernetes resource. This resource can be [merged](../../specification/api-resources.md#Merge) with a compute instance resource, and/or an environment resource. | Label | Description | Example | @@ -59,7 +58,7 @@ Resources defining a computing instance (e.g. host). **type:** `host` **Description:** A host is defined as a general computing instance. This resource should be -[merged](../specification/resource/Resource.md#Merging) with an environment resource. +[merged](../../specification/api-resources.md#Merge) with an environment resource. | Label | Description | Example | @@ -83,4 +82,4 @@ Resources defining a running environment (e.g. Cloud, Data Center). | cloud.provider | Name of the cloud provider.
Example values are aws, azure, gcp. | `gcp` | | cloud.account.id | The cloud account id used to identify different entities. | `opencensus` | | cloud.region | A specific geographical location where different entities can run | `us-central1` | -| cloud.zone | Zones are a sub set of the region connected through low-latency links.
In aws it is called availability-zone. | `us-central1-a` | \ No newline at end of file +| cloud.zone | Zones are a sub set of the region connected through low-latency links.
In aws it is called availability-zone. | `us-central1-a` | diff --git a/work_in_progress/opentracing/semantic_conventions.md b/work_in_progress/opentracing/semantic_conventions.md index b5d80cf02d7..ddbcfdfab3d 100644 --- a/work_in_progress/opentracing/semantic_conventions.md +++ b/work_in_progress/opentracing/semantic_conventions.md @@ -14,7 +14,7 @@ Changes to this file affect the OpenTracing specification version. Additions sho Span tags apply to **the entire Span**; as such, they apply to the entire timerange of the Span, not a particular moment with a particular timestamp: those sorts of events are best modelled as Span log fields (per the table in the next subsection of this document). -> Work in progress! Please note, that the list below only contains attributes that aren't contained in the [OpenTelemetry main spec](../../semantic-conventions.md) (yet): +> Work in progress! Please note, that the list below only contains attributes that aren't contained in the [OpenTelemetry main spec](../../specification/data-semantic-conventions.md) (yet): | Span tag name | Type | Notes and examples | |:--------------|:-----|:-------------------| @@ -74,4 +74,4 @@ For other languages, or when above is not feasible: - stack=`"..."` (optional) - error.kind=`"..."` (optional) -This scheme allows Tracer implementations to extract what information they need from the actual error object when it's available. \ No newline at end of file +This scheme allows Tracer implementations to extract what information they need from the actual error object when it's available. diff --git a/work_in_progress/specification/README.md b/work_in_progress/specification/README.md index 6edc65623e9..8c72d2df411 100644 --- a/work_in_progress/specification/README.md +++ b/work_in_progress/specification/README.md @@ -12,7 +12,7 @@ The OpenTracing specification uses a `Major.Minor` version number but has no `.P ## The OpenTracing Data Model -... moved to [terminology.md](../../terminology.md) ... +... moved to [terminology.md](../../specification/overview.md) ... Each **Span** encapsulates the following state: @@ -37,7 +37,7 @@ Each **SpanContext** encapsulates the following state: ### References between Spans OpenTelemetry doesn't support references. Links are described in -[terminology.md](../../terminology.md) +[terminology.md](../../specification/overview.md) > A Span may reference zero or more other **SpanContexts** that are causally related. OpenTracing presently defines two types of references: `ChildOf` and `FollowsFrom`. **Both reference types specifically model direct causal relationships between a child Span and a parent Span.** In the future, OpenTracing may also support reference types for Spans with non-causal relationships (e.g., Spans that are batched together, Spans that are stuck in the same queue, etc). > @@ -139,7 +139,7 @@ Both injection and extraction rely on an extensible **format** parameter that di ### `Span` -... moved to [specs](../../specification/tracing-api.md)... +... moved to [specs](../../specification/api-tracing.md)... #### Set a **baggage** item diff --git a/work_in_progress/specification/trace/LogCorrelation.md b/work_in_progress/specification/trace/LogCorrelation.md index 0ffdfa7c928..3e893ba1a3d 100644 --- a/work_in_progress/specification/trace/LogCorrelation.md +++ b/work_in_progress/specification/trace/LogCorrelation.md @@ -23,16 +23,16 @@ span context available in each log entry: ### Trace ID -The trace ID of the current span. See [Span.md#traceid](Span.md#traceid). +The trace ID of the current span. See [SpanContext](../overview.md#spancontext). ### Span ID -The span ID of the current span. See [Span.md#spanid](Span.md#spanid). +The span ID of the current span. See [SpanContext](../overview.md#spancontext). ### Sampling Decision The sampling bit of the current span, as a boolean. See -[Span.md#supported-bits](Span.md#supported-bits). +[SpanContext](../overview.md#spancontext). TODO(sebright): Include "samplingScore" once that field is added to the SpanContext. diff --git a/work_in_progress/specification/trace/README.md b/work_in_progress/specification/trace/README.md index f0ce69b89e3..7b52c537db2 100644 --- a/work_in_progress/specification/trace/README.md +++ b/work_in_progress/specification/trace/README.md @@ -5,7 +5,7 @@ * [TraceConfig](TraceConfig.md) ## Utils -* [gRPC integration](gRPC.md): document about how to instrument gRPC framework. -* [HTTP integration](HTTP.md): document about how to instrument http frameworks. +* [gRPC integration](../../gRPC/gRPC.md): document about how to instrument gRPC framework. +* [HTTP integration](../../opencensus/HTTP.md): document about how to instrument http frameworks. * [Sampling logic](Sampling.md): document about how sampling works. * [Log correlation](LogCorrelation.md): specification for a feature for inserting tracing data into log entries. diff --git a/work_in_progress/specification/trace/Span.md b/work_in_progress/specification/trace/Span.md index 8e8576b2a88..9e96b128c4d 100644 --- a/work_in_progress/specification/trace/Span.md +++ b/work_in_progress/specification/trace/Span.md @@ -1,7 +1,7 @@ # Span -... parts of this document moved to [terminology.md](../../../terminology.md) ... +... parts of this document moved to [overview.md](../../../specification/overview.md) ... A span contains a SpanContext and allows users to record tracing events based on the data model defined [here][SpanDataModel]. diff --git a/work_in_progress/typedspans/README.md b/work_in_progress/typedspans/README.md index 2ee7d8d3874..2e0ae06b962 100644 --- a/work_in_progress/typedspans/README.md +++ b/work_in_progress/typedspans/README.md @@ -42,7 +42,7 @@ See [this document by @discostu105](https://docs.google.com/spreadsheets/d/1H0S0 Represents an outbound HTTP request. ##### Attributes -These attributes are not covered in the [main spec](../../semantic-conventions.md): +These attributes are not covered in the [main spec](../../specification/data-semantic-conventions.md): - Route - User Agent @@ -55,7 +55,7 @@ Represents an inbound HTTP request. ##### Attributes -These attributes are not covered in the [main spec](../../semantic-conventions.md): +These attributes are not covered in the [main spec](../../specification/data-semantic-conventions.md): - User Agent - Webserver Name @@ -69,7 +69,7 @@ Represents a database call. ##### Attributes -These attributes are not covered in the [main spec](../../semantic-conventions.md): +These attributes are not covered in the [main spec](../../specification/data-semantic-conventions.md): - Channel Type (e.g. TCP) @@ -78,7 +78,7 @@ Represents an outbound gRPC request. ##### Attributes -These attributes are not covered in the [main spec](../../semantic-conventions.md): +These attributes are not covered in the [main spec](../../specification/data-semantic-conventions.md): - Channel Type (e.g. TCP) @@ -87,7 +87,7 @@ Represents an inbound gRPC request. ##### Attributes -These attributes are not covered in the [main spec](../../semantic-conventions.md): +These attributes are not covered in the [main spec](../../specification/data-semantic-conventions.md): - Channel Type (e.g. TCP)