relay_server/endpoints/
mod.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
//! Web server endpoints.
//!
//! This module contains implementations for all supported relay endpoints, as well as a generic
//! `forward` endpoint that sends unknown requests to the upstream.

mod attachments;
mod autoscaling;
mod batch_metrics;
mod batch_outcomes;
mod common;
mod envelope;
mod events;
mod forward;
mod health_check;
mod minidump;
mod monitor;
mod nel;
mod project_configs;
mod public_keys;
mod security_report;
mod statics;
mod store;
mod traces;
mod unreal;

use axum::extract::DefaultBodyLimit;
use axum::routing::{any, get, post, Router};
use relay_config::Config;

use crate::middlewares;
use crate::service::ServiceState;

/// Size limit for internal batch endpoints.
const BATCH_JSON_BODY_LIMIT: usize = 50_000_000; // 50 MB

#[rustfmt::skip]
pub fn routes(config: &Config) -> Router<ServiceState>{
    // Relay-internal routes pointing to /api/relay/
    let internal_routes = Router::new()
        .route("/api/relay/healthcheck/{kind}/", get(health_check::handle))
        .route("/api/relay/events/{event_id}/", get(events::handle))
        .route("/api/relay/autoscaling/", get(autoscaling::handle))
        // Fallback route, but with a name, and just on `/api/relay/*`.
        .route("/api/relay/{*not_found}", any(statics::not_found));

    // Sentry Web API routes pointing to /api/0/relays/
    let web_routes = Router::new()
        .route("/api/0/relays/projectconfigs/", post(project_configs::handle))
        .route("/api/0/relays/publickeys/", post(public_keys::handle))
        // Network connectivity check for downstream Relays, same as the internal health check.
        .route("/api/0/relays/live/", get(health_check::handle_live))
        .route_layer(DefaultBodyLimit::max(crate::constants::MAX_JSON_SIZE));

    let batch_routes = Router::new()
        .route("/api/0/relays/outcomes/", post(batch_outcomes::handle))
        .route("/api/0/relays/metrics/", post(batch_metrics::handle))
        .route_layer(DefaultBodyLimit::max(BATCH_JSON_BODY_LIMIT));

    // Ingestion routes pointing to /api/:project_id/
    let store_routes = Router::new()
        // Legacy store path that is missing the project parameter.
        .route("/api/store/", store::route(config))
        // cron monitor level routes.  These are user facing APIs and as such support trailing slashes.
        .route("/api/{project_id}/cron/{monitor_slug}/{sentry_key}", monitor::route(config))
        .route("/api/{project_id}/cron/{monitor_slug}/{sentry_key}/", monitor::route(config))
        .route("/api/{project_id}/cron/{monitor_slug}", monitor::route(config))
        .route("/api/{project_id}/cron/{monitor_slug}/", monitor::route(config))

        .route("/api/{project_id}/store/", store::route(config))
        .route("/api/{project_id}/envelope/", envelope::route(config))
        .route("/api/{project_id}/security/", security_report::route(config))
        .route("/api/{project_id}/csp-report/", security_report::route(config))
        .route("/api/{project_id}/nel/", nel::route(config))
        // No mandatory trailing slash here because people already use it like this.
        .route("/api/{project_id}/minidump", minidump::route(config))
        .route("/api/{project_id}/minidump/", minidump::route(config))
        .route("/api/{project_id}/events/{event_id}/attachments/", post(attachments::handle))
        .route("/api/{project_id}/unreal/{sentry_key}/", unreal::route(config))
        .route("/api/{project_id}/otlp/v1/traces/", traces::route(config))
        // NOTE: If you add a new (non-experimental) route here, please also list it in
        // https://github.com/getsentry/sentry-docs/blob/master/docs/product/relay/operating-guidelines.mdx
        .route_layer(middlewares::cors());

    Router::new().merge(internal_routes)
        .merge(web_routes)
        .merge(batch_routes)
        .merge(store_routes)
        // Forward all other API routes to the upstream. This will 404 for non-API routes.
        .fallback(forward::forward)
}