Skip to content

Commit 460c4cf

Browse files
y82JTorreG
andauthored
Apply suggestions from code review
Co-authored-by: Jon Torre <[email protected]>
1 parent c21f555 commit 460c4cf

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

content/nginx/admin-guide/dynamic-modules/opentelemetry.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ type:
1313

1414
[OpenTelemetry](https://opentelemetry.io/) (OTel) is an observability framework for monitoring, tracing, troubleshooting, and optimizing applications. OTel enables the collection of telemetry data from a deployed application stack.
1515

16-
The `nginx-plus-module-otel` module is NGINX-authored dynamic module that enables NGINX Plus to send telemetry data to an OTel collector. The module supports [W3C](https://w3c.github.io/trace-context/) trace context propagation, OpenTelemetry Protocol (OTLP)/gRPC trace exports, and offers several advantages over existing OTel modules including:
16+
The `nginx-plus-module-otel` module is an NGINX-authored dynamic module that enables NGINX Plus to send telemetry data to an OTel collector. The module supports [W3C](https://w3c.github.io/trace-context/) trace context propagation, OpenTelemetry Protocol (OTLP)/gRPC trace exports, and offers several advantages over existing OTel modules including:
1717

1818
- Enhanced performance: other OTel implementations can reduce request processing by up to 50%, while `nginx-plus-module-otel` minimizes this impact to just 10-15%.
1919

@@ -28,13 +28,13 @@ The repository can be found on [GitHub](https://github.com/nginxinc/nginx-otel).
2828

2929
## Installation {#install}
3030

31-
Similar to [NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}), prebuilt packages of the `nginx-plus-module-otel` module can can be installed directly from the official repository for different distributions. Before installation you will need to add NGINX Plus package repositories for your distribution and update the repository metadata.
31+
Similar to [NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}), prebuilt packages of the `nginx-plus-module-otel` module can can be installed directly from the official repository for different distributions. Before installation you will need to add the NGINX Plus package repositories for your distribution and update the repository metadata.
3232

3333
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.
3434

3535
{{< note >}} The OpenTelemetry module cannot be installed on Amazon Linux 2 LTS and SLES 15 SP5+. {{< /note >}}
3636

37-
2. Make sure you have the latest version of NGINX Plus or you have upgraded NGINX Plus to the latest version. In Terminal, run the command:
37+
2. Make sure you have the latest version of NGINX Plus. In Terminal, run the command:
3838

3939
```shell
4040
nginx -v
@@ -46,7 +46,7 @@ Similar to [NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-
4646
nginx version: nginx/1.27.4 (nginx-plus-r34)
4747
```
4848

49-
3. Make sure you have installed dependencies required for your operating system.
49+
3. Make sure you have installed the dependencies required for your operating system.
5050

5151
For Amazon Linux 2023, AlmaLinux, CentOS, Oracle Linux, RHEL, and Rocky Linux:
5252

@@ -104,9 +104,9 @@ Similar to [NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-
104104

105105
For Alpine, upload **nginx-repo.crt** to **/etc/apk/cert.pem** and **nginx-repo.key** to **/etc/apk/cert.key**. Ensure these files contain only the specific key and certificate as Alpine Linux does not support mixing client certificates for multiple repositories.
106106

107-
4. Make sure your package management system is configured to pull from NGINX Plus repository. See [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) for details.
107+
4. Make sure your package management system is configured to pull from the NGINX Plus repository. See [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) for details.
108108

109-
4. Update the repository information and install the package. In Terminal, run the appropriate command for your operating system.
109+
4. Update the repository information and install the package. In a terminal, run the appropriate command for your operating system.
110110

111111
For CentOS, Oracle Linux, and RHEL:
112112

@@ -143,7 +143,7 @@ Similar to [NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-
143143
sudo pkg install nginx-plus-module-otel
144144
```
145145

146-
The module will be installed into `/usr/local/nginx` directory.
146+
The module will be installed in the `/usr/local/nginx` directory.
147147

148148
6. Copy the `ngx_otel_module.so` dynamic module binary to `/usr/local/nginx/modules`.
149149

@@ -242,7 +242,7 @@ http {
242242
}
243243
```
244244

245-
## More Info {#info}
245+
## More info {#info}
246246

247247
- [GitHub Repository for the NGINX Native OpenTelemetry Module](https://github.com/nginxinc/nginx-otel)
248248

0 commit comments

Comments
 (0)