Skip to content

Commit 6a70267

Browse files
authored
Merge branch 'main' into issue-4376
2 parents ac22eee + 137d304 commit 6a70267

File tree

121 files changed

+7952
-2391
lines changed

Some content is hidden

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

121 files changed

+7952
-2391
lines changed

.cspell.yml

+1
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,5 @@ dictionaries:
5555
# Other
5656
- companies
5757
words: # Valid words across all locales
58+
- Docsy
5859
- htmltest

.github/workflows/survey-on-merged-pr.yml

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,23 @@
11
name: Survey on Merged PR by Non-Member
22

33
on:
4-
pull_request:
4+
pull_request_target:
55
types: [closed]
66

7+
env:
8+
PR_NUM: ${{ github.event.issue.number }}
9+
SURVEY_URL: https://forms.gle/WV58koUBGSG9HBY66
10+
711
jobs:
812
comment-on-pr:
13+
name: Add survey to PR if author is not a member
914
runs-on: ubuntu-latest
15+
permissions:
16+
contents: write
17+
pull-requests: write
1018
if: github.event.pull_request.merged == true
1119
steps:
20+
- uses: actions/checkout@v4
1221
- name: Check if user is a member of the org
1322
id: check-membership
1423
run: |
@@ -26,7 +35,6 @@ jobs:
2635
- name: Add comment to PR if author is not a member
2736
if: env.MEMBER_FOUND == 'false'
2837
run: |
29-
PR_NUMBER=${{ github.event.pull_request.number }}
30-
gh pr comment $PR_NUMBER --body "Thank you for your contribution! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by filling out this survey: https://forms.gle/WV58koUBGSG9HBY66"
38+
gh pr comment ${PR_NUM} --body "Thank you for your contribution! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out out this survey: ${SURVEY_URL}"
3139
env:
3240
GH_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}

.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-22-g2f361b2b
5+
docsy-pin = v0.11.0-32-ge6d94771
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

+18-21
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
CacheExpires: 9000h # ~ 12 months
1+
CacheExpires: 13300h # ~ 18 months
22
DirectoryPath: public
33
IgnoreDirectoryMissingTrailingSlash: true
44
IgnoreAltMissing: true
@@ -15,6 +15,11 @@ IgnoreDirs:
1515
# TODO drop next lines after https://github.com/open-telemetry/opentelemetry.io/issues/5555 is fixed for these pages:
1616
- ^zh/docs/concepts/signals/baggage/
1717
- ^zh/docs/zero-code/php/
18+
# TODO drop the following config once this page is updated to reflect the corresponding `en`
19+
# page and the link 404 (detailed below) are resolved:
20+
# zh/docs/contributing/index.html
21+
# Non-OK status: 404 --> https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md
22+
- ^zh/docs/contributing/
1823
# DO NOT EDIT! IgnoreDirs list is auto-generated from markdown file front matter.
1924
IgnoreInternalURLs: # list of paths
2025
IgnoreURLs: # list of regexs of paths or URLs to be ignored
@@ -56,35 +61,27 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
5661
# YouTube playlists sometimes give a 404, although they give a 200 when accessed via browser:
5762
- ^https://www.youtube.com/playlist\?list=
5863

59-
# Ignore Docsy-generated GitHub links for now
60-
- ^https?://github\.com/.*?/.*?/(new|edit)/ # view-page, edit-source etc
61-
# TODO: drop after fix to https://github.com/google/docsy/issues/1432
62-
- ^https://github.com/open-telemetry/opentelemetry.io/commit/ # last mod
64+
# Ignore Docsy-generated GitHub links for now, until
65+
# https://github.com/google/docsy/issues/1432 is fixed
66+
- ^https?://github\.com/.*?/.*?/(new|edit|issues/new\?title)/ # view-page, edit-source etc
67+
# Here's an approximate regex to avoid the "View page source" links. TODO: fix this in Docsy
68+
- ^https?://github\.com/open-telemetry/opentelemetry.io/tree/
69+
# FIXME: A patch until we can get Docsy to mark "View page source" links as excluded from link checking,
70+
# Actually, it would be better to pin the version of the OTel spec.
71+
- ^https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/logs/event-(api|sdk)\.md
72+
# FIXME: same issue as for the OTel spec mentioned above:
73+
- ^https://github.com/open-telemetry/semantic-conventions/tree/main
6374

64-
# Ignore links to GH repo content for now.
65-
- ^https?://github\.com/.*?/.*?/(blob|tree)/
75+
# Ignore some links to GH repo content for now, most 4XX
76+
- ^https?://github\.com/open-telemetry/opentelemetry-demo/blob/main/src/(imageprovider|loadgenerator|otelcollector|.*service)
6677

6778
# Too many redirects as the server tries to figure out the country and language,
6879
# e.g.: https://www.microsoft.com/en-ca/sql-server.
6980
- ^https://www.microsoft.com/sql-server$
7081

7182
# TODO: drop after fix to https://github.com/rust-lang/crates.io/issues/788
7283
- ^https://crates\.io/crates
73-
# TODO: drop after fix to https://github.com/micrometer-metrics/micrometer-docs/issues/239
74-
- ^https://micrometer\.io/docs
75-
# TODO: ensure .json isn't set as an alternate in ecosystem/registry/index.html and then drop:
76-
- ^https://opentelemetry.io/ecosystem/registry/index.json
77-
# TODO: drop after fix to https://github.com/open-telemetry/semantic-conventions/pull/645 lands in this repo
78-
- ^http://docs.couchdb.org/en/stable/api/document/common.html#get--db-docid
79-
# TODO drop after fix to https://github.com/open-telemetry/opentelemetry.io/issues/3818
80-
- ^https://oncallmemaybe.com
81-
# TODO drop after https://github.com/open-telemetry/opentelemetry-specification/pull/3834 is merged
82-
- ^https://wikipedia\.org/wiki/Monotonic_function
83-
# TODO drop after https://github.com/open-telemetry/opamp-spec/pull/179 is merged into this repo
84-
- ^http://www.watersprings.org/
8584
# TODO move into content/en/blog/2023/humans-of-otel.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
8685
- ^https://shorturl.at/osHRX$
87-
# TODO drop after https://github.com/open-telemetry/semantic-conventions/pull/678 is merged:
88-
- ^https://wikipedia.org/wiki/(S.M.A.R.T|Hop_)
8986
# TODO move into content/en/blog/2023/contributing-to-otel/index.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
9087
- ^https://shorturl.at/vLYZ0$

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ Here is a list of community roles with current and previous members:
5454
- Approvers: [@open-telemetry/docs-approvers][]
5555

5656
- [Michael Hausenblas](https://github.com/mhausenblas), Amazon
57-
- [Tiffany Hrabusa](https://github.com/tiffany76), Grafana Labs
5857

5958
- Maintainers: [@open-telemetry/docs-maintainers][]
6059

@@ -63,6 +62,7 @@ Here is a list of community roles with current and previous members:
6362
- [Patrice Chalin](https://github.com/chalin), CNCF
6463
- [Phillip Carter](https://github.com/cartermp), Honeycomb
6564
- [Severin Neumann](https://github.com/svrnm), Cisco
65+
- [Tiffany Hrabusa](https://github.com/tiffany76), Grafana Labs
6666

6767
- Emeritus approvers:
6868

assets/scss/_styles_project.scss

-4
Original file line numberDiff line numberDiff line change
@@ -175,10 +175,6 @@
175175
}
176176
}
177177

178-
.td-breadcrumbs__single {
179-
display: none !important;
180-
}
181-
182178
.config-option {
183179
padding-inline-start: 1.5em;
184180

content/en/blog/2024/otel-collector-anti-patterns/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ before things start to escalate. This is where monitoring your Collectors can be
7575
very useful.
7676

7777
But how does one monitor a Collector? The OTel Collector already emits
78-
[metrics for the purposes of its own monitoring](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/monitoring.md).
78+
[metrics for the purposes of its own monitoring](/docs/collector/internal-telemetry/#use-internal-telemetry-to-monitor-the-collector).
7979
These can then be sent to your Observability backend for monitoring.
8080

8181
### 3- Not using the right Collector Distribution (or not building your own distribution)

content/en/blog/2024/otel-collector-survey/index.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -90,42 +90,42 @@ The top components according to our survey results are as follows:
9090
### Exporters
9191

9292
1. [otlpexporter](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/otlpexporter)
93-
2. [prometheusremotewriteexporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/prometheusremotewriteexporter/README.md)
94-
3. [prometheusexporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/prometheusexporter/README.md)
95-
4. [lokiexporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/lokiexporter/README.md)
93+
2. [prometheusremotewriteexporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/exporter/prometheusremotewriteexporter/README.md)
94+
3. [prometheusexporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/exporter/prometheusexporter/README.md)
95+
4. [lokiexporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/exporter/lokiexporter/README.md)
9696
5. [debugexporter](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/debugexporter)
9797

9898
### Receivers
9999

100100
1. [otlpreceiver](https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver)
101-
2. [prometheusreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/prometheusreceiver/README.md)
101+
2. [prometheusreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/receiver/prometheusreceiver/README.md)
102102
3. [filelogreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver)
103-
4. [hostmetricsreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/hostmetricsreceiver/README.md)
104-
5. [k8sclusterreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/k8sclusterreceiver/README.md)
103+
4. [hostmetricsreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/receiver/hostmetricsreceiver/README.md)
104+
5. [k8sclusterreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/receiver/k8sclusterreceiver/README.md)
105105

106106
### Processors
107107

108108
1. [batchprocessor](https://github.com/open-telemetry/opentelemetry-collector/tree/main/processor/batchprocessor)
109-
2. [attributesprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/attributesprocessor/README.md)
110-
3. [filterprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/filterprocessor/README.md)
109+
2. [attributesprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/processor/attributesprocessor/README.md)
110+
3. [filterprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/processor/filterprocessor/README.md)
111111
4. [memorylimiterprocessor](https://github.com/open-telemetry/opentelemetry-collector/tree/main/processor/memorylimiterprocessor)
112-
5. [k8sattributesprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/k8sattributesprocessor/README.md)
112+
5. [k8sattributesprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/processor/k8sattributesprocessor/README.md)
113113

114114
### Connectors
115115

116-
1. [spanmetricsconnector](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/spanmetricsprocessor/README.md)
117-
2. [servicegraphconnector](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/servicegraphprocessor/README.md)
118-
3. [routingconnector](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/routingprocessor/README.md)
119-
4. [countconnector](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/countprocessor/README.md)
120-
5. [datadogconnector](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/datadogexporter/README.md)
116+
1. [spanmetricsconnector](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/connector/spanmetricsconnector/README.md)
117+
2. [servicegraphconnector](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/connector/servicegraphconnector/README.md)
118+
3. [routingconnector](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/processor/routingprocessor/README.md)
119+
4. [countconnector](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/connector/countconnector/README.md)
120+
5. [datadogconnector](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/exporter/datadogexporter/README.md)
121121

122122
### Extensions
123123

124-
1. [healthcheckextension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/healthcheckextension/README.md)
125-
2. [basicauthextension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/basicauthextension/README.md)
126-
3. [pprofextension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/pprofextension/README.md)
127-
4. [bearertokenauthextension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/bearertokenauthextension/README.md)
128-
5. [oauth2clientauthextension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/oauth2clientauthextension/README.md)
124+
1. [healthcheckextension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/extension/healthcheckextension/README.md)
125+
2. [basicauthextension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/extension/basicauthextension/README.md)
126+
3. [pprofextension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/extension/pprofextension/README.md)
127+
4. [bearertokenauthextension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/extension/bearertokenauthextension/README.md)
128+
5. [oauth2clientauthextension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.117.0/extension/oauth2clientauthextension/README.md)
129129

130130
<br/>
131131

content/en/blog/2024/otel-generative-ai/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ opentelemetry-instrument --traces_exporter console --metrics_exporter console py
164164
```
165165

166166
There is a complete example
167-
[available here](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation-genai/opentelemetry-instrumentation-openai-v2/example).
167+
[available here](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation-genai/opentelemetry-instrumentation-openai-v2/examples/).
168168

169169
With this simple instrumentation, one can begin capture traces from their
170170
generative AI application. Here is an example from the

content/en/blog/2024/otel-operator-q-and-a/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -225,9 +225,9 @@ install the Prometheus Operator just to use these two CRs with the Target
225225
Allocator.
226226

227227
The easiest way to install the
228-
[`PodMonitor`](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.PodMonitor)
228+
[`PodMonitor`](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.PodMonitor)
229229
and
230-
[`ServiceMonitor`](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.ServiceMonitor)
230+
[`ServiceMonitor`](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.ServiceMonitor)
231231
CRs is to grab a copy of the individual
232232
[PodMonitor YAML](https://github.com/prometheus-community/helm-charts/blob/main/charts/kube-prometheus-stack/charts/crds/crds/crd-podmonitors.yaml)
233233
and

content/en/docs/collector/configuration.md

+3
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,9 @@ receivers:
290290
protocols:
291291
grpc:
292292
endpoint: 0.0.0.0:4317
293+
tls:
294+
cert_file: cert.pem
295+
key_file: cert-key.pem
293296
http:
294297
endpoint: 0.0.0.0:4318
295298

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,9 @@ but also supports renaming and other metric-specific functionality.
107107
processors:
108108
metricstransform/rename:
109109
transforms:
110-
include: system.cpu.usage
111-
action: update
112-
new_name: system.cpu.usage_time
110+
- include: system.cpu.usage
111+
action: update
112+
new_name: system.cpu.usage_time
113113
```
114114
115115
The

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ aliases: [accountingservice]
77
This service calculates the total amount of sold products. This is only mocked
88
and received orders are printed out.
99

10-
[Accounting Service](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/accountingservice/)
10+
[Accounting Service](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/accounting/)
1111

1212
## Auto-instrumentation
1313

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ aliases: [adservice]
77
This service determines appropriate ads to serve to users based on context keys.
88
The ads will be for products available in the store.
99

10-
[Ad service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/adservice/)
10+
[Ad service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/ad/)
1111

1212
## Auto-instrumentation
1313

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ cSpell:ignore: fatalf otelgrpc otelsarama otlpmetricgrpc otlptracegrpc sarama sd
99
This service is responsible to process a checkout order from the user. The
1010
checkout service will call many other services in order to process an order.
1111

12-
[Checkout service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/checkoutservice/)
12+
[Checkout service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/checkout/)
1313

1414
## Traces
1515

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ cSpell:ignore: chrono decltype labelkv millis noexcept nostd
88
This service provides functionality to convert amounts between different
99
currencies.
1010

11-
[Currency service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/currencyservice/)
11+
[Currency service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/currency/)
1212

1313
## Traces
1414

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ cSpell:ignore: sinatra
77

88
This service will send a confirmation email to the user when an order is placed.
99

10-
[Email service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/emailservice/)
10+
[Email service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/email/)
1111

1212
## Initializing Tracing
1313

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This service is responsible to process credit card payments for orders. It will
99
return an error if the credit card is invalid or the payment can not be
1010
processed.
1111

12-
[Payment service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/paymentservice/)
12+
[Payment service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/payment/)
1313

1414
## Initializing OpenTelemetry
1515

content/en/docs/demo/services/product-catalog.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This service is responsible to return information about products. The service
1010
can be used to get all products, search for specific products, or return details
1111
about any single product.
1212

13-
[Product Catalog service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/productcatalogservice/)
13+
[Product Catalog service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/product-catalog/)
1414

1515
## Traces
1616

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ managing the Dependency Injection.
1414

1515
The PHP instrumentation may vary when using a different framework.
1616

17-
[Quote service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/quoteservice/)
17+
[Quote service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/quote/)
1818

1919
## Traces
2020

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The `build.rs` supports development outside docker, given a Rust installation.
1919
Otherwise, consider building with `docker compose` to edit / assess changes as
2020
needed.
2121

22-
[Shipping service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/shippingservice/)
22+
[Shipping service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/shipping/)
2323

2424
## Traces
2525

0 commit comments

Comments
 (0)