open-telemetry/opentelemetry-collector

Collector componenents utilize prometheus metrics

Open

#7,960 opened on Jun 23, 2023

View on GitHub
 (3 comments) (3 reactions) (0 assignees)Go (2,146 forks)auto 404
area:documentationcollector-telemetryhelp wantedpriority:p2

Repository metrics

Stars
 (7,237 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe. There should be a way for a collector's componeents to interact with the prometheus endpoint of the collector. There does not seem like a straightforward way, or at least not documented of how to add metrics from say an exporter to the collector prometheus endpoint.

Describe the solution you'd like A way to add metrics derived from components such as receiver, processor, exporter etc to the default prometheus endpont of a collector.

Describe alternatives you've considered Perhaps another prometheus endpoint has to be stood up that represents component metrics?

Additional context My overall experience with bulding components for a custom collector has been less than optimal. There is lacking documentation of helper packages, where a logger is derived from (the CreateSettings). Perhaps the issue is the documentation is just scattered everywhere.

Contributor guide

Research direction
Explore how to register custom metrics with the collector's internal Prometheus registry. Look at existing components (e.g., receiver, processor) that expose metrics and follow their pattern. Review the 'obsreport' package for metrics helpers.
Tech stack
go
Domain
backendobservability
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
GoOpenTelemetry Collector basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30