Skip to content

Commit

Permalink
Improve documentation (#2109)
Browse files Browse the repository at this point in the history
  • Loading branch information
tamirdavid1 authored Jan 1, 2025
1 parent 6c6bcc3 commit 484a90f
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions docs/architecture/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@ Odigos is divided into three main segments:
- Start and stop collectors when needed (e.g. when sources or destinations are added or removed).
- Schedule the node collector to start after the cluster collector is ready.
- Generate the configuration for the collectors based on the Odigos sources, destinations, and action.
- Restart the collectors when the configuration changes.
- Auto scale the collectors based on the load.

### Cluster Collector

Expand All @@ -78,13 +76,15 @@ Odigos is divided into three main segments:

**K8s Resource**: DaemonSet / `odigos-data-collection`

**Role**: The node collector implements any node-level tasks that are needed to collect telemetry data.
**Role**: The Node Collector (in the context of Pipeline component) receives telemetry data from agents running on the node and enriches it with node-level attributes.

- Receives the telemetry data collected from agents running on the node.
- Add node-level attributes to the telemetry data (`k8s.node.name`)
- Batches and sends the telemetry data to the cluster collector, offloading any network overhead from the instrumented application runtime.

The Node Collector is also responsible for recording some k8s metrics, and collecting the generated logs from the node fs. Read more Under the [Instrumentation](#instrumentation) section.
<Info>
The Node Collector is also responsible for recording some k8s metrics, and collecting the generated logs from the node fs. Read more Under the [Instrumentation](#node-collector-2) section.
</Info>

## Instrumentation

Expand Down Expand Up @@ -118,10 +118,6 @@ The Node Collector is also responsible for recording some k8s metrics, and colle

### Node Collector

**Type**: The node collector is a daemon set and will run one pod per node in the cluster

**K8s Resource**: DaemonSet / `odigos-data-collection`

**Role**: The node collector (in the context of instrumentation) is responsible for collecting k8s metrics, and logs from the node filesystem.

- When a destination for logs exists, the node collector will use the ["filelog receiver"](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) to read the relevant container logs from the node filesystem and export them as otel logs to the cluster collector.
Expand Down

0 comments on commit 484a90f

Please sign in to comment.