open-telemetry / open-telemetry/opentelemetry-php
Inconsistent console exporter behavior/documentation
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 912
- Forks
- 232
- Avg merge
- 7d 16h
- Merged PRs (30d)
- 4
Description
Is your feature request related to a problem?
Not really a problem, but an observation.
Code discrepancies:
OpenTelemetry\SDK\Logs\Exporter\ConsoleExporterdepends on being created byConsoleExporterFactoryto create the appropriate stream transport, otherwise it's not actually exporting to the consolOpenTelemetry\SDK\Metrics\MetricExporter\ConsoleMetricExporterusesechofor output (the only time echo is used anywhere in the SDK)OpenTelemetry\SDK\Trace\SpanExporter\ConsoleSpanExporterdepends onSpanExporterFactoryInterfacein the same manner as the Log exporter
Documentation discrepancies:
Referencing this otel.io page:
- Under "Instrumentation setup>Initialize the SDK" the example
instrumentation.phpcreates each exporter by configuring the stream transport directly - Under "Traces>Span Processor" the
ConsoleSpanExporterFactoryis used - Under "Metrics>Setup" the
ConsoleMetricExporterFactoryis used - Under "Logs>Setup" the stream transport is configured directly
Describe the solution you'd like
- Update
ConsoleMetricExporterto use a transport instead ofecho - Update all three exporters to have a default stream transport targeting
php://stdoutso they are functionally "console" exporters even without the factory - Remove the (then redundant) default transport from the factories
- Update the documentation to use the console exporter factory in all instances
Describe alternatives you've considered
Checked for any related issues, did not see any.
Additional context
None.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading ConsoleExporter, ConsoleMetricExporter, ConsoleSpanExporter, and their corresponding factory classes to compare transport and output handling. Review the referenced instrumentation, span processor, metrics, and logs documentation, then verify that all exporters consistently target php://stdout and that the documentation consistently uses the console exporter factories.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation, observability-sre
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100