Skip to content

COMPONENTS.md

Latest commit

 

History

History
167 lines (122 loc) · 14.9 KB

COMPONENTS.md

File metadata and controls

167 lines (122 loc) · 14.9 KB

Supported OpenTelemetry Components

This document lists all the OpenTelemetry Collector components that are currently supported by the KloudMate Agent.

Table of Contents

Extensions

Extensions provide capabilities that can be added to the collector, but which do not require direct access to telemetry data.

Extension Description Use Case Documentation
Memory Limiter Monitors and controls memory usage Prevents out-of-memory errors by applying backpressure when memory limits are reached Docs
Z-Pages Provides in-process web pages for diagnostics Offers debugging endpoints for live troubleshooting and performance analysis Docs
File Storage Provides persistent storage capabilities Used by receivers/processors that need to maintain state across restarts Docs
Health Check Exposes health check endpoints Enables Kubernetes liveness and readiness probes for the collector Docs

Receivers

Receivers are responsible for getting data into the collector. A receiver can be push or pull-based.

Infrastructure & Host Monitoring

Receiver Description Metrics Collected Documentation
OTLP Receives data via OTLP protocol Metrics, traces, and logs from OTLP-compatible sources Docs
Host Metrics Collects host-level metrics CPU, memory, disk, network, filesystem metrics Docs
Docker Stats Collects Docker container metrics Container CPU, memory, network, and block I/O statistics Docs
Kubelet Stats Collects metrics from Kubernetes Kubelet Pod and container resource usage metrics Docs

Kubernetes Monitoring

Receiver Description Metrics Collected Documentation
K8s Cluster Collects Kubernetes cluster-level metrics Node, pod, deployment, and service metrics Docs
K8s Objects Watches Kubernetes objects and converts them to logs Events, pod status changes, deployment updates Docs
K8s Events Collects Kubernetes events Cluster events as log entries Docs

Database Receivers

Receiver Description Database Type Documentation
MySQL Collects metrics from MySQL databases MySQL 5.7+ Docs
PostgreSQL Collects metrics from PostgreSQL databases PostgreSQL 9.6+ Docs
MongoDB Collects metrics from MongoDB instances MongoDB 4.0+ Docs
MongoDB Atlas Collects metrics from MongoDB Atlas MongoDB Atlas cloud service Docs
Redis Collects metrics from Redis instances Redis 5.0+ Docs
Oracle DB Collects metrics from Oracle databases Oracle Database Docs
SQL Server Collects metrics from Microsoft SQL Server SQL Server 2012+ Docs
SAP HANA Collects metrics from SAP HANA databases SAP HANA Docs
Elasticsearch Collects metrics from Elasticsearch clusters Elasticsearch 7.x+ Docs

Web Server & Application Receivers

Receiver Description Supported Versions Documentation
Apache Collects metrics from Apache HTTP Server Apache 2.4+ Docs
Nginx Collects metrics from Nginx servers Nginx with stub_status Docs
IIS Collects metrics from Microsoft IIS Windows Server 2016+ Docs
RabbitMQ Collects metrics from RabbitMQ message broker RabbitMQ 3.8+ Docs
Kafka Metrics Collects metrics from Apache Kafka Kafka 2.0+ Docs

Log Receivers

Receiver Description Log Sources Documentation
Filelog Tails and parses log files Any file-based logs with customizable parsing Docs
Journald Collects logs from systemd journal Linux systemd journal logs Docs
Syslog Receives syslog messages RFC3164 and RFC5424 syslog formats Docs
Fluent Forward Receives logs via Fluentd forward protocol Fluentd/Fluent Bit sources Docs

Cloud Platform Receivers

Receiver Description Cloud Provider Documentation
AWS CloudWatch Collects logs from AWS CloudWatch Logs AWS Docs
AWS CloudWatch Metrics Collects metrics from AWS CloudWatch AWS Docs
AWS Container Insights Collects container insights from ECS/EKS AWS ECS/EKS Docs
AWS ECS Container Metrics Collects metrics from ECS containers AWS ECS Docs
Azure Monitor Collects metrics from Azure Monitor Microsoft Azure Docs
Google Cloud Monitoring Collects metrics from Google Cloud Monitoring Google Cloud Platform Docs

Additional Receivers

Receiver Description Use Case Documentation
Prometheus Scrapes Prometheus metrics endpoints Applications exposing Prometheus metrics Docs
HTTP Check Performs HTTP health checks Synthetic monitoring and endpoint availability Docs
SQL Query Executes custom SQL queries for metrics Custom database metrics extraction Docs
Netflow Collects network flow data Network traffic analysis Docs
vCenter Collects metrics from VMware vCenter VMware infrastructure monitoring Docs

Processors

Processors are run on data between being received and being exported. Processors are optional.

Essential Processors

Processor Description Use Case Documentation
Batch Batches telemetry data before sending Improves compression and reduces network overhead Docs
Memory Limiter Limits memory usage of the collector Prevents out-of-memory conditions Docs

Resource & Attribute Processors

Processor Description Use Case Documentation
Resource Modifies resource attributes Add, update, or delete resource-level attributes Docs
Resource Detection Detects resource information from environment Auto-detect cloud provider, k8s, and host information Docs
Attributes Modifies span, log, or metric attributes Add, update, delete, or hash attribute values Docs
K8s Attributes Adds Kubernetes metadata to telemetry Enrich data with pod, namespace, deployment info Docs
Group By Attrs Groups telemetry by specific attributes Reorganize data streams based on attribute values Docs

Data Transformation Processors

Processor Description Use Case Documentation
Transform Transforms telemetry using OTTL Complex transformations using OpenTelemetry Transformation Language Docs
Metrics Transform Renames and transforms metrics Standardize metric names and units Docs
Cumulative To Delta Converts cumulative metrics to delta Convert cumulative counters to rate-based metrics Docs
Delta To Rate Converts delta metrics to rate Calculate rates from delta values Docs

Filtering & Sampling Processors

Processor Description Use Case Documentation
Filter Filters telemetry based on conditions Drop or include specific metrics, logs, or traces Docs
Probabilistic Sampler Samples traces based on probability Reduce trace volume while maintaining statistical representation Docs
Redaction Redacts sensitive information Remove PII and sensitive data from telemetry Docs

Exporters

Exporters send data to one or more backends or destinations.

Exporter Description Use Case Documentation
OTLP Exports data via OTLP protocol (gRPC) Send to OTLP-compatible backends (e.g., KloudMate) Docs
OTLP HTTP Exports data via OTLP protocol (HTTP) Send to OTLP HTTP endpoints Docs
Debug Logs telemetry data to console Development and troubleshooting Docs
Nop No-operation exporter that drops data Testing and development scenarios Docs

Connectors

Connectors connect two pipelines together, acting as both an exporter and a receiver.

Currently, no connectors are registered in the agent, but the framework supports them for future extensions.

For detailed configuration examples and parameters for each component, please refer to the OpenTelemetry Collector Contrib documentation.