Skip to content

Commit be265ab

Browse files
authored
Fix site links into updated spec pages (open-telemetry#3397)
1 parent d350a17 commit be265ab

File tree

31 files changed

+86
-103
lines changed

31 files changed

+86
-103
lines changed

.htmltest.yml

-4
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
1111
- ^/community/end-user/feedback-survey/$
1212
- ^(/docs/migration/)?opencensus/$
1313

14-
# TODO(@chalin) remove once the website pages have caught up with latest semconv changes:
15-
- ^/docs/specs/otel/\w+/semantic_conventions
16-
- \#instrument-advice
17-
1814
- ^https://deploy-preview-\d+--opentelemetry.netlify.app/
1915
- ^https://www\.googletagmanager\.com
2016

content/en/blog/2022/debug-otel-with-otel/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ COPY opentelemetry_module.conf /etc/nginx/conf.d
254254
/blog/2022/instrument-nginx/#put-nginx-between-two-services
255255
[localhost:16686]: http://localhost:16686/
256256
[http request & response headers]:
257-
/docs/specs/otel/trace/semantic_conventions/http/#http-request-and-response-headers
257+
/docs/specs/semconv/http/http-spans/#common-attributes
258258
[rfc7230]: https://httpwg.org/specs/rfc7230.html#field.order
259259
[added some checks to the module for nginx]:
260260
https://github.com/open-telemetry/opentelemetry-cpp-contrib/pull/204

content/en/blog/2022/instrument-kafka-clients/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ difficult to track how messages are moved around. This is where OpenTelemetry
2323
comes into the picture. It provides multiple instrumentation libraries for
2424
adding tracing to messaging based applications. Of course, there is one for
2525
Apache Kafka clients. It also defines the specification of semantic conventions
26-
for [messaging systems](/docs/specs/otel/trace/semantic_conventions/messaging/).
26+
for [messaging systems](/docs/specs/semconv/messaging/messaging-spans/).
2727

2828
But usually, the architecture can even be more complicated: having applications
2929
not able to connect directly to the Apache Kafka cluster and talking its own

content/en/blog/2022/k8s-metadata/index.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -248,14 +248,13 @@ sidecar, or when one collector as an agent report to another collector.
248248

249249
- [K8sattributes processor documentation][k8sattributesprocessor]
250250
- [K8sattributes processor RBAC](https://pkg.go.dev/github.com/open-telemetry/opentelemetry-collector-contrib/processor/k8sattributesprocessor#hdr-RBAC)
251-
- [OpenTelemetry Kubernetes attributes](/docs/specs/otel/resource/semantic_conventions/k8s)
251+
- [OpenTelemetry Kubernetes attributes](/docs/specs/semconv/resource/k8s)
252252
- [Resource detector processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/resourcedetectionprocessor/README.md)
253253

254254
[pr#832]: https://github.com/open-telemetry/opentelemetry-operator/pull/832
255255
[opentelemetry operator]:
256256
https://github.com/open-telemetry/opentelemetry-operator
257257
[k8sattributesprocessor]:
258258
https://pkg.go.dev/github.com/open-telemetry/opentelemetry-collector-contrib/processor/k8sattributesprocessor
259-
[kubernetes resource semantic conventions]:
260-
/docs/specs/otel/resource/semantic_conventions/k8s
259+
[kubernetes resource semantic conventions]: /docs/specs/semconv/resource/k8s
261260
[vert.x example app]: https://github.com/jaegertracing/vertx-create-span

content/en/blog/2022/knative/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ might not have an immediate impact on the user, however, it will enable users to
162162
start natively reporting data in OpenTelemetry format (OTLP).
163163

164164
Another recently merged change is the addition of
165-
[Cloudevents semantic attributes into the OpenTelemetry specification](/docs/specs/otel/trace/semantic_conventions/cloudevents).
165+
[Cloudevents semantic attributes into the OpenTelemetry specification](/docs/specs/semconv/cloudevents/cloudevents-spans/).
166166
The document standardizes attributes related to CloudEvents. The screenshot
167167
below is from the demo application that is still not using the standardized
168168
attribute names:
@@ -210,5 +210,5 @@ instrumentation libraries explicitly in the code or even
210210
- [Zipkin B3](https://github.com/openzipkin/b3-propagation)
211211
- [W3C Trace-Context](https://www.w3.org/TR/trace-context/)
212212
- [OpenTelemetry instrumentation for Cloudevents Golang SDK](https://github.com/cloudevents/sdk-go/tree/main/observability/opentelemetry/v2)
213-
- [Cloudevents OpenTelemetry attributes](/docs/specs/otel/trace/semantic_conventions/cloudevents/)
213+
- [Cloudevents OpenTelemetry attributes](/docs/specs/semconv/cloudevents/cloudevents-spans/)
214214
- [Knative tracing demo](https://github.com/pavolloffay/knative-tracing)

content/en/blog/2023/http-conventions-stability.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ cSpell:ignore: stalnaker trask
77
---
88

99
The OpenTelemetry community is beginning the final push to declare HTTP
10-
[tracing](/docs/specs/otel/trace/semantic_conventions/http/) and
11-
[metrics](/docs/specs/otel/metrics/semantic_conventions/http-metrics/) semantic
12-
conventions stable!
10+
[tracing](/docs/specs/semconv/http/http-spans/) and
11+
[metrics](/docs/specs/semconv/http/http-metrics/) semantic conventions stable!
1312

1413
Following the recently proposed
1514
[Semantic Convention Process](https://docs.google.com/document/d/1ghvajKaipiNZso3fDtyNxU7x1zx0_Eyd02OGpMGEpLE),

content/en/docs/collector/trace-receiver.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -1467,7 +1467,7 @@ minimize the conflicts across all the different types of telemetry generation
14671467
entities that it may need to represent.
14681468

14691469
These guidelines are known as Resource Semantic Conventions and are
1470-
[documented in the OTel specification](/docs/specs/otel/resource/semantic_conventions/).
1470+
[documented in the OTel specification](/docs/specs/semconv/resource/).
14711471

14721472
When creating your own attributes to represent your own telemetry generation
14731473
entities, you should follow the guideline provided by the specification:
@@ -1509,15 +1509,14 @@ func fillResourceWithAtm(resource *pcommon.Resource, atm Atm){
15091509
The resource semantic conventions also have prescriptive attribute names and
15101510
well-known values to represent telemetry generation entities that are common and
15111511
applicable across different domains like
1512-
[compute unit](/docs/specs/otel/resource/semantic_conventions/#compute-unit),
1513-
[environment](/docs/specs/otel/resource/semantic_conventions/#compute-unit) and
1514-
others.
1512+
[compute unit](/docs/specs/semconv/resource/#compute-unit),
1513+
[environment](/docs/specs/semconv/resource/#compute-unit) and others.
15151514

15161515
So, when you look at the `BackendSystem` entity, it has fields representing
1517-
[OS](/docs/specs/otel/resource/semantic_conventions/os/) related information and
1518-
[Cloud](/docs/specs/otel/resource/semantic_conventions/cloud/) related
1519-
information, and we will use the attribute names and values prescribed by the
1520-
resource semantic convention to represent that information on its `Resource`.
1516+
[OS](/docs/specs/semconv/resource/os/) related information and
1517+
[Cloud](/docs/specs/semconv/resource/cloud/) related information, and we will
1518+
use the attribute names and values prescribed by the resource semantic
1519+
convention to represent that information on its `Resource`.
15211520

15221521
All the resource semantic convention attribute names and well known-values are
15231522
kept within the

content/en/docs/collector/transforming-telemetry.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ processors:
8282
```
8383
8484
The resource processor has an identical configuration, but applies only to
85-
[resource attributes](/docs/specs/otel/resource/semantic_conventions/). Use the
86-
resource processor to modify infrastructure metadata related to telemetry. For
87-
example, this inserts the Kubernetes cluster name:
85+
[resource attributes](/docs/specs/semconv/resource/). Use the resource processor
86+
to modify infrastructure metadata related to telemetry. For example, this
87+
inserts the Kubernetes cluster name:
8888
8989
```yaml
9090
processors:

content/en/docs/concepts/glossary.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -356,11 +356,11 @@ on web pages when requested. See [more][zpages].
356356

357357
### Semantic Conventions
358358

359-
#### **[Resource Conventions](/docs/specs/otel/resource/semantic_conventions)**
359+
#### **[Resource Conventions](/docs/specs/semconv/resource/)**
360360

361-
#### **[Span Conventions](/docs/specs/otel/trace/semantic_conventions)**
361+
#### **[Span Conventions](/docs/specs/semconv/general/trace/)**
362362

363-
#### **[Metric Conventions](/docs/specs/otel/metrics/semantic_conventions)**
363+
#### **[Metric Conventions](/docs/specs/semconv/general/metrics/)**
364364

365365
[baggage]: /docs/specs/otel/baggage/api/
366366
[attribute]: /docs/specs/otel/common/#attributes

content/en/docs/concepts/instrumentation/libraries.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,9 @@ and document hooks:
2424

2525
## Semantic Conventions
2626

27-
Check out available
28-
[semantic conventions](/docs/specs/otel/trace/semantic_conventions/) that cover
29-
web-frameworks, RPC clients, databases, messaging clients, infra pieces and
30-
more!
27+
Check out available [semantic conventions](/docs/specs/semconv/general/trace/)
28+
that cover web-frameworks, RPC clients, databases, messaging clients, infra
29+
pieces and more!
3130

3231
If your library is one of those things - follow the conventions, they are the
3332
main source of truth and tell which information should be included on spans.
@@ -199,8 +198,7 @@ private Response selectWithTracing(Query query) {
199198
```
200199

201200
Follow conventions to populate attributes! If there is no applicable one, check
202-
out
203-
[general conventions](/docs/specs/otel/trace/semantic_conventions/span-general/).
201+
out [general conventions](/docs/specs/semconv/general/attributes/).
204202

205203
### Nested network and other spans
206204

@@ -298,8 +296,8 @@ In the case of a messaging system, you may receive more than one message at
298296
once. Received messages become
299297
[_links_](/docs/instrumentation/java/manual/#create-spans-with-links) on the
300298
span you create. Refer to
301-
[messaging conventions](/docs/specs/otel/trace/semantic_conventions/messaging/)
302-
for details (WARNING: messaging conventions are
299+
[messaging conventions](/docs/specs/semconv/messaging/messaging-spans/) for
300+
details (WARNING: messaging conventions are
303301
[under constructions](https://github.com/open-telemetry/oteps/pull/173) 🚧).
304302

305303
### Injecting context

content/en/docs/concepts/sdk-configuration/general-sdk-configuration.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ cSpell:ignore: ottrace
88

99
## `OTEL_SERVICE_NAME`
1010

11-
Sets the value of the
12-
[`service.name`](/docs/specs/otel/resource/semantic_conventions/#service)
11+
Sets the value of the [`service.name`](/docs/specs/semconv/resource/#service)
1312
resource attribute.
1413

1514
**Default value:** `"unknown_service"`
@@ -30,7 +29,7 @@ for more details.
3029
**Default value:** Empty.
3130

3231
See
33-
[Resource semantic conventions](/docs/specs/otel/resource/semantic_conventions/#semantic-attributes-with-sdk-provided-default-value)
32+
[Resource semantic conventions](/docs/specs/semconv/resource/#semantic-attributes-with-sdk-provided-default-value)
3433
for semantic conventions to follow for common resource types.
3534

3635
**Example:**

content/en/docs/concepts/semantic-conventions.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ description: Common names for different kinds of operations and data.
44
weight: 30
55
---
66

7-
OpenTelemetry defines Semantic Conventions (sometimes called Semantic
8-
Attributes) that specify common names for different kinds of operations and
9-
data. The benefit to using Semantic Conventions is in following a common naming
10-
scheme that can be standardized across a codebase, libraries, and platforms.
7+
OpenTelemetry defines [Semantic Conventions](/docs/specs/semconv/) (sometimes
8+
called Semantic Attributes) that specify common names for different kinds of
9+
operations and data. The benefit to using Semantic Conventions is in following a
10+
common naming scheme that can be standardized across a codebase, libraries, and
11+
platforms.
1112

1213
Currently, Semantic Conventions are available for traces, metrics and resources:
1314

14-
- [Trace Semantic Conventions](/docs/specs/otel/trace/semantic_conventions/)
15-
- [Metric Semantic Conventions](/docs/specs/otel/metrics/semantic_conventions/)
16-
- [Resource Semantic Conventions](/docs/specs/otel/resource/semantic_conventions/)
15+
- [Trace Semantic Conventions](/docs/specs/semconv/general/trace/)
16+
- [Metric Semantic Conventions](/docs/specs/semconv/general/metrics/)
17+
- [Resource Semantic Conventions](/docs/specs/semconv/resource/)

content/en/docs/concepts/signals/metrics.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ instrument is defined by:
4949
- Description (optional)
5050

5151
The name, unit, and description are chosen by the developer or defined via
52-
[semantic conventions](/docs/specs/otel/metrics/semantic_conventions/) for
53-
common ones like request and process metrics.
52+
[semantic conventions](/docs/specs/semconv/general/metrics/) for common ones
53+
like request and process metrics.
5454

5555
The instrument kind is one of the following:
5656

content/en/docs/concepts/signals/traces.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -268,10 +268,10 @@ Attributes have the following rules that each language SDK implements:
268268
an array of these values
269269

270270
Additionally, there are
271-
[Semantic Attributes](/docs/specs/otel/trace/semantic_conventions/), which are
272-
known naming conventions for metadata that is typically present in common
273-
operations. It's helpful to use semantic attribute naming wherever possible so
274-
that common kinds of metadata are standardized across systems.
271+
[Semantic Attributes](/docs/specs/semconv/general/trace/), which are known
272+
naming conventions for metadata that is typically present in common operations.
273+
It's helpful to use semantic attribute naming wherever possible so that common
274+
kinds of metadata are standardized across systems.
275275

276276
### Span Events
277277

content/en/docs/demo/services/ad.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ The following custom metrics are currently available:
119119

120120
The following auto-instrumented metrics are available for the application:
121121

122-
- [Runtime metrics for the JVM](/docs/specs/otel/metrics/semantic_conventions/runtime-environment-metrics/#jvm-metrics).
123-
- [Latency metrics for RPCs](/docs/specs/otel/metrics/semantic_conventions/rpc-metrics/#rpc-server)
122+
- [Runtime metrics for the JVM](/docs/specs/semconv/runtime/jvm-metrics/).
123+
- [Latency metrics for RPCs](/docs/specs/semconv/rpc/rpc-metrics/#rpc-server)
124124

125125
## Logs
126126

content/en/docs/instrumentation/erlang/resources.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@ Custom resource detectors can be created by implementing the
8989
which contains a single callback `get_resource/1` that returns an
9090
[`otel_resource`](https://hexdocs.pm/opentelemetry/1.3.0/otel_resource.html).
9191

92-
Note that there are
93-
[semantic conventions](/docs/specs/otel/resource/semantic_conventions/) defined
94-
for `resource` that should be followed if they apply when adding new resource
95-
attributes.
92+
Note that there are [semantic conventions](/docs/specs/semconv/resource/)
93+
defined for `resource` that should be followed if they apply when adding new
94+
resource attributes.

content/en/docs/instrumentation/go/manual.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -890,7 +890,7 @@ You’ll also want to configure an appropriate exporter to
890890
telemetry backends.
891891

892892
[opentelemetry specification]: /docs/specs/otel/
893-
[trace semantic conventions]: /docs/specs/otel/trace/semantic_conventions/
893+
[trace semantic conventions]: /docs/specs/semconv/general/trace/
894894
[instrumentation library]: ../libraries/
895895
[`go.opentelemetry.io/otel`]: https://pkg.go.dev/go.opentelemetry.io/otel
896896
[`go.opentelemetry.io/otel/exporters/stdout/stdoutmetric`]:

content/en/docs/instrumentation/java/automatic/agent-config.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,9 @@ Common settings that apply to multiple instrumentations at once.
107107
### Peer service name
108108

109109
The
110-
[peer service name](/docs/specs/otel/trace/semantic_conventions/span-general/#general-remote-service-attributes)
110+
[peer service name](/docs/specs/semconv/general/attributes/#general-remote-service-attributes)
111111
is the name of a remote service to which a connection is made. It corresponds to
112-
`service.name` in the
113-
[resource](/docs/specs/otel/resource/semantic_conventions/#service) for the
112+
`service.name` in the [resource](/docs/specs/semconv/resource/#service) for the
114113
local service.
115114

116115
{{% config_option name="otel.instrumentation.common.peer-service-mapping" %}}
@@ -159,7 +158,7 @@ following property to disable it:
159158

160159
You can configure the agent to capture predefined HTTP headers as span
161160
attributes, according to the
162-
[semantic convention](/docs/specs/otel/trace/semantic_conventions/http/#http-request-and-response-headers).
161+
[semantic convention](/docs/specs/semconv/http/http-spans/#common-attributes).
163162
Use the following properties to define which HTTP headers you want to capture:
164163

165164
{{% config_option name="otel.instrumentation.http.client.capture-request-headers" %}}

content/en/docs/instrumentation/java/manual.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -837,7 +837,7 @@ span.setAttribute("http.url", url.toString());
837837
There are semantic conventions for spans representing operations in well-known
838838
protocols like HTTP or database calls. Semantic conventions for these spans are
839839
defined in the specification at
840-
[Trace Semantic Conventions](/docs/specs/otel/trace/semantic_conventions/).
840+
[Trace Semantic Conventions](/docs/specs/semconv/general/trace/).
841841

842842
First add the semantic conventions as a dependency to your application:
843843

content/en/docs/instrumentation/java/resources.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,10 @@ resource detection below.
1717
## Detecting resources from common environments
1818

1919
You can use `ResourceProvider`s for filling in attributes related to common
20-
environments, like
21-
[Container](/docs/specs/otel/resource/semantic_conventions/container/),
22-
[Host](/docs/specs/otel/resource/semantic_conventions/host/) or
23-
[Operating System](/docs/specs/otel/resource/semantic_conventions/os/). These
24-
can be used with or without
20+
environments, like [Container](/docs/specs/semconv/resource/container/),
21+
[Host](/docs/specs/semconv/resource/host/) or
22+
[Operating System](/docs/specs/semconv/resource/os/). These can be used with or
23+
without
2524
[auto-configuration](/docs/instrumentation/java/manual/#automatic-configuration).
2625

2726
To use those providers, add the following dependency:

content/en/docs/instrumentation/js/manual.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -920,8 +920,8 @@ function rollTheDice(rolls, min, max) {
920920
There are semantic conventions for spans representing operations in well-known
921921
protocols like HTTP or database calls. Semantic conventions for these spans are
922922
defined in the specification at
923-
[Trace Semantic Conventions](/docs/specs/otel/trace/semantic_conventions/). In
924-
the simple example of this guide the source code attributes can be used.
923+
[Trace Semantic Conventions](/docs/specs/semconv/general/trace/). In the simple
924+
example of this guide the source code attributes can be used.
925925

926926
First add the semantic conventions as a dependency to your application:
927927

content/en/docs/instrumentation/js/resources.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -254,11 +254,9 @@ list
254254
[here](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node).
255255
256256
[getting started - node.js]: /docs/instrumentation/js/getting-started/nodejs/
257-
[process and process runtime resources]:
258-
/docs/specs/otel/resource/semantic_conventions/process/
259-
[host]: /docs/specs/otel/resource/semantic_conventions/host/
260-
[cloud]: /docs/specs/otel/resource/semantic_conventions/cloud/
261-
[deployment]:
262-
/docs/specs/otel/resource/semantic_conventions/deployment_environment/
263-
[service]: /docs/specs/otel/resource/semantic_conventions/#service
264-
[os]: /docs/specs/otel/resource/semantic_conventions/os/
257+
[process and process runtime resources]: /docs/specs/semconv/resource/process/
258+
[host]: /docs/specs/semconv/resource/host/
259+
[cloud]: /docs/specs/semconv/resource/cloud/
260+
[deployment]: /docs/specs/semconv/resource/deployment-environment/
261+
[service]: /docs/specs/semconv/resource/#service
262+
[os]: /docs/specs/semconv/resource/os/

0 commit comments

Comments
 (0)