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

Don't model a healthcheck operation in the example Pokemon service #3606

Open
david-perez opened this issue Apr 26, 2024 · 0 comments
Open
Labels
good first issue Good for newcomers server Rust server SDK

Comments

@david-perez
Copy link
Contributor

/// Health check operation, to check the service is up
/// Not yet a deep check
@readonly
@http(uri: "/ping", method: "GET")
operation CheckHealth {
}

You typically don't want to model a healthcheck operation since you don't want users to call it. It's not an inherent property of a service but rather an out-of-band implementation-defined (probably dictated by your particular load balancer / proxy / compute platform) route. For example, we already offer aws_smithy_http_server::layer::alb_health_check for ALB healthchecks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers server Rust server SDK
Projects
None yet
Development

No branches or pull requests

1 participant