Skip to content

railwayapp-templates/opentelemetry-collector-stack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open Telemetry Collector Stack

Deploy this OpenTelemetry Collector to Railway along with Zipkin, Jaeger, and Prometheus backends, with the click of a button!

Deploy on Railway

About this Repo

This repository contains the Dockerfile and config yaml for the Open Telemetry Collector, ready to deploy to Railway.

It also contains an example node app that is instrumented with Otel's node SDK.

For information on how to deploy the the collector and app, check out the tutorial in Railway.

Technical Details

When you deploy this collector and stack from the Railway template by clicking the button above, each of the following services will be deployed.

OpenTelemetry Collector

The collector is a vendor-agnostic way to receive, process and export telemetry data.

It is deployed with a configuration file that enables it to send data to the complementary backend services.

The zpages extension is enabled, allowing you to connect to the debug UI from your browser. More information on the extension can be found here.

Documentation

Port map for reference:

- "1888"   # pprof extension
- "8888"   # Prometheus metrics exposed by the collector
- "8889"   # Prometheus exporter metrics
- "13133" # health_check extension
- "4317"   # OTLP gRPC receiver
- "4318"   # OTLP HTTP receiver
- "55679" # zpages extension

Zipkin

Zipkin is a distributed tracing system. It receives data from the Otel Collector on port 9411.

Jaeger

Jaeger is a distributed tracing system. It receives data from the Otel Collector on port 4317.

Prometheus

Prometheus is a systems monitoring and alerting toolkit. It receives data from the Otel Collector on port 8889.

Example Apps

We will continue to add examples as we engage with our users and work through various implementations.

If you have an example, we would LOVE to include it. PRs welcome!!