Skip to content

Commit

Permalink
Merge branch 'main' into run-codeexcerpts-2
Browse files Browse the repository at this point in the history
  • Loading branch information
svrnm authored Jul 23, 2024
2 parents 438a68d + bf49f3a commit 2305817
Show file tree
Hide file tree
Showing 462 changed files with 5,923 additions and 1,402 deletions.
34 changes: 0 additions & 34 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -14,37 +14,3 @@

# Global owners, will be the owners for everything in the repo.
* @open-telemetry/docs-approvers

# content owners
content-modules/ @open-telemetry/docs-maintainers
content-modules/opamp-spec @open-telemetry/docs-maintainers @open-telemetry/opamp-spec-approvers
content-modules/opentelemetry-proto @open-telemetry/docs-maintainers @open-telemetry/specs-approvers
content-modules/opentelemetry-specification @open-telemetry/docs-maintainers @open-telemetry/specs-approvers
content-modules/semantic-conventions @open-telemetry/docs-maintainers @open-telemetry/specs-semconv-approvers
content/en/blog/ @open-telemetry/docs-maintainers
content/en/community/end-user/ @open-telemetry/docs-approvers @open-telemetry/sig-end-user-approvers
content/en/docs/collector @open-telemetry/docs-approvers @open-telemetry/collector-approvers
content/en/docs/contributing/ @open-telemetry/docs-approvers @open-telemetry/docs-maintainers
content/en/docs/demo @open-telemetry/docs-approvers @open-telemetry/demo-approvers
content/en/docs/kubernetes/helm/ @open-telemetry/docs-approvers @open-telemetry/helm-approvers
content/en/docs/kubernetes/operator/ @open-telemetry/docs-approvers @open-telemetry/operator-approvers
content/en/docs/languages/cpp/ @open-telemetry/docs-approvers @open-telemetry/cpp-approvers
content/en/docs/languages/erlang/ @open-telemetry/docs-approvers @open-telemetry/erlang-approvers
content/en/docs/languages/go/ @open-telemetry/docs-approvers @open-telemetry/go-approvers @open-telemetry/go-instrumentation-approvers
content/en/docs/languages/java/ @open-telemetry/docs-approvers @open-telemetry/java-approvers @open-telemetry/java-instrumentation-approvers
content/en/docs/languages/js/ @open-telemetry/docs-approvers @open-telemetry/javascript-approvers
content/en/docs/languages/net/ @open-telemetry/docs-approvers @open-telemetry/dotnet-approvers @open-telemetry/dotnet-instrumentation-approvers
content/en/docs/languages/php/ @open-telemetry/docs-approvers @open-telemetry/php-approvers
content/en/docs/languages/python/ @open-telemetry/docs-approvers @open-telemetry/python-approvers
content/en/docs/languages/ruby/ @open-telemetry/docs-approvers @open-telemetry/ruby-approvers @open-telemetry/ruby-contrib-approvers
content/en/docs/languages/rust/ @open-telemetry/docs-approvers @open-telemetry/rust-approvers
content/en/docs/languages/swift/ @open-telemetry/docs-approvers @open-telemetry/swift-approvers
content/en/docs/security/ @open-telemetry/docs-approvers @open-telemetry/sig-security-maintainers
content/en/docs/specs/ @open-telemetry/docs-approvers @open-telemetry/specs-approvers
content/en/docs/zero-code/java/ @open-telemetry/docs-approvers @open-telemetry/java-approvers @open-telemetry/java-instrumentation-approvers
content/en/docs/zero-code/js/ @open-telemetry/docs-approvers @open-telemetry/javascript-approvers
content/en/docs/zero-code/net/ @open-telemetry/docs-approvers @open-telemetry/dotnet-approvers @open-telemetry/dotnet-instrumentation-approvers
content/en/ecosystem/demo/ @open-telemetry/demo-approvers @open-telemetry/demo-approvers
content/zh/ @open-telemetry/docs-maintainers @open-telemetry/docs-zh-approvers
content/ja/ @open-telemetry/docs-maintainers @open-telemetry/docs-ja-approvers

5 changes: 5 additions & 0 deletions .github/component-label-map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ lang:ja:
- changed-files:
- any-glob-to-any-file:
- content/ja/**
lang:pt:
- changed-files:
- any-glob-to-any-file:
- content/pt/**
sig:cpp:
- changed-files:
- any-glob-to-any-file:
Expand All @@ -26,6 +30,7 @@ sig:go:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/go/**
- content/en/docs/zero-code/go/**
sig:java:
- changed-files:
- any-glob-to-any-file:
Expand Down
79 changes: 79 additions & 0 deletions .github/component-owners.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# This file is used to define the owners of the content modules in the OpenTelemetry repository.
components:
content-modules:
- open-telemetry/docs-maintainers
content-modules/opamp-spec:
- open-telemetry/docs-maintainers
- open-telemetry/opamp-spec-approvers
content-modules/opentelemetry-proto:
- open-telemetry/docs-maintainers
- open-telemetry/specs-approvers
content-modules/opentelemetry-specification:
- open-telemetry/docs-maintainers
- open-telemetry/specs-approvers
content-modules/semantic-conventions:
- open-telemetry/docs-maintainers
- open-telemetry/specs-semconv-approvers
content/en/blog:
- open-telemetry/docs-maintainers
content/en/community/end-user:
- open-telemetry/sig-end-user-approvers
content/en/docs/collector:
- open-telemetry/collector-approvers
content/en/docs/contributing:
- open-telemetry/docs-maintainers
content/en/docs/demo:
- open-telemetry/demo-approvers
content/en/docs/kubernetes/helm:
- open-telemetry/helm-approvers
content/en/docs/kubernetes/operator:
- open-telemetry/operator-approvers
content/en/docs/languages/cpp:
- open-telemetry/cpp-approvers
content/en/docs/languages/erlang:
- open-telemetry/erlang-approvers
content/en/docs/languages/go:
- open-telemetry/go-approvers
- open-telemetry/go-instrumentation-approvers
content/en/docs/languages/java:
- open-telemetry/java-approvers
- open-telemetry/java-instrumentation-approvers
content/en/docs/languages/js:
- open-telemetry/javascript-approvers
content/en/docs/languages/net:
- open-telemetry/dotnet-approvers
- open-telemetry/dotnet-instrumentation-approvers
content/en/docs/languages/php:
- open-telemetry/php-approvers
content/en/docs/languages/python:
- open-telemetry/python-approvers
content/en/docs/languages/ruby:
- open-telemetry/ruby-approvers
- open-telemetry/ruby-contrib-approvers
content/en/docs/languages/rust:
- open-telemetry/rust-approvers
content/en/docs/languages/swift:
- open-telemetry/swift-approvers
content/en/docs/security:
- open-telemetry/sig-security-maintainers
content/en/docs/specs:
- open-telemetry/specs-approvers
content/en/docs/zero-code/java:
- open-telemetry/java-approvers
- open-telemetry/java-instrumentation-approvers
content/en/docs/zero-code/js:
- open-telemetry/javascript-approvers
content/en/docs/zero-code/net:
- open-telemetry/dotnet-approvers
- open-telemetry/dotnet-instrumentation-approvers
content/en/ecosystem/demo:
- open-telemetry/demo-approvers
content/zh:
- open-telemetry/docs-maintainers
- open-telemetry/docs-zh-approvers
content/ja:
- open-telemetry/docs-maintainers
- open-telemetry/docs-ja-approvers
content/pt:
- open-telemetry/docs-maintainers
- open-telemetry/docs-pt-approvers
2 changes: 1 addition & 1 deletion .github/workflows/check-spelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
with:
# Files should be consistent with check:spelling files
files: |
content/**/*.md
content/en/*.md
layouts/**/*.md
data/**/*
config: .cspell.yml
Expand Down
15 changes: 15 additions & 0 deletions .github/workflows/component-owners.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Component owners
on:
pull_request_target:

jobs:
run_self:
runs-on: ubuntu-latest
name: Assign component owners
permissions:
contents: read
pull-requests: write
steps:
- uses: dyladan/[email protected]
with:
config-file: .github/component-owners.yml
4 changes: 2 additions & 2 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
[submodule "content-modules/opentelemetry-specification"]
path = content-modules/opentelemetry-specification
url = https://github.com/open-telemetry/opentelemetry-specification.git
spec-pin = v1.34.0
spec-pin = v1.35.0
[submodule "content-modules/community"]
path = content-modules/community
url = https://github.com/open-telemetry/community
community-pin = f16a58e
[submodule "content-modules/opentelemetry-proto"]
path = content-modules/opentelemetry-proto
url = https://github.com/open-telemetry/opentelemetry-proto
otlp-pin = v1.3.1
otlp-pin = v1.3.2
[submodule "content-modules/semantic-conventions"]
path = content-modules/semantic-conventions
url = https://github.com/open-telemetry/semantic-conventions
Expand Down
7 changes: 5 additions & 2 deletions .textlintrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ filters:
enablingComment: prettier-ignore-end
allowlist:
allow:
# Don't check registry .yml file fields for language, repo and tags:
- '/^\s*(?:language|repo|name|docs): .*$/m'
# Don't check registry .yml file fields for language, repo, url and tags:
- '/^\s*(?:language|repo|name|docs|url): .*$/m'
- /^(?:tags):(\s*-.+$)*/m
# Hugo template syntax:
- /{{.*?}}/
Expand Down Expand Up @@ -158,3 +158,6 @@ rules:
- ['screen[- ]shot(s)?', screenshot$1]
- ['time[- ]stamp(s)?', timestamp$1]
- ["uid['’]?(s)?", UID$1]
# Enable the following to find and replace "instrumentation module/package" with "instrumentation library":
# - ["(auto(matic)?[- ])?instrumentation (module|package)", "instrumentation library"]
# - ["(auto(matic)?[- ])?instrumentation (modules|packages)", "instrumentation libraries"]
9 changes: 9 additions & 0 deletions content/en/announcements/kubecon-china.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: KubeCon China
date: 2024-07-10
expiryDate: 2024-08-23
---

<i class="fas fa-bullhorn"></i> Join us in Hong Kong for
[**KubeCon + CloudNativeCon + OpenSourceSummit + AI_dev**](/blog/2024/kubecon-china/)
, August 21 - 23, 2024
4 changes: 2 additions & 2 deletions content/en/blog/2022/debug-otel-with-otel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,5 +260,5 @@ COPY opentelemetry_module.conf /etc/nginx/conf.d
[v1.0.1 release of the otel-webserver-module]:
https://github.com/open-telemetry/opentelemetry-cpp-contrib/releases/tag/webserver%2Fv1.0.1
[java]:
/docs/zero-code/java/agent/configuration/#capturing-http-request-and-response-headers
[python]: /docs/languages/python/automatic/
/docs/zero-code/java/agent/instrumentation/http/#capturing-http-request-and-response-headers
[python]: /docs/zero-code/python/
4 changes: 2 additions & 2 deletions content/en/blog/2022/dotnet-instrumentation-first-beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ of the
[OpenTelemetry .NET Automatic Instrumentation](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation)
project!

Without this project, .NET developers need to use instrumentation packages to
Without this project, .NET developers need to use instrumentation libraries to
automatically generate telemetry data. For example, to instrument inbound
ASP.NET Core requests, you need to use the ASP.NET Core instrumentation package
ASP.NET Core requests, you need to use the ASP.NET Core instrumentation library
and initialize it with the OpenTelemetry SDK.

Now, developers can use
Expand Down
4 changes: 2 additions & 2 deletions content/en/blog/2022/troubleshooting-nodejs.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ such as serverless, can import packages before the instrumentation code has a
chance to run. This can be easily missed.

To diagnose this issue, enable logging and verify you are seeing your
instrumentation package being loaded. For example:
instrumentation library being loaded. For example:

```nocode
@opentelemetry/instrumentation-http Applying patch for [email protected]
Expand Down Expand Up @@ -337,7 +337,7 @@ provider.shutdown();
## Package Versions Compatibility

Some issues can be a result of incompatible or old versions of SDK and
instrumentation packages.
instrumentation libraries.

### SDK versions

Expand Down
6 changes: 3 additions & 3 deletions content/en/blog/2023/end-user-discussions-03.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,8 @@ Additional suggestions:

- Start with dev or testing environments first to build trust in the software
- Choose a stack where OTel is more robust, such as Java and Node.js
- For countering developer resistance, using auto-instrumentation modules to
- start with is a good step
- For countering developer resistance, using automatic instrumentation to start
with is a good step

#### 2 - Starting and scaling

Expand Down Expand Up @@ -190,7 +190,7 @@ agent to the host metrics receiver for infrastructure monitoring.
maturing in OTel; for example, the Java JAR agent takes care of instrumenting
[most libraries](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md#libraries--frameworks)
that are used by applications. Auto-instrumentation is also available for
[Python](/docs/languages/python/automatic/), [.NET](/docs/zero-code/net/), and
[Python](/docs/zero-code/python/), [.NET](/docs/zero-code/net/), and
[Node.js](/docs/zero-code/js/).
- If you’re using Kubernetes, they can use the
[OTel operator](https://github.com/open-telemetry/opentelemetry-operator),
Expand Down
4 changes: 2 additions & 2 deletions content/en/blog/2023/end-user-q-and-a-01.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ They are hoping to leverage
[OpenTelemetry’s Exemplars](/docs/specs/otel/metrics/data-model/#exemplars) to
link traces and metrics.

### How is the organization sending telemetry data to various observability back-ends?
### How is the organization sending telemetry data to various observability backends?

J’s team uses a combination of the proprietary backend agent and the
OpenTelemetry Collector (for metrics). They are one of the primary users of
Expand Down Expand Up @@ -275,7 +275,7 @@ any suggestions for improvement!
There is also a huge focus on
[stabilizing semantic conventions](https://docs.google.com/document/d/1ghvajKaipiNZso3fDtyNxU7x1zx0_Eyd02OGpMGEpLE/edit#),
and as part of that effort, maintainers plan to go through the existing
instrumentation packages and to make sure that they’re all up to date with the
instrumentation libraries and to make sure that they’re all up to date with the
latest conventions. While it’s very well-maintained for certain languages, such
as Java, that is not the case for other languages, such as Node.js.

Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2023/php-auto-instrumentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ We have all necessary components in place:
and frameworks.
- Development tools that can help lower barrier for users and developers
interested in instrumenting arbitrary code.
- [Documentation](/docs/languages/php/automatic/)
- [Documentation](/docs/zero-code/php/)

One of our goals is to increase awareness of this work and involve more people
that will help us improve it, extend coverage and fix bugs.
Expand Down
Loading

0 comments on commit 2305817

Please sign in to comment.