How to set up Foundations logging in a Rust microservice?

Initialize Foundations' logger in your main function and configure it via a settings file; the examples directory provides templates for integrating with common patterns like JSON output or file rotation.

Foundations vs tokio-tracing for Rust observability?

Foundations includes tracing as part of a comprehensive suite with metrics and security, while tokio-tracing is more modular and lightweight; choose Foundations for all-in-one production readiness or tokio-tracing for minimal overhead.

Is Foundations suitable for a small Rust CLI tool?

No, Foundations adds overhead with features like distributed tracing and sandboxing that are unnecessary for simple tools; use lighter crates like clap for CLI and env_logger for basic logging instead.

How does Foundations handle configuration validation?

It uses schema-based validation with automatic error reporting, allowing you to define and document configs in Rust structs that are checked at load time via the CLI helper.

Can I use Foundations without enabling seccomp sandboxing?

Yes, security features are configurable; you can disable sandboxing in development modes, but the README recommends keeping it enabled in production for reduced attack surfaces.

What are the performance overheads of Foundations' tracing?

Foundations adds minimal overhead through efficient instrumentation, but for high-throughput services, benchmark with your workload as distributed tracing can impact latency compared to no observability.

How to profile memory with Foundations and jemalloc?

Enable memory profiling in Foundations' configuration, then use tools like jeprof to analyze heap dumps; the integration simplifies setup but requires jemalloc as the allocator.

Open-Awesome

foundations

BSD-3-ClauseRustv3.4.0

A modular Rust library for building production-ready distributed services with built-in observability and security.

Visit Website GitHub

1.6k stars118 forks0 contributors

What is foundations?

Foundations is a modular Rust library designed to help scale programs for distributed, production-grade systems. It provides built-in components for logging, tracing, metrics, security, and configuration, allowing engineers to concentrate on core business logic rather than operational setup.

Target Audience

Rust developers building distributed services or production systems who need robust observability, security, and configuration management without implementing these concerns from scratch.

Value Proposition

Developers choose Foundations for its comprehensive, production-focused feature set that reduces boilerplate and ensures services are observable, secure, and configurable by default, leveraging Rust's performance and safety.

Overview

Cloudflare's Rust service foundations library.

Use Cases

Best For

Building microservices in Rust that require distributed tracing
Adding production-ready observability (logging, metrics, tracing) to Rust services
Implementing security hardening with syscall sandboxing in Rust applications
Managing service configuration with validation and documentation
Developing CLI tools that handle configuration loading automatically
Creating memory-profiled services using jemalloc integration

Not Ideal For

Teams building simple, single-threaded Rust applications that don't require distributed tracing or security sandboxing
Polyglot microservices architectures using multiple languages, as Foundations is Rust-exclusive
Developers who prefer assembling their own observability stack from individual, specialized crates for maximum customization
Environments where jemalloc is not supported or desired, due to Foundations' tight integration for memory profiling

Pros & Cons

Pros

Built-in Observability Suite

Combines structured logging, distributed tracing, and metrics collection in one package, reducing the need to integrate multiple separate libraries.

Security Sandboxing

Integrates seccomp-based syscall filtering out of the box, enhancing application security without requiring custom implementation.

Configuration Management

Provides documented configuration with validation and a CLI helper for loading, simplifying deployment and reducing boilerplate code.

Memory Profiling Integration

Direct support for jemalloc allows for advanced memory allocation analysis, which is crucial for performance tuning in production services.

Cons

Rust-Exclusive Limitation

Tied exclusively to the Rust ecosystem, making it unsuitable for teams using other languages or mixed-technology stacks.

Cloudflare-Centric Assumptions

Developed by Cloudflare, it may include optimizations or defaults tailored to their infrastructure, requiring extra configuration for other environments.

Jemalloc Dependency

Memory profiling relies on jemalloc, which can add complexity or conflicts if other allocators are preferred or already in use.

Frequently Asked Questions

Related Projects

goose

an open source, extensible AI agent that goes beyond code suggestions - install, execute, edit, and test with any LLM

Stars47,610

Forks5,018

Last commit2 days ago

just

🤖 Just a command runner

Stars34,220

Forks795

Last commit1 day ago

A Git-compatible VCS that is both simple and powerful

Stars29,487

Forks1,081

Last commit23 hours ago

mise

dev tools, env vars, task runner

Stars29,236

Forks1,185