Skip to content

Commit 5eeeeec

Browse files
committed
Merge remote-tracking branch 'origin/main' into otelbot/spec-integration-v1.52.0-dev
2 parents 93b9529 + 181d240 commit 5eeeeec

File tree

18 files changed

+981
-954
lines changed

18 files changed

+981
-954
lines changed

config/_default/hugo.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ languages:
5757
params:
5858
description: OpenTelemetry 项目网站
5959

60+
enableEmoji: true
61+
6062
imaging:
6163
resampleFilter: CatmullRom # cspell:disable-line
6264
quality: 75

content/en/blog/2024/spring-starter-stable/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Note that the Spring Starter uses some semantic conventions that are not stable,
7979
which are still evolving and may change in the future.
8080
[HTTP semantic conventions](/docs/specs/semconv/http/http-metrics/) are stable
8181
and will not change.
82-
[Database semantic conventions](/docs/specs/semconv/database/database-metrics/)
82+
[Database semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/v1.38.0/docs/database/database-metrics.md)
8383
are still experimental and may change. However, they are expected to become
8484
stable at the end of 2024.
8585

content/en/blog/2025/complex-attribute-types.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,9 @@ Examples include:
7171
inherently structured
7272
- **GraphQL** — responses may include
7373
[lists of structured errors](https://graphql.org/learn/response/#errors)
74-
- **[Database operations](/docs/specs/semconv/database/database-spans)** — batch
75-
operations have properties that flat attributes cannot adequately capture
74+
- **[Database operations](https://github.com/open-telemetry/semantic-conventions/blob/v1.38.0/docs/database/database-spans.md)**
75+
— batch operations have properties that flat attributes cannot adequately
76+
capture
7677

7778
Before extending support for complex attributes to all signals, we explored
7879
several alternatives:

content/en/community/end-user/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ CNCF Slack! Not there yet?
101101

102102
{{% alert title="For OpenTelemetry contributors" %}}
103103

104-
Is your SIG in need of insights from end users?:female-detective: Are you
104+
Is your SIG in need of insights from end users? :female_detective: Are you
105105
wanting to find out whether end users are using or even aware of a feature your
106106
SIG has developed? Or perhaps you're looking for some general feedback about the
107107
thing you've spent hours working on? Reach out to the End User SIG on Slack

content/en/docs/collector/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Collector
33
description: Vendor-agnostic way to receive, process and export telemetry data.
44
aliases: [./about]
5+
sidebar_root_for: children
56
cascade:
67
vers: 0.140.0
78
weight: 270

content/en/docs/collector/deployment/_index.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
---
2-
title: Deployment
3-
description: Patterns you can apply to deploy the OpenTelemetry collector
2+
title: Deploy the Collector
3+
linkTitle: Deploy
4+
description: Patterns you can apply to deploy the OpenTelemetry Collector
45
weight: 3
56
---
67

7-
The OpenTelemetry Collector consists of a single binary which you can use in
8-
different ways, for different use cases. This section describes deployment
9-
patterns, their use cases along with pros and cons and best practices for
10-
collector configurations for cross-environment and multi-backend deployments.
11-
For deployment security considerations, see [Collector hosting best
8+
The OpenTelemetry Collector consists of a single binary that you can deploy in
9+
different ways for different use cases. This section describes common deployment
10+
patterns, their use cases, and pros and cons. It also provides best practices
11+
for configuring the Collector in cross-environment and multi-backend scenarios.
12+
For deployment-related security considerations, see the [Collector hosting best
1213
practices][security].
1314

14-
## Resources
15+
## Additional resources
1516

16-
- KubeCon NA 2021 Talk on [OpenTelemetry Collector Deployment
17+
- KubeCon NA 2021 talk on [OpenTelemetry Collector Deployment
1718
Patterns][y-patterns]
18-
- [Deployment Patterns][gh-patterns] accompanying the talk
19+
- [Deployment patterns][gh-patterns] accompanying the talk
1920

2021
[security]: /docs/security/hosting-best-practices/
2122
[gh-patterns]:

content/en/docs/collector/deployment/agent.md

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,37 @@ weight: 2
66
cSpell:ignore: prometheusremotewrite
77
---
88

9-
The agent collector deployment pattern consists of applications —
10-
[instrumented][instrumentation] with an OpenTelemetry SDK using [OpenTelemetry
11-
protocol (OTLP)][otlp] — or other collectors (using the OTLP exporter) that send
12-
telemetry signals to a [collector][] instance running with the application or on
13-
the same host as the application (such as a sidecar or a daemonset).
9+
In the agent deployment pattern, telemetry signals can come from
1410

15-
Each client-side SDK or downstream collector is configured with a collector
16-
location:
11+
- Applications [instrumented][instrumentation] with an OpenTelemetry SDK using
12+
the [OpenTelemetry Protocol (OTLP)][otlp]
13+
- Collectors using the OTLP exporter
14+
15+
The signals are sent to a [Collector][collector] instance that runs alongside
16+
the application or on the same host, such as a sidecar or DaemonSet.
17+
18+
Each client-side SDK or downstream Collector is configured with the address of a
19+
Collector instance:
1720

1821
![Decentralized collector deployment concept](../../img/otel-agent-sdk.svg)
1922

20-
1. In the app, the SDK is configured to send OTLP data to a collector.
21-
1. The collector is configured to send telemetry data to one or more backends.
23+
1. In the application, the SDK is configured to send OTLP data to a Collector.
24+
1. The Collector is configured to send telemetry data to one or more backends.
2225

2326
## Example
2427

25-
A concrete example of the agent collector deployment pattern could look as
26-
follows: you manually instrument, say, a [Java application to export
27-
metrics][instrument-java-metrics] using the OpenTelemetry Java SDK. In the
28-
context of the app, you would set the `OTEL_METRICS_EXPORTER` to `otlp` (which
29-
is the default value) and configure the [OTLP exporter][otlp-exporter] with the
30-
address of your collector, for example (in Bash or `zsh` shell):
28+
In this example of the agent deployment pattern, begin by manually instrumenting
29+
a [Java application to export metrics][instrument-java-metrics] using the
30+
OpenTelemetry Java SDK, including the default `OTEL_METRICS_EXPORTER` value,
31+
`otlp`. Next, configure the [OTLP exporter][otlp-exporter] with the address of
32+
your Collector. For example:
3133

3234
```shell
3335
export OTEL_EXPORTER_OTLP_ENDPOINT=http://collector.example.com:4318
3436
```
3537

36-
The collector serving at `collector.example.com:4318` would then be configured
37-
like so:
38+
Next, configure the Collector running at `collector.example.com:4318` as
39+
follows:
3840

3941
{{< tabpane text=true >}} {{% tab Traces %}}
4042

@@ -103,20 +105,22 @@ service:
103105
104106
{{% /tab %}} {{< /tabpane >}}
105107
106-
If you want to try it out for yourself, you can have a look at the end-to-end
107-
[Java][java-otlp-example] or [Python][py-otlp-example] examples.
108+
To explore this pattern end to end, see the [Java][java-otlp-example] or
109+
[Python][py-otlp-example] examples.
110+
111+
## Trade-offs
108112
109-
## Tradeoffs
113+
Here are the key pros and cons of using an agent collector:
110114
111115
Pros:
112116
113-
- Simple to get started
114-
- Clear 1:1 mapping between application and collector
117+
- Straightforward to get started
118+
- Clear one-to-one mapping between application and Collector
115119
116120
Cons:
117121
118-
- Scalability (human and load-wise)
119-
- Inflexible
122+
- Limited scalability for teams and infrastructure resources
123+
- Inflexible for complex or evolving deployments
120124
121125
[instrumentation]: /docs/languages/
122126
[otlp]: /docs/specs/otel/protocol/
Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,34 @@
11
---
22
title: No Collector
3-
description: Why and how to send signals directly from app to backends
3+
description:
4+
Why and how to send signals directly from an application to backends
45
weight: 1
56
---
67

7-
The simplest pattern is not to use a collector at all. This pattern consists of
8-
applications [instrumented][instrumentation] with an OpenTelemetry SDK that
9-
export telemetry signals (traces, metrics, logs) directly into a backend:
8+
The most direct deployment pattern doesn't use a Collector at all. In this
9+
approach, applications [instrumented][instrumentation] with an OpenTelemetry SDK
10+
export telemetry signals (traces, metrics, and logs) straight to a backend:
1011

1112
![No collector deployment concept](../../img/otel-sdk.svg)
1213

1314
## Example
1415

15-
See the [code instrumentation for programming languages][instrumentation] for
16-
concrete end-to-end examples for how to export signals from your app directly
17-
into a backend.
16+
See the [instrumentation documentation][instrumentation] for end-to-end examples
17+
that show how to export signals directly from your application to a backend.
1818

19-
## Tradeoffs
19+
## Trade-offs
20+
21+
Here are the key pros and cons of skipping the Collector:
2022

2123
Pros:
2224

23-
- Simple to use (especially in a dev/test environment)
24-
- No additional moving parts to operate (in production environments)
25+
- Straightforward to use, especially in development and test environments
26+
- No additional moving parts to deploy or operate
2527

2628
Cons:
2729

28-
- Requires code changes if collection, processing, or ingestion changes
29-
- Strong coupling between the application code and the backend
30-
- There are limited number of exporters per language implementation
30+
- Requires code changes if collection, processing, or ingestion needs change
31+
- Strong coupling between application code and backend storage or visualization
32+
- Each language implementation supports only a limited number of exporters
3133

3234
[instrumentation]: /docs/languages/

content/en/docs/contributing/_index.md

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,43 @@ title: Contributing
33
aliases: [/docs/contribution-guidelines]
44
sidebar_root_for: self
55
weight: 980
6+
cascade:
7+
chooseAnIssueAtYourLevel: |
8+
Make sure to [choose an issue] that matches your level of **experience** and
9+
**understanding** of OpenTelemetry. Avoid overreaching your capabilities.
10+
_issues: https://github.com/open-telemetry/opentelemetry.io/issues
11+
_issue: https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A
612
---
713

8-
Thanks for your interest in contributing to the OpenTelemetry docs and website.
14+
{{% alert title="Thank you for your interest!" color=success %}}
15+
16+
Thank you for your interest in contributing to the OpenTelemetry docs and
17+
website.
18+
19+
{{% /alert %}}
20+
21+
## <i class='far fa-exclamation-triangle text-warning '></i> First time contributing? {#first-time-contributing}
22+
23+
- **[Choose an issue]** with the following labels:
24+
- [Good first issue](<{{% param _issue %}}%22good+first+issue%22>)
25+
- [Help wanted](<{{% param _issue %}}%3A%22help+wanted%22>)
26+
27+
{{% alert title="We do not assign issues" color="warning" %}}
28+
29+
We **_do not_ assign issues** to those who have not already made contributions
30+
to the [OpenTelemetry organization][org], unless part of a confirmed
31+
mentorship or onboarding process.
32+
33+
[org]: https://github.com/open-telemetry
34+
35+
{{% /alert %}}
36+
37+
- {{% param chooseAnIssueAtYourLevel %}}
38+
39+
- Want to work other issues or larger changes? [Discuss it with maintainers
40+
first][].
41+
42+
[discuss it with maintainers first]: issues/#fixing-an-existing-issue
943

1044
## Jump right in!
1145

@@ -20,17 +54,8 @@ What do you want to do?
2054
- [Submitting content]
2155

2256
[Prerequisites]: prerequisites/
23-
[Issues]: issues/
2457
[Submitting content]: pull-requests/
2558

26-
{{% alert title="<i class='far fa-exclamation-triangle'></i> First time contributing? " %}}
27-
28-
Eager first-time contributors, see
29-
[Fixing an existing issue](issues/#fixing-an-existing-issue) for important
30-
guidance.
31-
32-
{{% /alert %}}
33-
3459
## What can I contribute to?
3560

3661
OpenTelemetry documentation contributors:
@@ -48,6 +73,7 @@ the community [OpenTelemetry New Contributor Guide]. Every [OTel
4873
repository][org] for language implementations, the Collector, and conventions
4974
have their own project-specific contributing guides.
5075

76+
[choose an issue]: issues/#fixing-an-existing-issue
77+
[issues]: issues/
5178
[OpenTelemetry New Contributor Guide]:
5279
https://github.com/open-telemetry/community/blob/main/guides/contributor
53-
[org]: https://github.com/open-telemetry

content/en/docs/contributing/issues.md

Lines changed: 7 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -5,50 +5,20 @@ description:
55
improvement.
66
weight: 10
77
_issues: https://github.com/open-telemetry/opentelemetry.io/issues
8-
_issue: https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A
98
cSpell:ignore: prepopulated
109
---
1110

12-
<style>
13-
/* Force all list to be compact. */
14-
li > p {
15-
margin-bottom: 0;
16-
}
17-
18-
/* Style "first time" alert */
19-
.alert--first-timer {
20-
margin: 0.5rem 0 !important;
21-
22-
> blockquote {
23-
margin-top: 1rem;
24-
margin-bottom: 0;
25-
border-left-color: var(--bs-warning);
26-
background-color: var(--bs-danger-bg-subtle);
27-
> *:last-child {
28-
margin-bottom: 0;
29-
}
30-
}
31-
}
32-
</style>
33-
3411
## Fixing an existing issue
3512

36-
One of the best ways to help make OTel docs better is to fix an existing issue.
13+
One of the best ways to help improve the documentation is to fix an existing
14+
issue.
3715

3816
1. Browse through the list of [issues]({{% param _issues %}}).
39-
2. Select an issue that you would like to work on, ideally one that you can fix
40-
in a short amount of time. <a name="first-issue"></a>
41-
{{% alert title="First time contributing?" color="primary alert--first-timer" %}}
42-
43-
Select an issue with the following labels:
44-
- [Good first issue](<{{% param _issue %}}%22good+first+issue%22>)
45-
- [Help wanted](<{{% param _issue %}}%3A%22help+wanted%22>)
46-
47-
> **NOTE**: we **_do not_ assign issues** to those who have not already made
48-
> contributions to the [OpenTelemetry organization][org], unless part of a
49-
> mentorship or onboarding process.
50-
>
51-
> [org]: https://github.com/open-telemetry
17+
2. Select an issue that you would like to work on.
18+
19+
{{% alert color="warning" %}}
20+
21+
{{% param chooseAnIssueAtYourLevel %}}
5222

5323
{{% /alert %}}
5424

0 commit comments

Comments
 (0)