Skip to content

Commit d00e8f3

Browse files
harshaskumar05tiffany76otelbot[bot]
authored
docs: copy edit deployment pages (#8400)
Co-authored-by: Tiffany Hrabusa <[email protected]> Co-authored-by: otelbot <[email protected]>
1 parent 1210832 commit d00e8f3

File tree

3 files changed

+54
-47
lines changed

3 files changed

+54
-47
lines changed

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/

0 commit comments

Comments
 (0)