Skip to content

Commit

Permalink
Merge branch 'main' into feature/ptbr_version
Browse files Browse the repository at this point in the history
  • Loading branch information
edsoncelio authored Jun 8, 2024
2 parents 1718771 + c2cd5b1 commit bdea146
Show file tree
Hide file tree
Showing 37 changed files with 309 additions and 128 deletions.
4 changes: 4 additions & 0 deletions .github/component-label-map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ lang:zh:
- changed-files:
- any-glob-to-any-file:
- content/zh/**
lang:ja:
- changed-files:
- any-glob-to-any-file:
- content/ja/**
sig:cpp:
- changed-files:
- any-glob-to-any-file:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/check-i18n.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # all
- run: scripts/i18n-check.sh -u
- run: .github/workflows/scripts/i18n-check-helper.sh
10 changes: 5 additions & 5 deletions .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ IgnoreDirs:
- ^blog/(\d+/)?page/\d+
IgnoreInternalURLs: # list of paths
IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^(/zh)?/docs/languages/\w+/(api|examples|registry)/$
- ^(/zh)?/docs/collector/registry/$
- ^(/zh)?/docs/languages/net/(metrics-api|traces-api)/
- ^((/zh)?/docs/migration/)?opencensus/$
- ^/community/end-user/feedback-survey/$
- ^(/..)?/docs/languages/\w+/(api|examples|registry)/$
- ^(/..)?/docs/collector/registry/$
- ^(/..)?/docs/languages/net/(metrics-api|traces-api)/
- ^((/..)?/docs/migration/)?opencensus/$
- ^(/community/end-user/)?feedback-survey/$

- ^https://deploy-preview-\d+--opentelemetry.netlify.app/
- ^https://www\.googletagmanager\.com
Expand Down
10 changes: 10 additions & 0 deletions archetypes/announcement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: {{ replaceRE "[-_]" " " .Name | title }}
date: {{ .Date | time.Format "2006-01-02" }} # Start date (optional)
expiryDate: {{ dateFormat "2006-01-02" .Date }} # End date (optional)
---

<!-- For more detail about announcements, see
https://opentelemetry.io/docs/contributing/#announcement-management
Erase this comment once you are done including the announcement text below. -->
24 changes: 6 additions & 18 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,6 @@ developer_note:
The blocks/cover shortcode (used below) will use as a background image any
image file containing "background" in its name.
show_banner: true
limit_banner: 2 # Default to 2, adjust as needed
banners:
- message:
'<i class="fas fa-bullhorn"></i> We are happy to announce that Elastic''s
donation of the [**eBPF profiling agent has been
accepted**](/blog/2024/elastic-contributes-continuous-profiling-agent)!'
to: 2024-07-25
- message:
'<i class="fas fa-bullhorn"></i> Join us for [**OTel Community Day** on
June
25th](https://events.linuxfoundation.org/open-telemetry-community-day/)!'
to: 2024-06-25
---

<div class="d-none"><a rel="me" href="https://fosstodon.org/@opentelemetry"></a></div>
Expand All @@ -38,9 +26,9 @@ banners:

<div class="l-primary-buttons mt-5">

- [Learn more](/docs/what-is-opentelemetry/)
- [Try the demo](/docs/demo/)
- [Explore integrations](/ecosystem/integrations)
- [Learn more](docs/what-is-opentelemetry/)
- [Try the demo](docs/demo/)
- [Explore integrations](/ecosystem/integrations/)

</div>

Expand All @@ -49,8 +37,8 @@ banners:
</div>
<div class="l-get-started-buttons">

- [Dev](/docs/getting-started/dev/)
- [Ops](/docs/getting-started/ops/)
- [Dev](docs/getting-started/dev/)
- [Ops](docs/getting-started/ops/)

</div>
{{< /blocks/cover >}}
Expand All @@ -62,7 +50,7 @@ generate, collect, and export telemetry data (metrics, logs, and traces) to help
you analyze your software's performance and behavior.

> OpenTelemetry is **generally available** across
> [several languages](/docs/languages/) and is suitable for use.
> [several languages](docs/languages/) and is suitable for use.
{{% /blocks/lead %}}

Expand Down
5 changes: 5 additions & 0 deletions content/en/announcements/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Announcements
cascade:
type: docs
---
8 changes: 8 additions & 0 deletions content/en/announcements/eBPF.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: eBPF
date: 2024-06-07
expiryDate: 2024-07-25
---

Elastic's **eBPF profiling agent** is now part of OTel.
[Learn more](/blog/2024/elastic-contributes-continuous-profiling-agent)
10 changes: 10 additions & 0 deletions content/en/announcements/otel-community-day.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: OTel Community Day
date: 2024-04-05
expiryDate: 2024-06-25
weight: -1 # top
---

<i class="fas fa-bullhorn"></i> Join us for
[**OTel Community Day**](https://events.linuxfoundation.org/open-telemetry-community-day/)
on June 25th
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: Elastic Contributes its Continuous Profiling Agent to OpenTelemetry
linkTitle: Elastic Contributes Profiling Agent # Mandatory, make sure that your short title.
linkTitle: Elastic Contributes Profiling Agent
date: 2024-06-07
# prettier-ignore
cSpell:ignore: Bahubali Christos Dmitry Filimonov Geisendörfer Halliday Kalkanis Shetti
author:
>- # If you have only one author, then add the single name on this line in quotes.
author: >
[Bahubali Shetti](https://github.com/bshetti) (Elastic), [Alexander
Wert](https://github.com/AlexanderWert) (Elastic), [Morgan
McLean](https://github.com/mtwo) (Splunk), [Ryan
Expand Down
2 changes: 1 addition & 1 deletion content/en/community/end-user/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ right place!
[OpenTelemetry YouTube channel](https://www.youtube.com/@otel-official)
- To provide feedback and help prioritize issues:
- Participate in a [direct interview/feedback session](interviews-feedback/)
- Take a [survey](/community/end-user/feedback-survey/)
- Take a [survey](feedback-survey/)
- Join a panel discussion (more info coming soon!)
- Vote on issues (more info coming soon!)

Expand Down
9 changes: 4 additions & 5 deletions content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,12 @@ aliases: [/docs/workshop/*]
OpenTelemetry, also known as OTel, is a vendor-neutral open source
[Observability](concepts/observability-primer/#what-is-observability) framework
for instrumenting, generating, collecting, and exporting telemetry data such as
[traces](/docs/concepts/signals/traces/),
[metrics](/docs/concepts/signals/metrics/), and
[logs](/docs/concepts/signals/logs/).
[traces](concepts/signals/traces/), [metrics](concepts/signals/metrics/), and
[logs](concepts/signals/logs/).

As an industry-standard, OpenTelemetry is
[supported by more than 40 observability vendors](/ecosystem/vendors/),
integrated by many [libraries, services, and apps](/ecosystem/integrations), and
adopted by [numerous end users](/ecosystem/adopters).
integrated by many [libraries, services, and apps](/ecosystem/integrations/),
and adopted by [numerous end users](/ecosystem/adopters/).

![OpenTelemetry Reference Architecture](/img/otel-diagram.svg)
47 changes: 47 additions & 0 deletions content/en/docs/contributing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,53 @@ Keep the following in mind when filing an issue:
Respect your fellow contributors. For example, "The docs are terrible" is not
helpful or polite feedback.

## Announcement management

An announcement is a _regular Hugo page_ contained under the `announcements`
section of a locale. This means that we leverage Hugo's builtin handling of page
dates (future or expired), internationalization, and more, to automatically show
or hide banners depending on the build date, determine banner ordering, handle
fall back to English banners, etc.

> Announcements are currently used as banners only. We _might_ eventually
> support slightly more general announcements as well.
### Creating an announcement

To add a new announcement, create an announcement markdown file under the
`announcements` folder of your localization using the following command:

```sh
hugo new --kind announcement content/YOUR-LOCALE/announcements/announcement-file-name.md
```

Adjust according to your desired locale and file name. Add the announcement text
as the body of the page.

> For banners, the announcement body should be a short phrase.
{{% alert title="For localizations" %}}

If you are creating a **locale specific announcement override**, make sure that
you use the **same filename** as the English language announcement.

{{% /alert %}}

### Announcement list

Any given announcement will appear in a site build when the build date falls
between the `date` and `expiryDate` fields of the announcement. When those
fields are missing they are assumed to be "now" and "forever", respectively.

Announcements will appear in the standard page order as determined using Hugo's
[Regular pages](https://gohugo.io/methods/site/regularpages/) function. That is,
the "lightest" announcements (by `weight`) will appear first; when weights are
the same or unspecified, the most recent announcements (by `date`) will appear
first, etc.

So, if you want to force an announcement to the top, use a negative `weight` in
the front matter.

## Contribute to other repositories

OpenTelemetry is an open source project, and we gladly accept new contributions
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ observability with OpenTelemetry looks like!

</div>

[^1]: If none of these roles apply to you, [let us know!][].
[^1]: If none of these roles apply to you, [let us know][].

[demo]: /ecosystem/demo/
[let us know!]:
[let us know]:
https://github.com/open-telemetry/opentelemetry.io/issues/new?title=Add%20a%20new%20persona:%20My%20Persona&body=Provide%20a%20description%20of%20your%20role%20and%20responsibilities%20and%20what%20your%20observability%20goals%20are
34 changes: 17 additions & 17 deletions content/en/docs/getting-started/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,27 @@ OpenTelemetry can help you! To accomplish your goals of having your dependencies
instrumented automatically and instrumenting your own code with our API
manually, we recommend that you learn the following concepts first:

- [What is OpenTelemetry?](/docs/what-is-opentelemetry/)
- [How can I add instrumentation to my code base?](/docs/concepts/instrumentation/code-based/)
- [What is OpenTelemetry?](../../what-is-opentelemetry/)
- [How can I add instrumentation to my code base?](../../concepts/instrumentation/code-based/)

If you develop libraries, frameworks or middleware that is used as a dependency
within other software, we recommend that you learn how you can provide telemetry
natively:

- [How can I add native instrumentation to my library?](/docs/concepts/instrumentation/libraries/)
- [How can I add native instrumentation to my library?](../../concepts/instrumentation/libraries/)

Next, you can deep dive into the documentations for the
[language](/docs/languages/) you are using:

- [C++](/docs/languages/cpp/)
- [.NET](/docs/languages/net/)
- [Erlang / Elixir](/docs/languages/erlang/)
- [Go](/docs/languages/go/)
- [Java](/docs/languages/java/)
- [JavaScript / TypeScript](/docs/languages/js/)
- [PHP](/docs/languages/php/)
- [Python](/docs/languages/python/)
- [Ruby](/docs/languages/ruby/)
- [Rust](/docs/languages/rust/)
- [Swift](/docs/languages/swift/)
- [Other](/docs/languages/other/)
[language](../../languages/) you are using:

- [C++](../../languages/cpp/)
- [.NET](../../languages/net/)
- [Erlang / Elixir](../../languages/erlang/)
- [Go](../../languages/go/)
- [Java](../../languages/java/)
- [JavaScript / TypeScript](../../languages/js/)
- [PHP](../../languages/php/)
- [Python](../../languages/python/)
- [Ruby](../../languages/ruby/)
- [Rust](../../languages/rust/)
- [Swift](../../languages/swift/)
- [Other](../../languages/other/)
10 changes: 5 additions & 5 deletions content/en/docs/getting-started/ops.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ OpenTelemetry can help you! To accomplish your goal of getting telemetry out of
applications without touching their code, we recommend that you learn the
following:

- [What is OpenTelemetry?](/docs/what-is-opentelemetry/)
- [How can I instrument applications without touching their code?](/docs/concepts/instrumentation/zero-code/)
- [How can I set up a collector?](/docs/collector/)
- [How can I get automation for Kubernetes with the OpenTelemetry Operator?](/docs/kubernetes/operator/)
- [What is OpenTelemetry?](../../what-is-opentelemetry/)
- [How can I instrument applications without touching their code?](../../concepts/instrumentation/zero-code/)
- [How can I set up a collector?](../../collector/)
- [How can I get automation for Kubernetes with the OpenTelemetry Operator?](../../kubernetes/operator/)

If you are looking for a set of applications to try things out, you will find
our official [OpenTelemetry demo](/ecosystem/demo/) useful!
our official [OpenTelemetry demo](/ecosystem/demo/) useful.
2 changes: 1 addition & 1 deletion content/en/docs/languages/go/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,7 @@ Modify `rolldice.go` to include custom instrumentation using OpenTelemetry API:
package main

import (
"fmt"
"io"
"log"
"math/rand"
Expand All @@ -388,7 +389,6 @@ import (
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/metric"
"go.opentelemetry.io/otel/sdk/instrumentation"
)

const name = "rolldice"
Expand Down
29 changes: 29 additions & 0 deletions content/en/docs/languages/go/instrumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -534,6 +534,35 @@ func removeItem() {
}
```

### Using Gauges

Gauges are used to measure non-additive values when changes occur.

For example, here's how you might report the current speed of a CPU fan:

```go
import (
"net/http"

"go.opentelemetry.io/otel/metric"
)

func init() {
speedGauge, err := meter.Int64Gauge(
"cpu.fan.speed",
metric.WithDescription("Speed of CPU fan"),
metric.WithUnit("RPM"),
)
if err != nil {
panic(err)
}
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
// hard-code 1500 RPM for demonstrative purposes
speedGauge.Record(r.Context(), 1500)
})
}
```

### Using Histograms

Histograms are used to measure a distribution of values over time.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/java/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ aliases: [/java, /java/metrics, /java/tracing]
cascade:
vers:
instrumentation: 2.4.0
otel: 1.38.0
otel: 1.39.0
semconv: 1.25.0
weight: 18
---
Expand Down
4 changes: 2 additions & 2 deletions content/ja/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: OpenTelemetry
description: >-
効果的な観測を可能にする、高品質でユビキタスかつポータブルなテレメトリー
developer_note:
blocks/coverコラム(以下で使用)は、ファイル名に "background" を含む画像ファイルを背景画像として使用します。
developer_note: blocks/coverコラム(以下で使用)は、ファイル名に "background" を含む画像ファイルを背景画像として使用します。
show_banner: true
default_lang_commit: 902043db
---

Expand Down
12 changes: 12 additions & 0 deletions content/ja/announcements/otel-community-day.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: OTel Community Day
date: 2024-04-05
expiryDate: 2024-06-25
weight: -1 # top
default_lang_commit: 788509efd404ba35dd113b4f37bae96ca7558e3e
---

<i class="fas fa-bullhorn"></i>
6月25日に開催される
[**OTel コミュニティデー**](https://events.linuxfoundation.org/open-telemetry-community-day/)
にご参加ください
4 changes: 2 additions & 2 deletions content/ja/docs/what-is-opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ OpenTelemetryの主な目的は、あなたのアプリケーションやシス

OpenTelemetryは、2つの重要な原則に従いながら、オブザーバビリティの需要を満たしています。

1. あなたが生成したデータはあなたのものです。ベンダーのロックインはありません。
2. APIと規約は1セットだけ覚えれば良いです。
1. あなたが生成したデータはあなたのものです。ベンダーのロックインはありません。
2. APIと規約は1セットだけ覚えれば良いです。

この2つの原則を組み合わせることで、現代のコンピューティングの世界で必要とされる柔軟性をチームや組織に与えられます。

Expand Down
1 change: 1 addition & 0 deletions content/zh/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ show_banner: true
developer_note:
下文所用的 blocks/cover 短代码将使用文件名中包含 "background"
的图像文件作为背景图。
show_banner: true
default_lang_commit: 6e35a949
---

Expand Down
Loading

0 comments on commit bdea146

Please sign in to comment.