Skip to content

Commit ec400b4

Browse files
authored
Merge branch 'main' into add-adot-instr
2 parents 044dec5 + b7e4073 commit ec400b4

File tree

397 files changed

+5143
-2201
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

397 files changed

+5143
-2201
lines changed

.github/workflows/check-file.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Files
2+
3+
on:
4+
merge_group:
5+
pull_request:
6+
7+
jobs:
8+
check-expired:
9+
name: EXPIRED FILE check
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- run: npm run check:expired
14+
- run: npm run _diff:fail
15+
16+
check-filenames:
17+
name: FILENAME check
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- run: npm run check:filenames
22+
23+
check-formatting:
24+
name: FILE FORMAT
25+
runs-on: ubuntu-latest
26+
steps:
27+
- uses: actions/checkout@v4
28+
- run: npm run check:format

.github/workflows/check-format.yml

-39
This file was deleted.

.github/workflows/check-spelling.yml

+6-3
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,19 @@ jobs:
2626
suggestions: true
2727

2828
dict-check:
29-
name: CSPELL:IGNORE check
29+
name: CSPELL page-local word list check
3030
runs-on: ubuntu-latest
31+
env:
32+
FIX_CMD: fix:dict
3133
steps:
3234
- uses: actions/checkout@v4
33-
- run: npm run fix:dict
35+
- run: npm run ${{ env.FIX_CMD }}
3436
- name: Any changed files?
3537
run: |
3638
CHANGES=`git status --porcelain`
3739
if [[ $CHANGES ]]; then
38-
echo "Locally run `npm run fix:dict` and commit the changes:"
40+
echo "Add comment '/fix:${{ env.FIX_CMD }}' to your PR in GitHub,"
41+
echo "or locally run 'npm run ${{ env.FIX_CMD }}' and commit the changes:"
3942
echo "$CHANGES"
4043
exit 1
4144
else

.github/workflows/update-semconv-integration-branch.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,9 @@ jobs:
8686
8787
sed -i "s/^\tsemconv-pin = .*/\tsemconv-pin = $commit_desc/" .gitmodules
8888
89-
if ! git diff-index --quiet HEAD; then
89+
git add -A
90+
91+
if ! git diff-index --quiet --cached HEAD; then
9092
git commit -am "Update semconv submodule to $commit_desc"
9193
git push
9294
fi

.gitmodules

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[submodule "themes/docsy"]
33
path = themes/docsy
44
url = https://github.com/google/docsy.git
5-
docsy-pin = v0.11.0-38-g77da7e49
5+
docsy-pin = v0.11.0-44-gcbc714be
66
docsy-note = "2024-04-01 Switching to google/docsy.git from cncf/docsy.git since we don't have any CNCF customizations."
77
docsy-reminder = "Ensure that any tag referenced by `docsy-pin` is present in the remote repo (url), otherwise add (push) the tags to the repo."
88
[submodule "content-modules/opentelemetry-specification"]

.htmltest.yml

+31-8
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ IgnoreAltMissing: true
55
IgnoreCanonicalBrokenLinks: false
66
IgnoreInternalEmptyHash: true # TODO: remove after resolution of https://github.com/google/docsy/issues/1995
77
CheckMailto: false
8+
# StripQueryString: false # TODO: enable once htmltest is fixed
89
TestFilesConcurrently: true
910
IgnoreDirs:
1011
# DO NOT EDIT! IgnoreDirs list is auto-generated from markdown file front matter.
@@ -54,22 +55,44 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
5455

5556
# Ignore Docsy-generated GitHub links for now, until
5657
# https://github.com/google/docsy/issues/1432 is fixed
57-
- ^https?://github\.com/.*?/.*?/(new|edit|issues/new\?title)/ # view-page, edit-source etc
58-
# Here's an approximate regex to avoid the "View page source" links. TODO: fix this in Docsy
59-
- ^https?://github\.com/open-telemetry/opentelemetry.io/tree/
60-
# FIXME: A patch until we can get Docsy to mark "View page source" links as excluded from link checking,
61-
# Actually, it would be better to pin the version of the OTel spec.
62-
- ^https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/logs/event-(api|sdk)\.md
58+
- ^https?://github\.com/.*?/.*?/(new/|edit/|issues/new\?) # view-page, edit-source etc
59+
# Ignore "View page source" links, except for spec pages, i.e., links starting with
60+
# https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/specs
61+
- ^https://github\.com/open-telemetry/opentelemetry.io/tree/main/content/[^e]
62+
- ^https://github\.com/open-telemetry/opentelemetry.io/tree/main/content/es
63+
- ^https://github\.com/open-telemetry/opentelemetry.io/tree/main/content/en/.*?/_index.md$
64+
- ^https://github\.com/open-telemetry/opentelemetry.io/tree/main/content/en/[^d]
65+
- ^https://github\.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/[^s]
66+
- ^https://github\.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/security
6367
# FIXME: same issue as for the OTel spec mentioned above:
6468
- ^https://github.com/open-telemetry/semantic-conventions/tree/main
6569

6670
# Too many redirects as the server tries to figure out the country and language,
6771
# e.g.: https://www.microsoft.com/en-ca/sql-server.
6872
- ^https://www.microsoft.com/sql-server$
6973

70-
# TODO: drop after fix to https://github.com/rust-lang/crates.io/issues/788
71-
- ^https://crates\.io/crates
7274
# TODO move into content/en/blog/2023/humans-of-otel.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
7375
- ^https://shorturl.at/osHRX$
7476
# TODO move into content/en/blog/2023/contributing-to-otel/index.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
7577
- ^https://shorturl.at/vLYZ0$
78+
79+
# Temporary until semconv is updated to 1.30.0+
80+
- ^https://cloud.google.com/apis/design/resource_names#full_resource_name
81+
- ^https://cloud.google.com/functions/docs/concepts/exec#function_scope_versus_global_scope
82+
- ^https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902
83+
- ^https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest
84+
- ^https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES
85+
- ^https://www.erlang.org/doc/man/erl_error.html#format_exception-3
86+
# Fixed via https://github.com/open-telemetry/semantic-conventions/pull/1814
87+
- ^https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/specification/logs/api.md#emit-an-event
88+
89+
# Temporary until
90+
# https://pkg.go.dev/go.opentelemetry.io/collector/config/[email protected]+
91+
# is published to include
92+
# https://github.com/open-telemetry/opentelemetry-collector/pull/12309
93+
- ^https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#client-authenticators
94+
- ^https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#server-authenticators
95+
96+
# Temporary until
97+
# https://github.com/open-telemetry/opentelemetry.io/issues/6237 is resolved
98+
- ^https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#

.textlintrc.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,11 @@ rules:
113113
# https://github.com/sapegin/textlint-rule-terminology/blob/ca36a645c56d21f27cb9d902b5fb9584030c59e3/index.js#L137-L142.
114114
#
115115
- ['3rd[- ]party', third-party]
116-
- ['auto[- ]c(onfigur)(es?|ations?)', 'autoc$1$2'] # cspell:ignore autoc ations onfigur
116+
- ['auto[- ]c(onfigur)(es?|ations?)', 'autoc$1$2'] # cSpell:disable-line
117117
- ['back[- ]end(s)?', 'backend$1']
118118
- [bugfix, bug fix]
119119
- [byte code, bytecode]
120+
- ['(cloud)-(native)', '$1 $2']
120121
- [cpp, C++]
121122
- # dotnet|.net -> .NET, but NOT for strings like:
122123
# - File extension: file.net

content/en/announcements/_index.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
title: Announcements
33
cascade:
44
type: docs
5+
params:
6+
hide_feedback: true
57
---
+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: KubeCon + CloudNativeCon Europe 2025
3+
linkTitle: KubeCon EU 2025
4+
date: 2025-02-03
5+
expiryDate: 2025-04-04
6+
---
7+
8+
<i class="fas fa-bullhorn"></i> [**{{% param title %}}**][LF],
9+
**<span class="text-nowrap">April 1 - 4,</span> London England**.
10+
<span class="d-none d-md-inline"><br></span> Come collaborate, learn, and
11+
share<span class="d-none d-sm-inline"> with the Cloud Native community</span>!
12+
13+
[LF]:
14+
https://events.linuxfoundation.org/kubecon-cloudnativecon-europe/register/?utm_source=opentelemetry&utm_medium=all&utm_campaign=KubeCon-EU-2025&utm_content=slim-banner

content/en/blog/2019/opentelemetry-governance-committee-explained/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ community by establishing processes. Let me explain.
1717
![Watering can](watering-can.jpeg)
1818

1919
The main objective of the OpenTelemetry project is to make robust, portable
20-
telemetry a built-in feature of cloud-native software. The most effective way to
20+
telemetry a built-in feature of cloud native software. The most effective way to
2121
do it is to build a community of passionate people, from existing ecosystem with
2222
the diverse expertise and experience. This community will build a project that
2323
is attractive to users, who will use it to instrument their software, as well as
@@ -77,4 +77,4 @@ feedback!
7777
_A version of this article was [originally posted][] on
7878
[medium.com/opentelemetry](https://medium.com/opentelemetry)._
7979

80-
[originally posted]: {{% param canonical_url %}}
80+
[originally posted]: <{{% param canonical_url %}}>

content/en/blog/2021/auto-instrumentation-k8s.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ This article introduces OpenTelemetry Operator’s new feature that significantl
99
simplifies instrumenting workloads deployed on Kubernetes. Read all the details
1010
from the [original post][].
1111

12-
[original post]: {{% param canonical_url %}}
12+
[original post]: <{{% param canonical_url %}}>

content/en/blog/2021/collector.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ canonical_url: https://medium.com/opentelemetry/opentelemetry-collector-achieves
88
The OpenTelemetry Collector has made its first GA release. For all the details,
99
see the [original post][].
1010

11-
[original post]: {{% param canonical_url %}}
11+
[original post]: <{{% param canonical_url %}}>

content/en/blog/2021/cpp.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ OpenTelemetry C++ released its v1.0 stable version last month, which implements
99
the OpenTelemetry distributed tracing specification! For all the details, see
1010
the [original post][].
1111

12-
[original post]: {{% param canonical_url %}}
12+
[original post]: <{{% param canonical_url %}}>

content/en/blog/2021/gc-election.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ The OpenTelemetry project is excited to announce the 2021 OpenTelemetry
99
Governance Committee (GC) election. For all the details, see the [original
1010
post][].
1111

12-
[original post]: {{% param canonical_url %}}
12+
[original post]: <{{% param canonical_url %}}>

content/en/blog/2021/malabi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ cSpell:ignore: Malabi
1010
This article introduces you to Malabi, a new open source tool for trace-based
1111
testing. For all the details, see the [original post][].
1212

13-
[original post]: {{% param canonical_url %}}
13+
[original post]: <{{% param canonical_url %}}>

content/en/blog/2021/otel-gc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ canonical_url: https://medium.com/opentelemetry/welcome-to-the-incoming-2021-ope
88
The OpenTelemetry project just completed its 2021 election for the Governance
99
Committee (GC). For all the details, see the [original post][].
1010

11-
[original post]: {{% param canonical_url %}}
11+
[original post]: <{{% param canonical_url %}}>

content/en/blog/2021/python.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ canonical_url: https://medium.com/opentelemetry/announcing-opentelemetry-python-
88
Today, OpenTelemetry Python distributed tracing API/SDK released its 1.0
99
version. For all the details, see the [original post][].
1010

11-
[original post]: {{% param canonical_url %}}
11+
[original post]: <{{% param canonical_url %}}>

content/en/blog/2021/swift.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ canonical_url: https://medium.com/opentelemetry/opentelemetry-swift-1-0-beta-8f7
88
Today, OpenTelemetry Swift distributed tracing API/SDK has released its 1.0
99
version. For all the details, see the [original post][].
1010

11-
[original post]: {{% param canonical_url %}}
11+
[original post]: <{{% param canonical_url %}}>

content/en/blog/2021/womens-day.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ Happy International Women’s Day! The OpenTelemetry project would like to exten
99
our thanks to all our women contributors. For all the details, see the [original
1010
post][].
1111

12-
[original post]: {{% param canonical_url %}}
12+
[original post]: <{{% param canonical_url %}}>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -395,4 +395,4 @@ _A version of this article was [originally posted][] on the Apache APISIX blog._
395395

396396
[^1]: {{% param notes.docker-compose-v2 %}}
397397

398-
[originally posted]: {{% param canonical_url %}}
398+
[originally posted]: <{{% param canonical_url %}}>

content/en/blog/2022/demo-announcement/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ ourselves to just the items listed here.
126126
- Demonstrations of the ability to add
127127
[Baggage](https://github.com/open-telemetry/opentelemetry-demo/issues/100) and
128128
other custom tags
129-
- Continue to build on other cloud-native technologies like:
129+
- Continue to build on other cloud native technologies like:
130130
- Kubernetes
131131
- gRPC
132132
- [OpenFeature](https://github.com/open-feature)

content/en/blog/2022/exponential-histograms/index.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -278,8 +278,6 @@ documentation on [instrumentation][] or [github.com/open-telemetry][].
278278

279279
_A version of this article was [originally posted][] on the New Relic blog._
280280

281-
[originally posted]: {{% param canonical_url %}}
282-
283281
[api]: /docs/specs/otel/metrics/api/
284282
[sdk]: /docs/specs/otel/metrics/sdk/
285283
[meter provider]: /docs/specs/otel/metrics/api/#meterprovider
@@ -304,3 +302,4 @@ _A version of this article was [originally posted][] on the New Relic blog._
304302
[environment variable]: /docs/specs/otel/metrics/sdk_exporters/otlp/
305303
[instrumentation]: /docs/languages
306304
[github.com/open-telemetry]: https://github.com/open-telemetry
305+
[originally posted]: <{{% param canonical_url %}}>

content/en/blog/2022/go-web-app-instrumentation/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -415,4 +415,4 @@ find all files ready to use in our GitHub
415415

416416
_A version of this article was [originally posted][] on the Aspecto blog._
417417

418-
[originally posted]: {{% param canonical_url %}}
418+
[originally posted]: <{{% param canonical_url %}}>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ system in a distributed environment. Different services communicate with each
1111
other by using Apache Kafka as a messaging system but even more as en event or
1212
data streaming platform.
1313

14-
Taking into account the cloud-native approach for developing microservices,
14+
Taking into account the cloud native approach for developing microservices,
1515
quite often [Kubernetes](https://kubernetes.io/) is also used to run the
1616
workloads. In this scenario, you can also easily deploy and manage an Apache
1717
Kafka cluster on top of it, by using a project like

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ cSpell:ignore: k8sattributes k8sattributesprocessor k8sprocessor KUBE replicaset
99

1010
{{% alert title="Note" color="info" %}} The most up to date information for how
1111
to enhance telemetry with Kubernetes metadata can be found in the docs. See
12-
[Getting Started with Kubernetes](/docs/kubernetes/getting-started/) for more
13-
info. {{% /alert %}}
12+
[Getting Started with Kubernetes](/docs/platforms/kubernetes/getting-started/)
13+
for more info. {{% /alert %}}
1414

1515
Attaching Kubernetes resource metadata to OpenTelemetry traces is useful to
1616
identify which resource (such as a pod) is failing or having performance

content/en/blog/2022/k8s-otel-expose/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ in this setup are mentioned in brackets.
106106
[v1.2.1] installed.
107107
- A Kubernetes [v1.23.3] edge cluster to create a test cluster. Using
108108
[Kind](https://kind.sigs.k8s.io/) is recommended.
109-
- Installed [OpenTelemetry Operator](/docs/kubernetes/operator/) [v0.58.0] on
110-
both ends.
109+
- Installed [OpenTelemetry Operator](/docs/platforms/kubernetes/operator/)
110+
[v0.58.0] on both ends.
111111
- Installed [Jaeger Operator](https://www.jaegertracing.io/docs/1.37/operator/)
112112
[v1.37.0] on your public cluster.
113113
- Installed [cert-manager](https://cert-manager.io/) [v1.9.1] on your public

content/en/blog/2022/tail-sampling/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -227,4 +227,4 @@ for more information.
227227

228228
_A version of this article was [originally posted][] on the New Relic blog._
229229

230-
[originally posted]: {{% param canonical_url %}}
230+
[originally posted]: <{{% param canonical_url %}}>

content/en/blog/2022/troubleshooting-nodejs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -385,4 +385,4 @@ For a list of OpenTelemetry vendors, see [Vendors](/ecosystem/vendors/).
385385

386386
_A version of this article was [originally posted][] on the Aspecto blog._
387387

388-
[originally posted]: {{% param canonical_url %}}
388+
[originally posted]: <{{% param canonical_url %}}>

content/en/blog/2022/v1.0-trio.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ new languages (Ruby, JavaScript, and Erlang/Elixir) have had their first 1.0
1010
releases, joining the existing GA releases from C++, Go, Java, .NET, Python and
1111
Swift. Read all the details from the [announcement][].
1212

13-
[announcement]: {{% param canonical_url %}}
13+
[announcement]: <{{% param canonical_url %}}>

content/en/blog/2022/why-and-how-ebay-pivoted-to-opentelemetry/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ ongoing issues in critical workflows that could potentially impact customer
2121
experience. The Observability landscape is an ever-changing one and recent
2222
developments in the OpenTelemetry world forced us to rethink our strategy in
2323
order to pivot to using it. eBay’s observability platform Sherlock.io provides
24-
developers and Site Reliability Engineers (SREs) with a robust set of
25-
cloud-native offerings to observe the various applications that power the eBay
24+
developers and Site Reliability Engineers (SREs) with a robust set of cloud
25+
native offerings to observe the various applications that power the eBay
2626
ecosystem. Sherlock.io supports the three pillars of observability — metrics,
2727
logs and traces. The platform’s metric store is a clustered and sharded
2828
implementation of the Prometheus storage engine. We use the Metricbeat agent to
@@ -353,4 +353,4 @@ OpenTelemetry Collector community:
353353

354354
_A version of this article was [originally posted][] on the eBay Tech Blog._
355355

356-
[originally posted]: {{% param canonical_url %}}
356+
[originally posted]: <{{% param canonical_url %}}>

content/en/blog/2023/contributing-to-otel/index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -145,11 +145,11 @@ Feeling a little more adventurous? Then why not join one of the other OTel
145145
(SIGs)? By joining a SIG, you can contribute to things like (but not limited to)
146146
SDK development, auto-instrumentation of libraries, the
147147
[OTel Collector](/docs/collector/), and the
148-
[OTel Operator](/docs/kubernetes/operator/). You don't even need to be a regular
149-
contributor. Sometimes, contributions come out of necessity. Like maybe you
150-
found a bug in the Collector. Why not take a stab at fixing it? Or maybe there's
151-
a feature that you and your team desperately need. Again, why not take a stab at
152-
implementing it?
148+
[OTel Operator](/docs/platforms/kubernetes/operator/). You don't even need to be
149+
a regular contributor. Sometimes, contributions come out of necessity. Like
150+
maybe you found a bug in the Collector. Why not take a stab at fixing it? Or
151+
maybe there's a feature that you and your team desperately need. Again, why not
152+
take a stab at implementing it?
153153

154154
Now, before you go off writing code, you should make sure that you:
155155

0 commit comments

Comments
 (0)