relay_server/endpoints/
mod.rs

1//! Web server endpoints.
2//!
3//! This module contains implementations for all supported relay endpoints, as well as a generic
4//! `forward` endpoint that sends unknown requests to the upstream.
5
6mod attachments;
7mod autoscaling;
8mod batch_metrics;
9mod batch_outcomes;
10mod common;
11mod envelope;
12mod forward;
13mod health_check;
14mod integrations;
15mod minidump;
16mod monitor;
17mod nel;
18#[cfg(sentry)]
19mod playstation;
20mod project_configs;
21mod public_keys;
22mod register;
23mod security_report;
24mod statics;
25mod store;
26mod unreal;
27
28use axum::extract::DefaultBodyLimit;
29use axum::routing::{Router, any, get, post};
30use relay_config::Config;
31
32use crate::middlewares;
33use crate::service::ServiceState;
34
35/// Size limit for internal batch endpoints.
36const BATCH_JSON_BODY_LIMIT: usize = 50_000_000; // 50 MB
37
38/// All of Relay's routes.
39///
40/// This includes [`public_routes`] as well as [`internal_routes`].
41pub fn all_routes(config: &Config) -> Router<ServiceState> {
42    public_routes_raw(config).merge(internal_routes(config))
43}
44
45/// Relay's internal routes.
46///
47/// Routes which do not need to be exposed.
48#[rustfmt::skip]
49pub fn internal_routes(_: &Config) -> Router<ServiceState>{
50    Router::new()
51        .route("/api/relay/healthcheck/{kind}/", get(health_check::handle))
52        .route("/api/relay/autoscaling/", get(autoscaling::handle))
53        // Fallback route, but with a name, and just on `/api/relay/*`.
54        .route("/api/relay/{*not_found}", any(statics::not_found))
55}
56
57/// Relay's public routes.
58///
59/// Routes which are public API and must be exposed.
60pub fn public_routes(config: &Config) -> Router<ServiceState> {
61    // Exclude internal routes, they must be configured separately.
62    public_routes_raw(config).route("/api/relay/{*not_found}", any(statics::not_found))
63}
64
65#[rustfmt::skip]
66fn public_routes_raw(config: &Config) -> Router<ServiceState> {
67    // Sentry Web API routes pointing to /api/0/relays/
68    let web_routes = Router::new()
69        .route("/api/0/relays/projectconfigs/", post(project_configs::handle))
70        .route("/api/0/relays/publickeys/", post(public_keys::handle))
71        .route("/api/0/relays/register/challenge/", post(register::challenge))
72        .route("/api/0/relays/register/response/", post(register::response))
73        // Network connectivity check for downstream Relays, same as the internal health check.
74        .route("/api/0/relays/live/", get(health_check::handle_live))
75        .route_layer(DefaultBodyLimit::max(crate::constants::MAX_JSON_SIZE));
76
77    let batch_routes = Router::new()
78        .route("/api/0/relays/outcomes/", post(batch_outcomes::handle))
79        .route("/api/0/relays/metrics/", post(batch_metrics::handle))
80        .route_layer(DefaultBodyLimit::max(BATCH_JSON_BODY_LIMIT));
81
82    // Ingestion routes pointing to /api/:project_id/
83    let store_routes = Router::new()
84        // Legacy store path that is missing the project parameter.
85        .route("/api/store/", store::route(config))
86        // cron monitor level routes.  These are user facing APIs and as such support trailing slashes.
87        .route("/api/{project_id}/cron/{monitor_slug}/{sentry_key}", monitor::route(config))
88        .route("/api/{project_id}/cron/{monitor_slug}/{sentry_key}/", monitor::route(config))
89        .route("/api/{project_id}/cron/{monitor_slug}", monitor::route(config))
90        .route("/api/{project_id}/cron/{monitor_slug}/", monitor::route(config))
91
92        .route("/api/{project_id}/store/", store::route(config))
93        .route("/api/{project_id}/envelope/", envelope::route(config))
94        .route("/api/{project_id}/security/", security_report::route(config))
95        .route("/api/{project_id}/csp-report/", security_report::route(config))
96        .route("/api/{project_id}/nel/", nel::route(config))
97        // No mandatory trailing slash here because people already use it like this.
98        .route("/api/{project_id}/minidump", minidump::route(config))
99        .route("/api/{project_id}/minidump/", minidump::route(config))
100        .route("/api/{project_id}/events/{event_id}/attachments/", post(attachments::handle))
101        .route("/api/{project_id}/unreal/{sentry_key}/", unreal::route(config));
102
103    #[cfg(sentry)]
104    let store_routes = store_routes.route("/api/{project_id}/playstation/", playstation::route(config));
105    let store_routes = store_routes.route_layer(middlewares::cors());
106
107    // Integration routes.
108    //
109    // For integrations we want to be lenient on trailing `/`, as they are often manually
110    // configured by users or protocols may force a specific variant.
111    let integration_routes = Router::new()
112        .nest("/api/{project_id}/integration/otlp", integrations::otlp::routes(config))
113        .nest("/api/{project_id}/integration/vercel", integrations::vercel::routes(config))
114        .route_layer(middlewares::cors());
115
116    // NOTE: If you add a new (non-experimental) route here, please also list it in
117    // https://github.com/getsentry/sentry-docs/blob/master/docs/product/relay/operating-guidelines.mdx
118
119    Router::new()
120        .merge(web_routes)
121        .merge(batch_routes)
122        .merge(store_routes)
123        .merge(integration_routes)
124        // Forward all other API routes to the upstream. This will 404 for non-API routes.
125        .fallback(forward::forward)
126}
relay_server/endpoints/mod.rs

relay_server/endpoints/
mod.rs
