Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

redacted and full telemetry servers #164

Merged
merged 4 commits into from
Sep 10, 2024
Merged

Conversation

liamaharon
Copy link
Contributor

@liamaharon liamaharon commented Sep 3, 2024

  • Creates a new module server inside live_builder
    • Server exposes a single fn start, which starts an actix server on the given port
    • Initial server implementation just exposes one route /health that responds 200
  • Adds new base config item live_builder_server_port
  • Server is spawned when running the live_builder cli

Background

  • TDX builders cannot expose the existing telemetry server port, due to concerns about sensitive operational information leakage. This information may require a time-delay or additional sanitisation before being exposed outside of the secure machine.
  • TDX builders require some other means to know if the builder is healthy or not.

Solution

  • Separated the telemetry server into two servers: full and redacted.
    • full: what we have now, exposes all operational data without regard for whether it is sensitive
    • redacted: new server that initially only exposes a healthcheck endpoint (can be extended later). This server is safe to always be exposed by tdx builders.

Copy link

github-actions bot commented Sep 3, 2024

Benchmark results for 46c3067

Report: https://flashbots-rbuilder-ci-stats.s3.us-east-2.amazonaws.com/benchmark/46c3067-ccf4677/report/index.html

Date (UTC) 2024-09-10T17:58:25+00:00
Commit 46c3067084f337085df042b5ef87b4ab1d52c429
Base SHA ccf4677ba3aa8cc1b50e14b6bda4947322ee48a2

Significant changes

Benchmark Mean Status
MEV-Boost SubmitBlock serialization/JSON encoding 64.95% Performance has degraded.

@dvush
Copy link
Contributor

dvush commented Sep 3, 2024

We already have server that you can hook on that serves telemetry + other debug endpoints we can add health endpoint there too. What is the justification for not using it and for adding additional server instead?

@liamaharon liamaharon marked this pull request as draft September 5, 2024 07:53
@liamaharon liamaharon force-pushed the liam/live_builder_server branch from a014271 to 0d6cc40 Compare September 9, 2024 14:01
@liamaharon liamaharon changed the title live_builder health check server Seperate telemetry opaque and debug servers Sep 9, 2024
@liamaharon liamaharon changed the title Seperate telemetry opaque and debug servers Telemetry opaque and debug servers Sep 9, 2024
@liamaharon liamaharon changed the title Telemetry opaque and debug servers opaque and debug telemetry servers Sep 9, 2024
@liamaharon liamaharon marked this pull request as ready for review September 9, 2024 14:11
@liamaharon liamaharon force-pushed the liam/live_builder_server branch from 0d6cc40 to 24b9268 Compare September 9, 2024 14:12
@ZanCorDX
Copy link
Contributor

ZanCorDX commented Sep 9, 2024

The names opaque_server/debug_server tells me nothing. I liked more "telemetry".
Maybe full_telemetry and health_check (or redacted_telemetry)?

@liamaharon liamaharon changed the title opaque and debug telemetry servers restricted and full telemetry servers Sep 10, 2024
@liamaharon liamaharon force-pushed the liam/live_builder_server branch from eee2416 to 446d8ef Compare September 10, 2024 07:09
@liamaharon liamaharon force-pushed the liam/live_builder_server branch from 446d8ef to 8f5368f Compare September 10, 2024 07:10
@liamaharon liamaharon changed the title restricted and full telemetry servers redacted and full telemetry servers Sep 10, 2024
@liamaharon liamaharon force-pushed the liam/live_builder_server branch from b6b3407 to 46c3067 Compare September 10, 2024 17:57
@liamaharon liamaharon merged commit 59e7cd3 into develop Sep 10, 2024
3 checks passed
@liamaharon liamaharon deleted the liam/live_builder_server branch September 10, 2024 18:25
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.

4 participants