From 5dd9ad8b77006e30cc58961b51d7e5bb2f605ce0 Mon Sep 17 00:00:00 2001 From: adity1raut Date: Sun, 9 Nov 2025 16:40:01 +0530 Subject: [PATCH 1/9] Update Installation Signed-off-by: adity1raut --- content/en/docs/collector/Install/_index.md | 28 ++ .../en/docs/collector/Install/binary/linux.md | 140 ++++++++ .../en/docs/collector/Install/binary/macos.md | 32 ++ .../docs/collector/Install/binary/windows.md | 30 ++ content/en/docs/collector/Install/docker.md | 62 ++++ .../en/docs/collector/Install/kubernetes.md | 28 ++ content/en/docs/collector/installation.md | 299 ------------------ content/en/docs/collector/quick-start.md | 2 +- 8 files changed, 321 insertions(+), 300 deletions(-) create mode 100644 content/en/docs/collector/Install/_index.md create mode 100644 content/en/docs/collector/Install/binary/linux.md create mode 100644 content/en/docs/collector/Install/binary/macos.md create mode 100644 content/en/docs/collector/Install/binary/windows.md create mode 100644 content/en/docs/collector/Install/docker.md create mode 100644 content/en/docs/collector/Install/kubernetes.md delete mode 100644 content/en/docs/collector/installation.md diff --git a/content/en/docs/collector/Install/_index.md b/content/en/docs/collector/Install/_index.md new file mode 100644 index 000000000000..169f8e2cd0e0 --- /dev/null +++ b/content/en/docs/collector/Install/_index.md @@ -0,0 +1,28 @@ +--- +title: Install the Collector +aliases: [../install/] +weight: 2 +--- + +You can deploy the OpenTelemetry Collector on a wide variety of operating +systems and architectures. The following instructions show how to download and +install the latest stable version of the Collector. + +If you aren't familiar with the deployment models, components, and repositories +applicable to the OpenTelemetry Collector, first review the [Data Collection][] +and [Deployment Methods][] page. + +## Build from source + +You can build the latest version of the Collector based on the local operating +system using the following commands: + +```sh +git clone https://github.com/open-telemetry/opentelemetry-collector.git +cd opentelemetry-collector +make install-tools +make otelcorecol +``` + +[data collection]: /docs/concepts/components/#collector +[deployment methods]: ../deployment/ diff --git a/content/en/docs/collector/Install/binary/linux.md b/content/en/docs/collector/Install/binary/linux.md new file mode 100644 index 000000000000..b27b80abaab3 --- /dev/null +++ b/content/en/docs/collector/Install/binary/linux.md @@ -0,0 +1,140 @@ +--- +title: Install the Collector on Linux +aliases: [/docs/collector/install/#linux] +--- + +## Linux + +Every Collector release includes APK, DEB and RPM packaging for Linux +amd64/arm64/i386 systems. You can find the default configuration in +`/etc/otelcol/config.yaml` after installation. + +> Note: `systemd` is required for automatic service configuration. + +### DEB Installation + +To get started on Debian systems run the following commands: + +{{< tabpane text=true >}} {{% tab AMD64 %}} + +```sh +sudo apt-get update +sudo apt-get -y install wget +wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_amd64.deb +sudo dpkg -i otelcol_{{% param vers %}}_linux_amd64.deb +``` + +{{% /tab %}} {{% tab ARM64 %}} + +```sh +sudo apt-get update +sudo apt-get -y install wget +wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_arm64.deb +sudo dpkg -i otelcol_{{% param vers %}}_linux_arm64.deb +``` + +{{% /tab %}} {{% tab i386 %}} + +```sh +sudo apt-get update +sudo apt-get -y install wget +wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_386.deb +sudo dpkg -i otelcol_{{% param vers %}}_linux_386.deb +``` + +{{% /tab %}} {{< /tabpane >}} + +### RPM Installation + +To get started on Red Hat systems run the following commands: + +{{< tabpane text=true >}} {{% tab AMD64 %}} + +```sh +sudo yum update +sudo yum -y install wget systemctl +wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_amd64.rpm +sudo rpm -ivh otelcol_{{% param vers %}}_linux_amd64.rpm +``` + +{{% /tab %}} {{% tab ARM64 %}} + +```sh +sudo yum update +sudo yum -y install wget systemctl +wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_arm64.rpm +sudo rpm -ivh otelcol_{{% param vers %}}_linux_arm64.rpm +``` + +{{% /tab %}} {{% tab i386 %}} + +```sh +sudo yum update +sudo yum -y install wget systemctl +wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_386.rpm +sudo rpm -ivh otelcol_{{% param vers %}}_linux_386.rpm +``` + +{{% /tab %}} {{< /tabpane >}} + +### Manual Linux installation + +Linux [releases][] are available for various architectures. You can download the +file containing the binary and install it on your machine manually: + +{{< tabpane text=true >}} {{% tab AMD64 %}} + +```sh +curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_amd64.tar.gz +tar -xvf otelcol_{{% param vers %}}_linux_amd64.tar.gz +``` + +{{% /tab %}} {{% tab ARM64 %}} + +```sh +curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_arm64.tar.gz +tar -xvf otelcol_{{% param vers %}}_linux_arm64.tar.gz +``` + +{{% /tab %}} {{% tab i386 %}} + +```sh +curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_386.tar.gz +tar -xvf otelcol_{{% param vers %}}_linux_386.tar.gz +``` + +{{% /tab %}} {{% tab ppc64le %}} + +```sh +curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_ppc64le.tar.gz +tar -xvf otelcol_{{% param vers %}}_linux_ppc64le.tar.gz +``` + +{{% /tab %}} {{< /tabpane >}} + +### Automatic service configuration + +By default, the `otelcol` systemd service starts with the +`--config=/etc/otelcol/config.yaml` option after installation. + +To use a different settings, set the `OTELCOL_OPTIONS` variable in the +`/etc/otelcol/otelcol.conf` systemd environment file to the appropriate +command-line options. You can run `/usr/bin/otelcol --help` to see all available +options. You can pass additional environment variables to the `otelcol` service +by adding them to this file. + +If you modify the Collector configuration file or `/etc/otelcol/otelcol.conf`, +restart the `otelcol` service to apply the changes by running: + +```sh +sudo systemctl restart otelcol +``` + +To check the output from the `otelcol` service, run: + +```sh +sudo journalctl -u otelcol +``` + +[releases]: + https://github.com/open-telemetry/opentelemetry-collector-releases/releases diff --git a/content/en/docs/collector/Install/binary/macos.md b/content/en/docs/collector/Install/binary/macos.md new file mode 100644 index 000000000000..7e783515c32d --- /dev/null +++ b/content/en/docs/collector/Install/binary/macos.md @@ -0,0 +1,32 @@ +--- +title: Install the Collector on macOS +aliases: [/docs/collector/installation/#macos] +--- + +## macOS + +macOS [releases][] are available for Intel and ARM systems. The releases are +packaged as gzipped tarballs (`.tar.gz`). To unpack them, run the following +commands: + +{{< tabpane text=true >}} {{% tab Intel %}} + +```sh +curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_darwin_amd64.tar.gz +tar -xvf otelcol_{{% param vers %}}_darwin_amd64.tar.gz +``` + +{{% /tab %}} {{% tab ARM %}} + +```sh +curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_darwin_arm64.tar.gz +tar -xvf otelcol_{{% param vers %}}_darwin_arm64.tar.gz +``` + +{{% /tab %}} {{< /tabpane >}} + +Every Collector release includes an `otelcol` executable that you can run after +unpacking. + +[releases]: + https://github.com/open-telemetry/opentelemetry-collector-releases/releases diff --git a/content/en/docs/collector/Install/binary/windows.md b/content/en/docs/collector/Install/binary/windows.md new file mode 100644 index 000000000000..a7be27d3d16f --- /dev/null +++ b/content/en/docs/collector/Install/binary/windows.md @@ -0,0 +1,30 @@ +--- +title: Install the Collector on Windows +aliases: [/docs/collector/installation/#windows] +--- + +## Windows + +Windows [releases][] are available as MSI installers and gzipped tarballs +(`.tar.gz`). The MSI installs the Collector as a Windows service named after the +distribution, with the display name "OpenTelemetry Collector", and registers an +Application Event Log source with the distribution name. + +### MSI installation + +```powershell +msiexec /i "https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_windows_x64.msi" +``` + +### Manual installation + +```powershell +Invoke-WebRequest -Uri "https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_windows_amd64.tar.gz" -OutFile "otelcol_{{% param vers %}}_windows_amd64.tar.gz" +tar -xvzf otelcol_{{% param vers %}}_windows_amd64.tar.gz +``` + +Every release includes the Collector executable that you can run after +installation. + +[releases]: + https://github.com/open-telemetry/opentelemetry-collector-releases/releases diff --git a/content/en/docs/collector/Install/docker.md b/content/en/docs/collector/Install/docker.md new file mode 100644 index 000000000000..2b52edebba38 --- /dev/null +++ b/content/en/docs/collector/Install/docker.md @@ -0,0 +1,62 @@ +--- +title: Install the Collector with Docker +aliases: [../install/#docker] +--- + +## Docker + +The following commands pull a Docker image and run the Collector in a container. +Replace `{{% param vers %}}` with the version of the Collector you want to run. + +{{< tabpane text=true >}} {{% tab DockerHub %}} + +```sh +docker pull otel/opentelemetry-collector-contrib:{{% param vers %}} +docker run otel/opentelemetry-collector-contrib:{{% param vers %}} +``` + +{{% /tab %}} {{% tab ghcr.io %}} + +```sh +docker pull ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:{{% param vers %}} +docker run ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:{{% param vers %}} +``` + +{{% /tab %}} {{< /tabpane >}} + +To load a custom configuration file from your working directory, mount that file +as a volume: + +{{< tabpane text=true >}} {{% tab DockerHub %}} + +```sh +docker run -v $(pwd)/config.yaml:/etc/otelcol-contrib/config.yaml otel/opentelemetry-collector-contrib:{{% param vers %}} +``` + +{{% /tab %}} {{% tab ghcr.io %}} + +```sh +docker run -v $(pwd)/config.yaml:/etc/otelcol-contrib/config.yaml ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:{{% param vers %}} +``` + +{{% /tab %}} {{< /tabpane >}} + +## Docker Compose + +You can add OpenTelemetry Collector to your existing `docker-compose.yaml` file +as in the following example: + +```yaml +otel-collector: + image: otel/opentelemetry-collector-contrib + volumes: + - ./otel-collector-config.yaml:/etc/otelcol-contrib/config.yaml + ports: + - 1888:1888 # pprof extension + - 8888:8888 # Prometheus metrics exposed by the Collector + - 8889:8889 # Prometheus exporter metrics + - 13133:13133 # health_check extension + - 4317:4317 # OTLP gRPC receiver + - 4318:4318 # OTLP http receiver + - 55679:55679 # zpages extension +``` diff --git a/content/en/docs/collector/Install/kubernetes.md b/content/en/docs/collector/Install/kubernetes.md new file mode 100644 index 000000000000..8d7f8b199144 --- /dev/null +++ b/content/en/docs/collector/Install/kubernetes.md @@ -0,0 +1,28 @@ +--- +title: Install the Collector with Kubernetes +aliases: [/docs/collector/install/#kubernetes] +--- + +## Kubernetes + +The following command deploys an agent as a daemonset and a single gateway +instance: + +```sh +kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector/v{{% param vers %}}/examples/k8s/otel-config.yaml +``` + +The previous example is meant to serve as a starting point, to be extended and +customized before actual production usage. For production-ready customization +and installation, see [OpenTelemetry Helm Charts][]. + +You can also use the [OpenTelemetry Operator][] to provision and maintain an +OpenTelemetry Collector instance, with features such as automatic upgrade +handling, `Service` configuration based on the OpenTelemetry configuration, +automatic sidecar injection into deployments, and more. + +For guidance on how to use the Collector with Kubernetes, see +[Kubernetes Getting Started](/docs/platforms/kubernetes/getting-started/). + +[opentelemetry helm charts]: /docs/platforms/kubernetes/helm/ +[opentelemetry operator]: /docs/platforms/kubernetes/operator/ diff --git a/content/en/docs/collector/installation.md b/content/en/docs/collector/installation.md deleted file mode 100644 index 267f21fb3a88..000000000000 --- a/content/en/docs/collector/installation.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -title: Install the Collector -weight: 2 -cSpell:ignore: darwin dpkg journalctl kubectl otelcorecol pprof tlsv zpages ---- - -You can deploy the OpenTelemetry Collector on a wide variety of operating -systems and architectures. The following instructions show how to download and -install the latest stable version of the Collector. - -If you aren't familiar with the deployment models, components, and repositories -applicable to the OpenTelemetry Collector, first review the [Data Collection][] -and [Deployment Methods][] page. - -## Docker - -The following commands pull a Docker image and run the Collector in a container. -Replace `{{% param vers %}}` with the version of the Collector you want to run. - -{{< tabpane text=true >}} {{% tab DockerHub %}} - -```sh -docker pull otel/opentelemetry-collector-contrib:{{% param vers %}} -docker run otel/opentelemetry-collector-contrib:{{% param vers %}} -``` - -{{% /tab %}} {{% tab ghcr.io %}} - -```sh -docker pull ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:{{% param vers %}} -docker run ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:{{% param vers %}} -``` - -{{% /tab %}} {{< /tabpane >}} - -To load a custom configuration file from your working directory, mount that file -as a volume: - -{{< tabpane text=true >}} {{% tab DockerHub %}} - -```sh -docker run -v $(pwd)/config.yaml:/etc/otelcol-contrib/config.yaml otel/opentelemetry-collector-contrib:{{% param vers %}} -``` - -{{% /tab %}} {{% tab ghcr.io %}} - -```sh -docker run -v $(pwd)/config.yaml:/etc/otelcol-contrib/config.yaml ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:{{% param vers %}} -``` - -{{% /tab %}} {{< /tabpane >}} - -## Docker Compose - -You can add OpenTelemetry Collector to your existing `docker-compose.yaml` file -as in the following example: - -```yaml -otel-collector: - image: otel/opentelemetry-collector-contrib - volumes: - - ./otel-collector-config.yaml:/etc/otelcol-contrib/config.yaml - ports: - - 1888:1888 # pprof extension - - 8888:8888 # Prometheus metrics exposed by the Collector - - 8889:8889 # Prometheus exporter metrics - - 13133:13133 # health_check extension - - 4317:4317 # OTLP gRPC receiver - - 4318:4318 # OTLP http receiver - - 55679:55679 # zpages extension -``` - -## Kubernetes - -The following command deploys an agent as a daemonset and a single gateway -instance: - -```sh -kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector/v{{% param vers %}}/examples/k8s/otel-config.yaml -``` - -The previous example is meant to serve as a starting point, to be extended and -customized before actual production usage. For production-ready customization -and installation, see [OpenTelemetry Helm Charts][]. - -You can also use the [OpenTelemetry Operator][] to provision and maintain an -OpenTelemetry Collector instance, with features such as automatic upgrade -handling, `Service` configuration based on the OpenTelemetry configuration, -automatic sidecar injection into deployments, and more. - -For guidance on how to use the Collector with Kubernetes, see -[Kubernetes Getting Started](/docs/platforms/kubernetes/getting-started/). - -## Nomad - -You can find reference job files to deploy the Collector as an agent, gateway, -and as full demo in [Getting Started with OpenTelemetry on HashiCorp Nomad][]. - -## Linux - -Every Collector release includes APK, DEB and RPM packaging for Linux -amd64/arm64/i386 systems. You can find the default configuration in -`/etc/otelcol/config.yaml` after installation. - -> Note: `systemd` is required for automatic service configuration. - -### DEB Installation - -To get started on Debian systems run the following commands: - -{{< tabpane text=true >}} {{% tab AMD64 %}} - -```sh -sudo apt-get update -sudo apt-get -y install wget -wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_amd64.deb -sudo dpkg -i otelcol_{{% param vers %}}_linux_amd64.deb -``` - -{{% /tab %}} {{% tab ARM64 %}} - -```sh -sudo apt-get update -sudo apt-get -y install wget -wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_arm64.deb -sudo dpkg -i otelcol_{{% param vers %}}_linux_arm64.deb -``` - -{{% /tab %}} {{% tab i386 %}} - -```sh -sudo apt-get update -sudo apt-get -y install wget -wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_386.deb -sudo dpkg -i otelcol_{{% param vers %}}_linux_386.deb -``` - -{{% /tab %}} {{< /tabpane >}} - -### RPM Installation - -To get started on Red Hat systems run the following commands: - -{{< tabpane text=true >}} {{% tab AMD64 %}} - -```sh -sudo yum update -sudo yum -y install wget systemctl -wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_amd64.rpm -sudo rpm -ivh otelcol_{{% param vers %}}_linux_amd64.rpm -``` - -{{% /tab %}} {{% tab ARM64 %}} - -```sh -sudo yum update -sudo yum -y install wget systemctl -wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_arm64.rpm -sudo rpm -ivh otelcol_{{% param vers %}}_linux_arm64.rpm -``` - -{{% /tab %}} {{% tab i386 %}} - -```sh -sudo yum update -sudo yum -y install wget systemctl -wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_386.rpm -sudo rpm -ivh otelcol_{{% param vers %}}_linux_386.rpm -``` - -{{% /tab %}} {{< /tabpane >}} - -### Manual Linux installation - -Linux [releases][] are available for various architectures. You can download the -file containing the binary and install it on your machine manually: - -{{< tabpane text=true >}} {{% tab AMD64 %}} - -```sh -curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_amd64.tar.gz -tar -xvf otelcol_{{% param vers %}}_linux_amd64.tar.gz -``` - -{{% /tab %}} {{% tab ARM64 %}} - -```sh -curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_arm64.tar.gz -tar -xvf otelcol_{{% param vers %}}_linux_arm64.tar.gz -``` - -{{% /tab %}} {{% tab i386 %}} - -```sh -curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_386.tar.gz -tar -xvf otelcol_{{% param vers %}}_linux_386.tar.gz -``` - -{{% /tab %}} {{% tab ppc64le %}} - -```sh -curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_linux_ppc64le.tar.gz -tar -xvf otelcol_{{% param vers %}}_linux_ppc64le.tar.gz -``` - -{{% /tab %}} {{< /tabpane >}} - -### Automatic service configuration - -By default, the `otelcol` systemd service starts with the -`--config=/etc/otelcol/config.yaml` option after installation. - -To use a different settings, set the `OTELCOL_OPTIONS` variable in the -`/etc/otelcol/otelcol.conf` systemd environment file to the appropriate -command-line options. You can run `/usr/bin/otelcol --help` to see all available -options. You can pass additional environment variables to the `otelcol` service -by adding them to this file. - -If you modify the Collector configuration file or `/etc/otelcol/otelcol.conf`, -restart the `otelcol` service to apply the changes by running: - -```sh -sudo systemctl restart otelcol -``` - -To check the output from the `otelcol` service, run: - -```sh -sudo journalctl -u otelcol -``` - -## macOS - -macOS [releases][] are available for Intel and ARM systems. The releases are -packaged as gzipped tarballs (`.tar.gz`). To unpack them, run the following -commands: - -{{< tabpane text=true >}} {{% tab Intel %}} - -```sh -curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_darwin_amd64.tar.gz -tar -xvf otelcol_{{% param vers %}}_darwin_amd64.tar.gz -``` - -{{% /tab %}} {{% tab ARM %}} - -```sh -curl --proto '=https' --tlsv1.2 -fOL https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_darwin_arm64.tar.gz -tar -xvf otelcol_{{% param vers %}}_darwin_arm64.tar.gz -``` - -{{% /tab %}} {{< /tabpane >}} - -Every Collector release includes an `otelcol` executable that you can run after -unpacking. - -## Windows - -Windows [releases][] are available as MSI installers and gzipped tarballs -(`.tar.gz`). The MSI installs the Collector as a Windows service named after the -distribution, with the display name "OpenTelemetry Collector", and registers an -Application Event Log source with the distribution name. - -### MSI installation - -```powershell -msiexec /i "https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_windows_x64.msi" -``` - -### Manual installation - -```powershell -Invoke-WebRequest -Uri "https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v{{% param vers %}}/otelcol_{{% param vers %}}_windows_amd64.tar.gz" -OutFile "otelcol_{{% param vers %}}_windows_amd64.tar.gz" -tar -xvzf otelcol_{{% param vers %}}_windows_amd64.tar.gz -``` - -Every release includes the Collector executable that you can run after -installation. - -## Build from source - -You can build the latest version of the Collector based on the local operating -system using the following commands: - -```sh -git clone https://github.com/open-telemetry/opentelemetry-collector.git -cd opentelemetry-collector -make install-tools -make otelcorecol -``` - -[data collection]: /docs/concepts/components/#collector -[deployment methods]: ../deployment/ -[opentelemetry helm charts]: /docs/platforms/kubernetes/helm/ -[opentelemetry operator]: /docs/platforms/kubernetes/operator/ -[getting started with opentelemetry on hashicorp nomad]: - https://github.com/hashicorp/nomad-open-telemetry-getting-started -[releases]: - https://github.com/open-telemetry/opentelemetry-collector-releases/releases diff --git a/content/en/docs/collector/quick-start.md b/content/en/docs/collector/quick-start.md index 149194689c13..83260267ad1f 100644 --- a/content/en/docs/collector/quick-start.md +++ b/content/en/docs/collector/quick-start.md @@ -128,7 +128,7 @@ preferred shell. In this tutorial you've started the OpenTelemetry Collector and sent telemetry to it. As next steps, consider doing the following: -- Explore different ways to [install the Collector](../installation/). +- Explore different ways to [install the Collector](../install/). - Learn about the different modes of the Collector in [Deployment Methods](../deployment/). - Familiarize yourself with the Collector From 0068fe7c1fa5587a74f505aedf358ae2fe9a75a2 Mon Sep 17 00:00:00 2001 From: adity1raut Date: Sun, 9 Nov 2025 16:49:19 +0530 Subject: [PATCH 2/9] Solve Signed-off-by: adity1raut --- content/en/docs/collector/Install/_index.md | 2 +- content/en/docs/collector/Install/binary/linux.md | 2 +- content/en/docs/collector/Install/binary/macos.md | 2 +- content/en/docs/collector/Install/binary/windows.md | 2 +- content/en/docs/collector/Install/docker.md | 2 +- content/en/docs/collector/Install/kubernetes.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/en/docs/collector/Install/_index.md b/content/en/docs/collector/Install/_index.md index 169f8e2cd0e0..52219c3cc61f 100644 --- a/content/en/docs/collector/Install/_index.md +++ b/content/en/docs/collector/Install/_index.md @@ -1,6 +1,6 @@ --- title: Install the Collector -aliases: [../install/] +aliases: [../installation/] weight: 2 --- diff --git a/content/en/docs/collector/Install/binary/linux.md b/content/en/docs/collector/Install/binary/linux.md index b27b80abaab3..b8adb6c762b0 100644 --- a/content/en/docs/collector/Install/binary/linux.md +++ b/content/en/docs/collector/Install/binary/linux.md @@ -1,6 +1,6 @@ --- title: Install the Collector on Linux -aliases: [/docs/collector/install/#linux] +aliases: [../installation/#linux] --- ## Linux diff --git a/content/en/docs/collector/Install/binary/macos.md b/content/en/docs/collector/Install/binary/macos.md index 7e783515c32d..d93fc0ace4f5 100644 --- a/content/en/docs/collector/Install/binary/macos.md +++ b/content/en/docs/collector/Install/binary/macos.md @@ -1,6 +1,6 @@ --- title: Install the Collector on macOS -aliases: [/docs/collector/installation/#macos] +aliases: [../installation/#macos] --- ## macOS diff --git a/content/en/docs/collector/Install/binary/windows.md b/content/en/docs/collector/Install/binary/windows.md index a7be27d3d16f..4c150ba2d1ad 100644 --- a/content/en/docs/collector/Install/binary/windows.md +++ b/content/en/docs/collector/Install/binary/windows.md @@ -1,6 +1,6 @@ --- title: Install the Collector on Windows -aliases: [/docs/collector/installation/#windows] +aliases: [../installation/#windows] --- ## Windows diff --git a/content/en/docs/collector/Install/docker.md b/content/en/docs/collector/Install/docker.md index 2b52edebba38..9a69c879c8f8 100644 --- a/content/en/docs/collector/Install/docker.md +++ b/content/en/docs/collector/Install/docker.md @@ -1,6 +1,6 @@ --- title: Install the Collector with Docker -aliases: [../install/#docker] +aliases: [../installation/#docker] --- ## Docker diff --git a/content/en/docs/collector/Install/kubernetes.md b/content/en/docs/collector/Install/kubernetes.md index 8d7f8b199144..c1ca2c0a280d 100644 --- a/content/en/docs/collector/Install/kubernetes.md +++ b/content/en/docs/collector/Install/kubernetes.md @@ -1,6 +1,6 @@ --- title: Install the Collector with Kubernetes -aliases: [/docs/collector/install/#kubernetes] +aliases: [../installation/#kubernetes] --- ## Kubernetes From d9d0fc7d499f68927f7dab62865a75504e9df3d9 Mon Sep 17 00:00:00 2001 From: adity1raut Date: Thu, 13 Nov 2025 11:38:43 +0530 Subject: [PATCH 3/9] pdate After REview Signed-off-by: adity1raut --- content/en/docs/collector/{Install => install}/_index.md | 3 +-- content/en/docs/collector/install/binary/_index.md | 9 +++++++++ .../docs/collector/{Install => install}/binary/linux.md | 4 +++- .../docs/collector/{Install => install}/binary/macos.md | 3 ++- .../collector/{Install => install}/binary/windows.md | 3 ++- content/en/docs/collector/{Install => install}/docker.md | 3 ++- .../en/docs/collector/{Install => install}/kubernetes.md | 1 + 7 files changed, 20 insertions(+), 6 deletions(-) rename content/en/docs/collector/{Install => install}/_index.md (95%) create mode 100644 content/en/docs/collector/install/binary/_index.md rename content/en/docs/collector/{Install => install}/binary/linux.md (98%) rename content/en/docs/collector/{Install => install}/binary/macos.md (95%) rename content/en/docs/collector/{Install => install}/binary/windows.md (95%) rename content/en/docs/collector/{Install => install}/docker.md (96%) rename content/en/docs/collector/{Install => install}/kubernetes.md (98%) diff --git a/content/en/docs/collector/Install/_index.md b/content/en/docs/collector/install/_index.md similarity index 95% rename from content/en/docs/collector/Install/_index.md rename to content/en/docs/collector/install/_index.md index 52219c3cc61f..8eef76f9f2f3 100644 --- a/content/en/docs/collector/Install/_index.md +++ b/content/en/docs/collector/install/_index.md @@ -1,7 +1,6 @@ --- title: Install the Collector -aliases: [../installation/] -weight: 2 +aliases: [/docs/collector/installation/.] --- You can deploy the OpenTelemetry Collector on a wide variety of operating diff --git a/content/en/docs/collector/install/binary/_index.md b/content/en/docs/collector/install/binary/_index.md new file mode 100644 index 000000000000..f01b59f3c58a --- /dev/null +++ b/content/en/docs/collector/install/binary/_index.md @@ -0,0 +1,9 @@ +--- +title: Install from a Collector binary +aliases: [../installation/binary] +weight: 200 +--- + + +You can install the OpenTelemetry Collector by downloading and running a prebuilt binary. Choose your operating system below for installation steps. + diff --git a/content/en/docs/collector/Install/binary/linux.md b/content/en/docs/collector/install/binary/linux.md similarity index 98% rename from content/en/docs/collector/Install/binary/linux.md rename to content/en/docs/collector/install/binary/linux.md index b8adb6c762b0..2e5dd0f36433 100644 --- a/content/en/docs/collector/Install/binary/linux.md +++ b/content/en/docs/collector/install/binary/linux.md @@ -1,8 +1,10 @@ --- title: Install the Collector on Linux -aliases: [../installation/#linux] +aliases: [../installation/binary/#linux] +weight: 200 --- + ## Linux Every Collector release includes APK, DEB and RPM packaging for Linux diff --git a/content/en/docs/collector/Install/binary/macos.md b/content/en/docs/collector/install/binary/macos.md similarity index 95% rename from content/en/docs/collector/Install/binary/macos.md rename to content/en/docs/collector/install/binary/macos.md index d93fc0ace4f5..b8ec744cd2b2 100644 --- a/content/en/docs/collector/Install/binary/macos.md +++ b/content/en/docs/collector/install/binary/macos.md @@ -1,6 +1,7 @@ --- title: Install the Collector on macOS -aliases: [../installation/#macos] +aliases: [../installation/binary/#macos] +weight: 200 --- ## macOS diff --git a/content/en/docs/collector/Install/binary/windows.md b/content/en/docs/collector/install/binary/windows.md similarity index 95% rename from content/en/docs/collector/Install/binary/windows.md rename to content/en/docs/collector/install/binary/windows.md index 4c150ba2d1ad..421f862d3b60 100644 --- a/content/en/docs/collector/Install/binary/windows.md +++ b/content/en/docs/collector/install/binary/windows.md @@ -1,6 +1,7 @@ --- title: Install the Collector on Windows -aliases: [../installation/#windows] +aliases: [../installation/binary/#windows] +weight: 200 --- ## Windows diff --git a/content/en/docs/collector/Install/docker.md b/content/en/docs/collector/install/docker.md similarity index 96% rename from content/en/docs/collector/Install/docker.md rename to content/en/docs/collector/install/docker.md index 9a69c879c8f8..81575431a815 100644 --- a/content/en/docs/collector/Install/docker.md +++ b/content/en/docs/collector/install/docker.md @@ -1,6 +1,7 @@ --- title: Install the Collector with Docker -aliases: [../installation/#docker] +aliases: [/docs/collector/installation/#docker] +weight: 200 --- ## Docker diff --git a/content/en/docs/collector/Install/kubernetes.md b/content/en/docs/collector/install/kubernetes.md similarity index 98% rename from content/en/docs/collector/Install/kubernetes.md rename to content/en/docs/collector/install/kubernetes.md index c1ca2c0a280d..8d13c05bba87 100644 --- a/content/en/docs/collector/Install/kubernetes.md +++ b/content/en/docs/collector/install/kubernetes.md @@ -1,6 +1,7 @@ --- title: Install the Collector with Kubernetes aliases: [../installation/#kubernetes] +weight: 200 --- ## Kubernetes From 8f9f006623107133be2d530eaa35d0e08f3c3479 Mon Sep 17 00:00:00 2001 From: adity1raut Date: Thu, 13 Nov 2025 22:27:07 +0530 Subject: [PATCH 4/9] Solve The Confige: Signed-off-by: adity1raut --- content/en/docs/collector/install/binary/_index.md | 5 ++--- content/en/docs/collector/install/binary/linux.md | 1 - 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/content/en/docs/collector/install/binary/_index.md b/content/en/docs/collector/install/binary/_index.md index f01b59f3c58a..0d0c47a8b46b 100644 --- a/content/en/docs/collector/install/binary/_index.md +++ b/content/en/docs/collector/install/binary/_index.md @@ -4,6 +4,5 @@ aliases: [../installation/binary] weight: 200 --- - -You can install the OpenTelemetry Collector by downloading and running a prebuilt binary. Choose your operating system below for installation steps. - +You can install the OpenTelemetry Collector by downloading and running a +prebuilt binary. Choose your operating system below for installation steps. diff --git a/content/en/docs/collector/install/binary/linux.md b/content/en/docs/collector/install/binary/linux.md index 2e5dd0f36433..03228c9f83c7 100644 --- a/content/en/docs/collector/install/binary/linux.md +++ b/content/en/docs/collector/install/binary/linux.md @@ -4,7 +4,6 @@ aliases: [../installation/binary/#linux] weight: 200 --- - ## Linux Every Collector release includes APK, DEB and RPM packaging for Linux From e6dff0cfff328ac7c77f31ec70f0281f2a5e5fb4 Mon Sep 17 00:00:00 2001 From: adity1raut Date: Sat, 22 Nov 2025 13:58:32 +0530 Subject: [PATCH 5/9] Update Ater Review Signed-off-by: adity1raut --- content/en/docs/collector/install/binary/_index.md | 3 +-- content/en/docs/collector/install/binary/linux.md | 3 +-- content/en/docs/collector/install/binary/macos.md | 2 +- content/en/docs/collector/install/binary/windows.md | 4 ++-- content/en/docs/collector/install/docker.md | 2 +- content/en/docs/collector/install/kubernetes.md | 4 ++-- 6 files changed, 8 insertions(+), 10 deletions(-) diff --git a/content/en/docs/collector/install/binary/_index.md b/content/en/docs/collector/install/binary/_index.md index 0d0c47a8b46b..875ee4f52887 100644 --- a/content/en/docs/collector/install/binary/_index.md +++ b/content/en/docs/collector/install/binary/_index.md @@ -1,7 +1,6 @@ --- title: Install from a Collector binary -aliases: [../installation/binary] -weight: 200 +weight: 300 --- You can install the OpenTelemetry Collector by downloading and running a diff --git a/content/en/docs/collector/install/binary/linux.md b/content/en/docs/collector/install/binary/linux.md index 03228c9f83c7..2e1d9cdebbfc 100644 --- a/content/en/docs/collector/install/binary/linux.md +++ b/content/en/docs/collector/install/binary/linux.md @@ -1,7 +1,6 @@ --- title: Install the Collector on Linux -aliases: [../installation/binary/#linux] -weight: 200 +weight: 100 --- ## Linux diff --git a/content/en/docs/collector/install/binary/macos.md b/content/en/docs/collector/install/binary/macos.md index b8ec744cd2b2..d86be9b2433a 100644 --- a/content/en/docs/collector/install/binary/macos.md +++ b/content/en/docs/collector/install/binary/macos.md @@ -1,6 +1,6 @@ --- title: Install the Collector on macOS -aliases: [../installation/binary/#macos] +linkTitle: macOS weight: 200 --- diff --git a/content/en/docs/collector/install/binary/windows.md b/content/en/docs/collector/install/binary/windows.md index 421f862d3b60..d9910f649a1b 100644 --- a/content/en/docs/collector/install/binary/windows.md +++ b/content/en/docs/collector/install/binary/windows.md @@ -1,7 +1,7 @@ --- title: Install the Collector on Windows -aliases: [../installation/binary/#windows] -weight: 200 +linkTitle: Windows +weight: 300 --- ## Windows diff --git a/content/en/docs/collector/install/docker.md b/content/en/docs/collector/install/docker.md index 81575431a815..63466fcfb205 100644 --- a/content/en/docs/collector/install/docker.md +++ b/content/en/docs/collector/install/docker.md @@ -1,6 +1,6 @@ --- title: Install the Collector with Docker -aliases: [/docs/collector/installation/#docker] +linkTitle: Docker weight: 200 --- diff --git a/content/en/docs/collector/install/kubernetes.md b/content/en/docs/collector/install/kubernetes.md index 8d13c05bba87..77fa2497fd23 100644 --- a/content/en/docs/collector/install/kubernetes.md +++ b/content/en/docs/collector/install/kubernetes.md @@ -1,7 +1,7 @@ --- title: Install the Collector with Kubernetes -aliases: [../installation/#kubernetes] -weight: 200 +linkTitle: Kubernetes +weight: 300 --- ## Kubernetes From 7d5a702b5066e2184d9d7c01e21db35919d3eabf Mon Sep 17 00:00:00 2001 From: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com> Date: Tue, 25 Nov 2025 17:44:54 -0800 Subject: [PATCH 6/9] Apply suggestions from code review Co-authored-by: Patrice Chalin --- content/en/docs/collector/install/_index.md | 4 +++- content/en/docs/collector/install/docker.md | 2 +- content/en/docs/collector/install/kubernetes.md | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/content/en/docs/collector/install/_index.md b/content/en/docs/collector/install/_index.md index 8eef76f9f2f3..7e1ce2faed9a 100644 --- a/content/en/docs/collector/install/_index.md +++ b/content/en/docs/collector/install/_index.md @@ -1,6 +1,8 @@ --- title: Install the Collector -aliases: [/docs/collector/installation/.] +linkTitle: Install +aliases: [./installation] +weight: 2 --- You can deploy the OpenTelemetry Collector on a wide variety of operating diff --git a/content/en/docs/collector/install/docker.md b/content/en/docs/collector/install/docker.md index 63466fcfb205..813a11101aa3 100644 --- a/content/en/docs/collector/install/docker.md +++ b/content/en/docs/collector/install/docker.md @@ -1,7 +1,7 @@ --- title: Install the Collector with Docker linkTitle: Docker -weight: 200 +weight: 100 --- ## Docker diff --git a/content/en/docs/collector/install/kubernetes.md b/content/en/docs/collector/install/kubernetes.md index 77fa2497fd23..df108fb19569 100644 --- a/content/en/docs/collector/install/kubernetes.md +++ b/content/en/docs/collector/install/kubernetes.md @@ -1,7 +1,7 @@ --- title: Install the Collector with Kubernetes linkTitle: Kubernetes -weight: 300 +weight: 200 --- ## Kubernetes From 9983fd7219801550452d6d219d2fee9ea7946366 Mon Sep 17 00:00:00 2001 From: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com> Date: Tue, 25 Nov 2025 17:49:51 -0800 Subject: [PATCH 7/9] Apply suggestions from code review --- content/en/docs/collector/install/binary/_index.md | 1 + content/en/docs/collector/install/binary/linux.md | 1 + 2 files changed, 2 insertions(+) diff --git a/content/en/docs/collector/install/binary/_index.md b/content/en/docs/collector/install/binary/_index.md index 875ee4f52887..762bbe8f6a6c 100644 --- a/content/en/docs/collector/install/binary/_index.md +++ b/content/en/docs/collector/install/binary/_index.md @@ -1,5 +1,6 @@ --- title: Install from a Collector binary +linkTitle: Binary weight: 300 --- diff --git a/content/en/docs/collector/install/binary/linux.md b/content/en/docs/collector/install/binary/linux.md index 2e1d9cdebbfc..00d662e88595 100644 --- a/content/en/docs/collector/install/binary/linux.md +++ b/content/en/docs/collector/install/binary/linux.md @@ -1,5 +1,6 @@ --- title: Install the Collector on Linux +linkTitle: Linux weight: 100 --- From c9c63976c4173c60ee69c235e0dd60c66a7e0c54 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 26 Nov 2025 11:35:25 -0500 Subject: [PATCH 8/9] Update content/en/docs/collector/install/_index.md --- content/en/docs/collector/install/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/collector/install/_index.md b/content/en/docs/collector/install/_index.md index 7e1ce2faed9a..6814405d0a30 100644 --- a/content/en/docs/collector/install/_index.md +++ b/content/en/docs/collector/install/_index.md @@ -1,7 +1,7 @@ --- title: Install the Collector linkTitle: Install -aliases: [./installation] +aliases: [installation] weight: 2 --- From 233bb3facdfb589df09055be3180e22a890c9dc0 Mon Sep 17 00:00:00 2001 From: Tiffany Hrabusa Date: Wed, 3 Dec 2025 10:50:24 -0800 Subject: [PATCH 9/9] Update 2024 blog Signed-off-by: Tiffany Hrabusa --- content/en/blog/2024/llm-observability.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/blog/2024/llm-observability.md b/content/en/blog/2024/llm-observability.md index 31bbad554c88..15c7eaa78a76 100644 --- a/content/en/blog/2024/llm-observability.md +++ b/content/en/blog/2024/llm-observability.md @@ -116,7 +116,7 @@ Before we begin, make sure you have the following running in your environment: ### Setting Up the OpenTelemetry Collector -First, [install the OpenTelemetry Collector](/docs/collector/installation/). +First, [install the OpenTelemetry Collector](/docs/collector/install/). ### Configuring the Collector