open-telemetry
/
opentelemetry-collector
mirror of https://github.com/open-telemetry/opentelemetry-collector.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync docs changes between website and repo

This commit is contained in:
Austin Parker 2021-06-02 10:50:09 -04:00 committed by GitHub
parent 017aa1dad7
commit 5b73ece6d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 30 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
website_docs/_index.md
View File

@ -3,23 +3,23 @@ title: "Collector"
linkTitle: "Collector"
weight: 10
description: >
<img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Collector.svg"></img>
<img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Collector.svg" alt="Collector logo"></img>
Vendor-agnostic way to receive, process and export telemetry data
---
<img src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/Otel_Collector.svg"></img>
<img src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/Otel_Collector.svg" alt="Otel-Collector diagram with Jaeger, OTLP and Prometheus integration"></img>
The OpenTelemetry Collector offers a vendor-agnostic implementation on how to
receive, process and export telemetry data. It removes the need to run,
operate, and maintain multiple agents/collectors in order to support
operate, and maintain multiple agents/collectors. This works with improved scalability and supports
open-source observability data formats (e.g. Jaeger, Prometheus, Fluent Bit,
etc.) sending to one or more open-source or commercial back-ends. The Collector
is the default location instrumentation libraries export their telemetry data.
Objectives:
- Usable: Reasonable default configuration, supports popular protocols, runs and collects out of the box.
- Performant: Highly stable and performant under varying loads and configurations.
- Observable: An exemplar of an observable service.
- Extensible: Customizable without touching the core code.
- Unified: Single codebase, deployable as an agent or collector with support for traces, metrics, and logs (future).
- *Usability*: Reasonable default configuration, supports popular protocols, runs and collects out of the box.
- *Performance*: Highly stable and performant under varying loads and configurations.
- *Observability*: An exemplar of an observable service.
- *Extensibility*: Customizable without touching the core code.
- *Unification*: Single codebase, deployable as an agent or collector with support for traces, metrics, and logs (future).

22
website_docs/getting-started.md
View File

@ -130,6 +130,28 @@ $ wget https://github.com/open-telemetry/opentelemetry-collector/releases/downlo
$ rpm -ivh otel-collector_0.20.0-1_x86_64.rpm
```
By default, the `otel-collector` systemd service will be started with the
`--config=/etc/otel-collector/config.yaml` option after installation. To
customize these options, modify the `OTELCOL_OPTIONS` variable in the
`/etc/otel-collector/otel-collector.conf` systemd environment file with the
appropriate command-line options (run `/usr/bin/otelcol --help` to see all
available options). Additional environment variables can also be passed to the
`otel-collector` service by adding them to this file.
If either the Collector configuration file or
`/etc/otel-collector/otel-collector.conf` are modified, restart the
`otel-collector` service to apply the changes by running:
```bash
$ sudo systemctl restart otel-collector
```
To check the output from the `otel-collector` service, run:
```bash
$ sudo journalctl -u otel-collector
```
### Windows Packaging
Every Collector release includes EXE and MSI packaging for Linux amd64 systems.