Skip to content

Commit

Permalink
Merge branch 'main' into feat/language-apis-and-sdks
Browse files Browse the repository at this point in the history
  • Loading branch information
samyev authored Oct 24, 2024
2 parents 552125a + 4a8e68b commit c0ac264
Show file tree
Hide file tree
Showing 45 changed files with 4,003 additions and 1,482 deletions.
2 changes: 2 additions & 0 deletions .cspell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,5 @@ dictionaries:
- softwareTerms
# Other
- companies
words: # Valid words across all locales
- htmltest
166 changes: 165 additions & 1 deletion .cspell/fr-mots.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,168 @@ universelle
utilisé
visuel
votre
vous
vous
l'état
système
incluent
rendre
signifie
émettre
metriques
produites
doivent
transmises
Pourquoi
l'essor
commerciales
besoin
répond
suivant
principes
clés
propriétaire
générez
dépendance
fournisseur
n'avez
d'apprendre
seul
combinés
offrent
équipes
organisations
flexibilité
dont
informatique
Extensibilité
conçu
extensible
Quelques
façon
étendu
Ajouter
receveur
Collecteur
afin
prendre
venant
personnalisée
bibliothèques
personnalisées
Créer
collecteur
adaptée
utilisation
spécifique
nouvel
exportateur
personnalisé
prend
propagateur
contexte
plupart
utilisateurs
n'aient
d'étendre
presque
tous
niveaux
Histoire
trouve
antérieurs
créés
résoudre
même
problème
norme
décrivant
manière
transmettre
Aucun
n'étant
indépendante
fusionné
leurs
offrant
utilisez
actuellement
pouvez
découvrir
migrer
ensuite
commencer
Lancez
directement
composants
standardisé
définissant
sémantiques
décrire
langage
implémentent
spécifications
écosystème
instrumentent
automatique
génèrent
requérir
reçoit
modifie
autre
Opérateur
ressources
Faas
variété
intègrent
fournir
défaut
pris
fournisseurs
fournissent
contribuent
n’aient
d’étendre
conçus
créer
gérer
telles
outil
compris
ainsi
commerciaux
d'autres
génération
collecte
gestion
objectifs
principaux
pouvoir
aisément
systèmes
quelque
soit
leur
environnement
d'exécution
stockage
visualisation
sont
intentionnellement
laissés
d'autres
comprendre
sortantes
logiciel
d’aujourd’hui
souhaitez
jetez
oeil
valeurs
principaux
suivants
spécification
communautaires
brève
êtes
standardisée
autres
4 changes: 2 additions & 2 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/google/docsy.git
docsy-pin = v0.10.0-26-g79511949
docsy-pin = v0.11.0
docsy-note = "2024-04-01 Switching to google/docsy.git from cncf/docsy.git since we don't have any CNCF customizations."
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."
[submodule "content-modules/opentelemetry-specification"]
Expand Down Expand Up @@ -31,4 +31,4 @@
[submodule "content-modules/opentelemetry-java-examples"]
path = content-modules/opentelemetry-java-examples
url = https://github.com/open-telemetry/opentelemetry-java-examples.git
javaexamples-pin = 8fe9a11
javaexamples-pin = 0f736ec
8 changes: 6 additions & 2 deletions .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,13 @@ IgnoreInternalEmptyHash: true # TODO: remove after resolution of https://github.
CheckMailto: false
TestFilesConcurrently: true
IgnoreDirs:
# DO NOT EDIT! IgnoreDirs list is auto-generated from markdown file front matter.
# TODO drop next line after https://github.com/open-telemetry/opentelemetry.io/issues/5423 is fixed for ja pages:
- ^ja/docs/concepts/instrumentation/libraries/
# TODO drop next line after https://github.com/open-telemetry/opentelemetry.io/issues/5423 is fixed for pt pages:
- ^pt/docs/concepts/instrumentation/libraries/
- ^blog/(\d+/)?page/\d+
# TODO drop after https://github.com/open-telemetry/opentelemetry.io/issues/5267 is fixed:
- zh/docs/contributing/pr-checks
# DO NOT EDIT! IgnoreDirs list is auto-generated from markdown file front matter.
IgnoreInternalURLs: # list of paths
IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^/api$
Expand Down
2 changes: 1 addition & 1 deletion content-modules/opentelemetry-java-examples
Submodule opentelemetry-java-examples updated 45 files
+6 −6 autoconfigure/README.md
+1 −1 build.gradle.kts
+12 −0 doc-snippets/api/build.gradle.kts
+50 −0 doc-snippets/api/src/main/java/otel/AsyncCounterUsage.java
+49 −0 doc-snippets/api/src/main/java/otel/AsyncGaugeUsage.java
+49 −0 doc-snippets/api/src/main/java/otel/AsyncUpDownCounterUsage.java
+79 −0 doc-snippets/api/src/main/java/otel/AttributesUsage.java
+74 −0 doc-snippets/api/src/main/java/otel/BaggageUsage.java
+91 −0 doc-snippets/api/src/main/java/otel/ContextUsage.java
+42 −0 doc-snippets/api/src/main/java/otel/CounterUsage.java
+82 −0 doc-snippets/api/src/main/java/otel/ExtractContextUsage.java
+43 −0 doc-snippets/api/src/main/java/otel/GaugeUsage.java
+16 −0 doc-snippets/api/src/main/java/otel/GlobalOpenTelemetryUsage.java
+43 −0 doc-snippets/api/src/main/java/otel/HistogramUsage.java
+46 −0 doc-snippets/api/src/main/java/otel/InjectContextUsage.java
+63 −0 doc-snippets/api/src/main/java/otel/LogRecordUsage.java
+73 −0 doc-snippets/api/src/main/java/otel/NoopUsage.java
+20 −0 doc-snippets/api/src/main/java/otel/OpenTelemetryUsage.java
+51 −0 doc-snippets/api/src/main/java/otel/ProvidersAndScopes.java
+29 −0 doc-snippets/api/src/main/java/otel/SemanticAttributesUsage.java
+53 −0 doc-snippets/api/src/main/java/otel/SpanAndContextUsage.java
+86 −0 doc-snippets/api/src/main/java/otel/SpanUsage.java
+42 −0 doc-snippets/api/src/main/java/otel/UpDownCounterUsage.java
+35 −0 doc-snippets/api/src/main/java/otel/Util.java
+2 −2 doc-snippets/exporters/build.gradle.kts
+2 −2 doc-snippets/getting-started/build.gradle.kts
+2 −2 doc-snippets/spring-starter/build.gradle.kts
+ gradle/wrapper/gradle-wrapper.jar
+2 −2 gradle/wrapper/gradle-wrapper.properties
+4 −4 grpc/build.gradle.kts
+1 −1 javaagent/README.md
+1 −1 javaagent/build.gradle.kts
+5 −4 javaagent/collector-config.yaml
+1 −1 javaagent/docker-compose.yml
+2 −2 kotlin-extension/build.gradle.kts
+5 −5 log-appender/build.gradle.kts
+1 −1 log-appender/docker-compose.yml
+3 −2 log-appender/otel-config.yaml
+5 −5 otlp/docker/otel-collector-config-demo.yaml
+10 −9 settings.gradle.kts
+1 −1 spring-native/README.md
+3 −3 spring-native/build.gradle.kts
+5 −4 spring-native/collector-spring-native-config.yaml
+1 −1 spring-native/docker-compose.yml
+3 −3 telemetry-testing/build.gradle.kts
10 changes: 5 additions & 5 deletions content/en/blog/2023/spring-native/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ Boot 3) out of the box:
```

To get even more visibility, the Starter can be combined with
[instrumentation libraries](/docs/languages/java/libraries/). For this purpose,
the OpenTelemetry Java contributors have improved the JDBC (database) libraries
and logging instrumentation libraries. For example, for the Logback logging
library, they have added GraalVM configuration to make the library work in
native mode[^1].
[instrumentation libraries](/docs/languages/java/instrumentation/). For this
purpose, the OpenTelemetry Java contributors have improved the JDBC (database)
libraries and logging instrumentation libraries. For example, for the Logback
logging library, they have added GraalVM configuration to make the library work
in native mode[^1].

Furthermore, they have worked to reduce the configuration to set up the logging
and database instrumentation with the Starter. For example, if your application
Expand Down
6 changes: 4 additions & 2 deletions content/en/blog/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Blog
menu:
main: { weight: 50 }
menu: { main: { weight: 50 } }
redirects: [{ from: '', to: '2024/ 301!' }]
outputs: [HTML, RSS]
htmltest:
IgnoreDirs:
- ^blog/(\d+/)?page/\d+
---
2 changes: 1 addition & 1 deletion content/en/docs/collector/deployment/agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Cons:
[instrumentation]: /docs/languages/
[otlp]: /docs/specs/otel/protocol/
[collector]: /docs/collector/
[instrument-java-metrics]: /docs/languages/java/instrumentation/#metrics
[instrument-java-metrics]: /docs/languages/java/api-components/#meterprovider
[otlp-exporter]: /docs/specs/otel/protocol/exporter/
[java-otlp-example]:
https://github.com/open-telemetry/opentelemetry-java-docs/tree/main/otlp
Expand Down
6 changes: 2 additions & 4 deletions content/en/docs/concepts/instrumentation/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ After you create a span, pass new trace context to the application code
(callback or handler), by making the span active; if possible, do this
explicitly. The following Java example shows how to add trace context and
activate a span. See the
[Context extraction in Java](/docs/languages/java/instrumentation/#context-propagation),
[Context extraction in Java](/docs/languages/java/api-components/#contextpropagators),
for more examples.

```java
Expand All @@ -289,9 +289,7 @@ try (Scope unused = span.makeCurrent()) {
```

In the case of a messaging system, you might receive more than one message at
once. Received messages become
[links](/docs/languages/java/instrumentation/#create-spans-with-links) on the
span you create. Refer to
once. Received messages become links on the span you create. Refer to
[messaging conventions](/docs/specs/semconv/messaging/messaging-spans/) for
details.

Expand Down
78 changes: 67 additions & 11 deletions content/en/docs/contributing/localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,34 @@ English is the default language, with US English as the default (implicit) local
A growing number of other localizations are supported, as can be seen from the languages
dropdown menu in the top nav.

## English language maintainer guidance

### When link checking fails for non-English pages

English is the default language of the OpenTelemetry website. After you add,
edit, or reorganized English language documentation, link checking may fail for
non-English pages. When this happens:

<!-- markdownlint-disable blanks-around-fences -->

- Do **not** fix the broken links. Each non-English page is associated with a
specific commit of the corresponding English page, as identified by the git
commit hash value of the `default_lang_commit` front matter key.
- Configure the link checker to ignore the non-English pages by adding the
following to the page's front matter, or to the closest common ancestor file,
when more than one page has link errors:
```yaml
htmltest:
# TODO: remove the IgnoreDirs once broken links are fixed
IgnoreDirs:
- path-regex/to/non-en/directory/contain/files/to/ignore
- path-2-etc
```
- Run `npm run check:links` and include any updates to the `.htmltest.yml`
config file with your PR.

<!-- markdownlint-enable blanks-around-fences -->

## Translation guidance

We recommend that you follow the guidance offered in this section when
Expand Down Expand Up @@ -204,22 +232,50 @@ For more details about the script, run `npm run check:i18n -- -h`.

## New localizations

(Section To Be Completed soon with information about how to propose a new
localization.)
To start a new localization for the OpenTelemetry website,
[raise an issue](https://github.com/open-telemetry/opentelemetry.io/issues/) to
share your interest to contribute. Tag all other individuals that are willing to
write and review translations in the language you want to add. You need at least
two potential contributors, three would be ideal. Include the following task
list in your issue as well:

```markdown
- [ ] List at least 2 contributors for the new language: `<@gitHubHandle1>`,
`<@gitHubHandle2>`, ...
- [ ] Localize index page to `<your language>`
- [ ] Create an issue label for `lang:<shortcode>`
- [ ] Create org-level group for `<shortcode>` approvers
- [ ] Update components owners for `content/<shortcode>`
```
<!--
For the `<shortcode>` use the
[ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) for the language you
want to add.

cSpell:ignore: CODEOWNERSHIP Comms
After you created that issue and have the required amount of contributors,
maintainers will ask you to provide a pull request with a translation of the
[index page](https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/_index.md).
Make sure that maintainers are allowed to edit your PR, since they will add
additional changes to your PR that are required to get your localization project
started.

* Our website supports multiple languages already, so the translated content should live under main/content/<two_letter_code>
* Our point of reference is how kubernetes is doing their localization, see https://github.com/kubernetes/website
* We need at least 2 ppl owning that content, so that changes can be approved (CODEOWNERSHIP will help with that)
* We can start with the translation been hidden until we reach a point where enough material is translated to go live (with maybe some blog post & announcements around it)
* (Please anticipate that this is guidance on not a fixed set of rules)
With your first PR merged maintainers will take care of setting up the issue
label, the org-level group and the component owners.

As stated above this project requires a set of individuals that are happy to take on ownership for their language and work with SIG Comms on implementing this. So any discussion on this page "how to do it" needs to be preceded by a "I volunteer to co-own `<language>`"
{{% alert title="Important" color="warning" %}}

-->
You don't have to be an existing contributor to the OpenTelemetry project, to
start a new localization. However you will not be added as a member of the
[OpenTelemetry GitHub organization](https://github.com/open-telemetry/) or as a
member of the approvers group for your localization. You will need to satisfy
the requirements for becoming an established member and approver as outlined in
the
[membership guidelines](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md).

When starting the localization project, maintainers will treat your reviews as
if you are an approver already.

{{% /alert %}}

[main]: https://github.com/open-telemetry/opentelemetry.io/commits/main/
[multilingual framework]: https://gohugo.io/content-management/multilingual/
2 changes: 1 addition & 1 deletion content/en/docs/demo/feature-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ change the `defaultVariant` value in the config file for a given flag to "on".
| `adServiceFailure` | Ad Service | Generate an error for `GetAds` 1/10th of the time |
| `adServiceManualGc` | Ad Service | Trigger full manual garbage collections in the ad service |
| `adServiceHighCpu` | Ad Service | Trigger high cpu load in the ad service. If you want to demo cpu throttling, set cpu resource limits |
| `cartServiceFailure` | Cart Service | Generate an error for `EmptyCart` 1/10th of the time |
| `cartServiceFailure` | Cart Service | Generate an error whenever `EmptyCart` is called |
| `productCatalogFailure` | Product Catalog | Generate an error for `GetProduct` requests with product ID: `OLJCESPC7Z` |
| `recommendationServiceCacheFailure` | Recommendation | Create a memory leak due to an exponentially growing cache. 1.4x growth, 50% of requests trigger growth. |
| `paymentServiceFailure` | Payment Service | Generate an error when calling the `charge` method. |
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/languages/java/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ description: >-
aliases: [/java, /java/metrics, /java/tracing]
cascade:
vers:
instrumentation: 2.8.0
instrumentation: 2.9.0
otel: 1.43.0
contrib: 1.38.0
semconv: 1.27.0
semconv: 1.28.0
weight: 18
---

Expand Down
Loading

0 comments on commit c0ac264

Please sign in to comment.