Skip to content

Update the top-level README#2512

Draft
jmacd wants to merge 24 commits intoopen-telemetry:mainfrom
jmacd:jmacd/README2
Draft

Update the top-level README#2512
jmacd wants to merge 24 commits intoopen-telemetry:mainfrom
jmacd:jmacd/README2

Conversation

@jmacd
Copy link
Copy Markdown
Contributor

@jmacd jmacd commented Apr 2, 2026

Change Summary

Update README to highlight our progress in Phase 2. We did a lot!

Are there any user-facing changes?

Yes. I tested the example commands in this update.

@github-actions github-actions bot added the rust Pull requests that update Rust code label Apr 2, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.32%. Comparing base (983cb42) to head (bc7482f).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2512      +/-   ##
==========================================
+ Coverage   88.29%   88.32%   +0.03%     
==========================================
  Files         613      613              
  Lines      220110   220110              
==========================================
+ Hits       194338   194414      +76     
+ Misses      25248    25172      -76     
  Partials      524      524              
Components Coverage Δ
otap-dataflow 90.24% <ø> (+0.04%) ⬆️
query_abstraction 80.61% <ø> (ø)
query_engine 90.74% <ø> (ø)
syslog_cef_receivers ∅ <ø> (∅)
otel-arrow-go 52.45% <ø> (ø)
quiver 91.92% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Member

@albertlockett albertlockett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice improvements

@jmacd jmacd marked this pull request as ready for review April 2, 2026 18:09
@jmacd jmacd requested a review from a team as a code owner April 2, 2026 18:09
OpenTelemetry Collector-Contrib distribution since [the July 2024
release of v0.104.0][ARROW-RELEASED].

Our Rust and Go codebases are both used in production. Our project has
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

used in production

We probably need to add some links/references to make that statement?

OpenTelemetry Profiles signal in OTAP is important future work.

In both our Rust and Golang implementations, we support combined OTAP
and OTLP services on a single port, making OTel-Arrow OTAP/OTLP
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you mean we support OTLP and OTAP receiver on a single port? .. This sentence reads a bit odd..


A [directory of example configurations][EXAMPLE-CONFIGS] provides a
number of examples (e.g.,
[syslog-console.yaml][SYSLOG-CONSOLE-YAML]). For example, to print
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to receive syslog messages on port 5140 and then print them to console

> documentation][SYSLOG-CEF] for secure configuration examples.

```bash
./target/debug/df_engine -c ./configs/syslog-console.yaml --num-cores=1
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: maybe we should mention the relevance of --num-cores=1 ? or omit it?

@jmacd jmacd marked this pull request as draft April 3, 2026 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rust Pull requests that update Rust code

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants