Skip to content

Fix Kafka receiver doc and document commonly-needed OTel config settings - #119874

Open
IshwarKanse wants to merge 1 commit into
openshift:standalone-otel-docs-mainfrom
IshwarKanse:docs/otel-regression-detection-v0.158.0-fixes
Open

IshwarKanse wants to merge 1 commit into
openshift:standalone-otel-docs-mainfrom
IshwarKanse:docs/otel-regression-detection-v0.158.0-fixes

Conversation

@IshwarKanse

@IshwarKanse IshwarKanse commented Sep 16, 2026

Copy link
Copy Markdown
Member

Summary

Follow-up on the regression-detection report run against collector/operator v0.158.0 This PR only includes the documentation-affecting findings that are worth fixing/documenting; unrelated findings from the report (bug fixes, feature gates, dependency bumps, etc.) are tracked separately and are out of scope here.

  • Kafka Receiver (otel-receivers-kafka-receiver.adoc): the documented topic and auth.plain_text fields no longer exist upstream and cause the collector to fail to start. Replaced with logs.topics/metrics.topics/traces.topics and auth.sasl (+ mechanism: PLAIN), documented auth.kerberos, and added a migration note.
  • Filelog Receiver (otel-receivers-filelog-receiver.adoc): added a note about the ordering_criteria.top_n: 0 semantics change (now means "read all matched files" instead of "read the first file only").
  • Kubernetes Attributes Processor (otel-processors-kubernetes-attributes-processor.adoc): documented extract (metadata/labels) and pod_association, which most real deployments need to get useful metadata beyond the connection-IP default.
  • OTLP gRPC Exporter (otel-exporters-otlp-grpc-exporter.adoc): documented timeout, sending_queue, and retry_on_failure — core reliability/tuning settings that are enabled by default but were undocumented.
  • Resource Detection Processor (otel-processors-resource-detection-processor.adoc): documented the openshift detector's address/token/tls overrides, needed when the collector can't use the in-cluster API endpoint/token.

…ity/metadata settings

Fixes the Kafka Receiver doc's removed `topic` and `auth.plain_text`
fields, and adds a few commonly-needed but undocumented settings
(k8sattributes pod_association/extract, OTLP gRPC exporter queue/retry,
resourcedetection openshift detector overrides) surfaced by upstream
regression-detection analysis ahead of the next collector/operator bump.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@openshift-ci openshift-ci Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 16, 2026
@openshift-ci

openshift-ci Bot commented Sep 16, 2026

Copy link
Copy Markdown

@IshwarKanse: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@IshwarKanse

Copy link
Copy Markdown
Member Author

cc @pavolloffay @max-cx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants