Skip to content

Update README#391

Merged
rcoh merged 2 commits into
mainfrom
readme-v2
May 12, 2026
Merged

Update README#391
rcoh merged 2 commits into
mainfrom
readme-v2

Conversation

@rcoh

@rcoh rcoh commented May 11, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@jlizen jlizen left a comment

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.

Good rewrite. some small things.

Comment thread dial9-tokio-telemetry/README.md Outdated
## Quick Start

## Is there a demo?
dial9 is fundamentally an efficient way to collect data from [different sources](#data-sources) then [export them out of the application](#getting-data-out-of-dial9). You can enable as many different data sources as you need to debug (or as few as you can tolerate the overhead of in production.)

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.

This seems a bit odd to have at the start of quickstart. I would have expected to lead with code samples.

## Data sources

#### Requirements
dial9 is fundamentally a central buffer that can collect data from different sources. You can pull in as many or as few as you want.

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.

we say "fundamentally a"... a lot

Comment thread dial9-tokio-telemetry/README.md Outdated
```

This runs the `overhead_bench` binary with and without telemetry and reports the difference. Typical output:
By default objects will be uploaded to `s3://{bucket}/{prefix}/{YYYY-MM-DD}/{HHMM}/{service_name}/{instance_path}/{boot_id}/{epoch_secs}-{index}.bin.gz`. You can customize the location with `S3Config::builder().key_fn(...)`.

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: this is starting to get into the, "we should have a doc page on this", level of detail territory

@rcoh rcoh enabled auto-merge May 12, 2026 00:40
@rcoh rcoh added this pull request to the merge queue May 12, 2026
Merged via the queue into main with commit fcf6ce1 May 12, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants