| Panel | ||||
|---|---|---|---|---|
|
...
OpenTelemetry is an open-source project that standardizes the collection of telemetry data from software systems, making it easier for organizations to gain holistic visibility into their environments. By seamlessly integrating with various programming languages, frameworks, and cloud platforms, OpenTelemetry simplifies the instrumentation of applications, allowing developers and operators to collect rich, actionable data about their systems' behavior. The adoption of OpenTelemetry by software vendors and Application Performance Monitoring (APM) tools represents a significant shift in the observability landscape. OpenTelemetry has gained substantial traction across the industry due to its open-source, vendor-neutral approach and its ability to standardize telemetry data collection.
Many software vendors have started incorporating OpenTelemetry into their frameworks and libraries. Major cloud service providers like AWS, Azure, and Google Cloud have also embraced OpenTelemetry. In addition, many APM tools have integrated OpenTelemetry into their offerings. This integration allows users of these APM solutions to easily collect and visualize telemetry data from their applications instrumented with OpenTelemetry. It enhances the compatibility and flexibility of APM tools, making them more versatile in heterogeneous technology stacks.
Solution Architecture (Component Description)
...
- Linux Server
- Memory: 16GB RAM
- Storage: 70GB Net storage
- CPU: 4 CPU
- Distribution: Any major Linux distribution
- For the installation and configurations of the required Observability tools Administrative privileges are required
- Ports
The Following default ports will be used.
Application | Port |
|---|---|
| Prometheus | http: 9090 |
| Grafana: | http:3000 |
| Jaeger | http:16686 |
| Elastic | http:9200 |
| OTEL Collector | 4317 (grpc), 4318 (http) |
...
Note: This Startup Guide has been tested with the provide Software Version in the table below.
...
Elasticsearch is a distributed, RESTful search and analytics engine designed for real-time search and data storage. It is used for log and event data analysis, full-text search, and more.
In this set-up Elasticsearch is used as the storage backend for Jaeger.
Installation Steps:
Follow the official documentation to install Elasticsearch on the Linux Server.
Install the Version listed in under Required Software for the Observability
Official Documentation: Elasticsearch Installation Guide
Configuration Files:
- elasticsearch.yml: Main configuration file for Elasticsearch, containing cluster, node, network, memory, and other settings.
- ~/elasticsearch/config/elasticsearch.yml
~/elasticsearch/config/jvm.options
~/elasticsearch/config/jvm.options.d/jvm_heap_size.options
Set JVM Memory Options:
create the file: ~/elasticsearch/config/jvm.options.d/jvm_heap_size.options
...
Setup up Jaeger
Description:
Jaeger is an open-source distributed tracing system used for monitoring and troubleshooting microservices-based applications.
In this set-up Universal Controller will manually instrument Open Telemetry trace on Universal Controller (UC), OMS, Universal Agent (UA), and Universal Task Extension interactions associated with task instance executions, agent registration, and Universal Task of type Extension deployment.
...
Installation Steps:
Configuration Files:
- jaeger-agent-config.yaml: Configuration for the Jaeger agent, responsible for trace collection.
- jaeger-collector-config.yaml: Configuration for the Jaeger collector, handling trace reception and processing.
- jaeger-query-config.yaml: Configuration for the Jaeger query service, used for trace querying and visualization.
Official Documentation: Jaeger Installation Guide
...
Setup OTEL Collector
Description:
OpenTelemetry Collector is a vendor-agnostic observability data collector that gathers traces, metrics, and other telemetry data from various sources and sends it to different backends for analysis.
In this set-up OpenTelemetry collects Metrics data from Universal Controller, Universal Agent, OMS and Universal Tasks of type Extension.
Installation Steps:
Configuration Files:
- config.yaml: Primary configuration file for the OpenTelemetry Collector, defining data sources, exporters, processors, and components.
Official Documentation: OpenTelemetry Collector Installation
...
Set up Prometheus
Description:
Prometheus is an open-source monitoring and alerting toolkit designed for reliability and scalability. It collects metrics from monitored targets, stores them, and provides powerful querying and alerting capabilities.
In this set-up Prometheus is used to store the Metrics data retrieved via Opentelemetry and the Universal Controller Metrics REST API.
Installation Steps:
Configuration Files:
- prometheus.yml: Main configuration file for Prometheus, defining scrape targets (what to monitor), alerting rules, and other settings.
Official Documentation: Prometheus Installation Guide
...
Set up Grafana
Description:
Grafana is an open-source platform for monitoring and observability that allows you to create, explore, and share dynamic dashboards and visualizations for various data sources, including time series databases.
In the this set-up Grafana is used to Visualize and Analyze the Metrics data store in Prometheus data source (time series database).
Installation Steps:
Configuration Files:
- grafana.ini: Grafana's main configuration file, including database connections, server settings, and global configurations.
- datasources.yaml: Configuration for data sources (e.g., Prometheus) that Grafana connects to.
- dashboards: Grafana dashboards are often defined as JSON files that can be imported into Grafana.
Official Documentation: Grafana Installation Guide
...