Skip to content

Out-of-the-box AWS X-Ray instrumentation for AWS Lambda functions using the AWS SDK for Rust

License

Notifications You must be signed in to change notification settings

RustyServerless/awssdk-instrumentation

Repository files navigation

crates.io docs.rs CI License

awssdk-instrumentation

Out-of-the-box instrumentation for the AWS SDK for Rust, with special care for code running on AWS Lambda

🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧

🔨🔨🔨🔨🔨🔨🔨🔨🔨🔨🔨

⚠️ WORK IN PROGRESS ⚠️

🔨🔨🔨🔨🔨🔨🔨🔨🔨🔨🔨

🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧

Minimum Supported Rust Version (MSRV)

This crate requires Rust version 1.85.0 or later.

Contributing

We welcome contributions! Here's how you can help:

  1. Report bugs by opening an issue
  2. Suggest new features or improvements
  3. Submit pull requests for bug fixes or features
  4. Improve documentation
  5. Share example code and use cases

Please review our contributing guidelines before submitting pull requests.

Git Hooks

This project uses git hooks to ensure code quality. The hooks are automatically installed when you enter a development shell using nix flakes and direnv.

The following checks are run before each commit:

  • Code formatting (cargo fmt)
  • Linting (cargo clippy)
  • Doc generation (cargo doc)
  • Tests (cargo test)

If any of these checks fail, the commit will be aborted. Fix the issues and try committing again.

To manually install the hooks:

./scripts/install-hooks.sh

Note: Any changes that have not passed local tests will result in CI failures, as GitHub Actions performs identical verification checks.

Issues

Before reporting issues, please check:

  1. Existing issues to avoid duplicates
  2. The documentation to ensure it's not a usage error
  3. The FAQ for common problems

When opening a new issue, include:

  • A clear title and description
  • Steps to reproduce bugs
  • Expected vs actual behavior
  • Code samples if relevant

License

This project is licensed under the MIT License - see the LICENSE file for details.

Authors

If you find this crate useful, please star the repository and share your feedback!

wip

About

Out-of-the-box AWS X-Ray instrumentation for AWS Lambda functions using the AWS SDK for Rust

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors