Skip to main content

radiant_hubble/
lib.rs

1//! Core library for constructing and running a Hubble service.
2//!
3//! [`Hubble`] constructs the application. Hubble persists traces in
4//! `PostgreSQL`, serves its HTTP API and embedded Hubble dashboard,
5//! and exposes an OTLP/HTTP receiver for external telemetry.
6//!
7//! # Traces
8//!
9//! Configure storage through `HUBBLE_DATABASE_URL`.
10//! The OTLP receiver accepts JSON or protobuf at `POST /v1/traces`.
11//! Received spans are persisted and streamed to connected dashboards.
12//!
13//! # Networking and security
14//!
15//! The dashboard runs its own listeners, which bind loopback by default:
16//!
17//! | Listener | Default bind |
18//! | --- | --- |
19//! | Web UI and API | `127.0.0.1:8080` |
20//! | OTLP receiver | `127.0.0.1:4318` |
21//! | Optional management API | `127.0.0.1:8081` |
22//!
23//! Built-in authentication is disabled by default. Configure local
24//! authentication with `HUBBLE_AUTH_MODE=local`. Single-tenant startup ensures one organization/project;
25//! use `hubble admin invite-owner` to invite its first local owner.
26//! Session cookies are secure by default and should only be
27//! configured otherwise for intentional plain-HTTP development.
28//!
29//! The same authentication setting protects OTLP with project API keys rather than
30//! dashboard sessions. Disabled authentication permits tokenless single-project
31//! ingestion and ignores Authorization headers. Use TLS or a trusted network
32//! for project API keys, and restrict anonymous ingestion to trusted clients.
33//! The private management listener has a separate service bearer credential
34//! and is disabled by default.
35//!
36//! # Example
37//!
38//! ```no_run
39//! use radiant_hubble::Hubble;
40//!
41//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
42//! Hubble::new().run().await?;
43//! # Ok(())
44//! # }
45//! ```
46
47mod account;
48mod agents;
49mod api;
50mod app;
51mod assets;
52mod auth;
53pub mod billing;
54mod cli;
55mod config;
56mod console;
57mod db;
58mod extension;
59mod ingest;
60mod initialization;
61mod logs;
62mod management;
63mod mcp;
64mod meta_agent;
65mod pagination;
66pub mod provisioning;
67mod runtime_config;
68pub mod simulations;
69mod state;
70mod tenancy;
71#[cfg(any(test, feature = "test-support"))]
72pub mod test_support;
73mod time;
74mod trace;
75mod trajectory;
76mod usage;
77mod web_server;
78
79pub use app::{DashboardApp, DashboardError, Hubble, RunningDashboard};
80pub use auth::{AuthenticatedUser, UserId, apply_authentication_contract};
81pub use billing::{BillingError, UsageDenied, UsageDeniedReason};
82pub use cli::HubbleCliError;
83pub use config::{
84    AuthenticationMode, GlobalRetentionPolicy, ProjectRetentionPolicy, RetentionConfigError,
85    RetentionDays,
86};
87pub use extension::{DASHBOARD_EXTENSION_API_VERSION, DashboardExtension, DashboardExtensionError};
88pub use logs::contract::{LogGroupSelection, LogsGrouping, LogsSource};
89pub use management::api_doc as management_api_doc;
90#[cfg(any(test, feature = "test-support"))]
91pub use meta_agent::fake::FakeMetaAgentProvider;
92pub use meta_agent::{
93    ConnectionAuth, ConnectionKind, ConnectionScope, ConnectionSecret, ConnectionStatus,
94    ConnectionSummary, ConversationContext, ConversationHistoryMessage, ConversationHistorySummary,
95    ConversationId, ConversationIdError, ConversationVisibility, HttpMetaAgentProvider,
96    HttpMetaAgentProviderError, MessageAuthor, MessageRole, MetaAgentExtension,
97    MetaAgentExtensionIdError, MetaAgentProvider, OauthClient, ObservationCorrelation,
98    ObservationEvidence, ObservationGrouping, ObservationSettings, ObservationSignalVerdict,
99    ObservationSummary, PersonalToolPreferenceChanges, PersonalToolPreferences,
100    ProjectToolPolicies, ProjectToolPolicy, ProviderActor, ProviderAddConnectionRequest,
101    ProviderBeginConnectionOauthRequest, ProviderBeginConnectionOauthResponse,
102    ProviderBindUsageScopeRequest, ProviderCancelTurnRequest, ProviderCapabilities,
103    ProviderCompleteConnectionOauthRequest, ProviderCompleteConnectionOauthResponse,
104    ProviderConnectionContext, ProviderConnectionList, ProviderConversationHistoryPage,
105    ProviderConversationHistorySearch, ProviderConversationRef, ProviderCreateConversationRequest,
106    ProviderCreateSignalRequest, ProviderCreateTurnRequest, ProviderDeactivateSignalRequest,
107    ProviderDeleteConversationRequest, ProviderDiscoverToolsRequest, ProviderError, ProviderEvent,
108    ProviderEventPage, ProviderFetchEventsRequest, ProviderForceObservationReviewOutcome,
109    ProviderForceObservationReviewRequest, ProviderGetObservationSettingsRequest,
110    ProviderListConnectionsRequest, ProviderListObservationsRequest, ProviderListSignalsRequest,
111    ProviderObservationList, ProviderPromoteSignalRequest,
112    ProviderProvisionHubbleConnectionRequest, ProviderReadConversationHistoryRequest,
113    ProviderReconnectConnectionRequest, ProviderRemoveConnectionRequest,
114    ProviderResolveApprovalRequest, ProviderRevokeHubbleConnectionRequest,
115    ProviderSearchConversationHistoryRequest, ProviderSetConversationVisibilityRequest,
116    ProviderSetObservationSettingsRequest, ProviderSetPersonalToolPreferencesRequest,
117    ProviderSetProjectToolPoliciesRequest, ProviderSetToolPermissionsRequest, ProviderSignalList,
118    ProviderTurnRef, SignalMemoryStatus, SignalOrigin, SignalScorer, SignalSummary, ToolDescriptor,
119    ToolPermission, ToolPermissions, TurnId, TurnIdError, provider_api_router,
120};
121pub use provisioning::{CreatedApiKey, ProvisioningError};
122pub use state::DashboardState;
123pub use tenancy::permissions;
124pub use tenancy::{
125    AuthorizedOrganization, AuthorizedProject, CreateInvitationError, CreatedInvitation,
126    InvitationId, ListOrganizationsResponse, ListProjectsResponse, Organization, OrganizationId,
127    OrganizationIdError, Project, ProjectId, ProjectIdError, ProjectLogColumn, ProjectLogView,
128    ProjectLogViewDetails, ProjectLogViews, ProjectLogViewsError, ProjectRunFilter,
129    ProvisionOrganizationError, ProvisionedOrganization, ReplaceInvitationError,
130};
131pub use usage::{
132    AgentRunUsage, TraceIngestionDecision, TraceIngestionRequest, TraceUsage, UsageAccessDecision,
133    UsageActivity, UsageAggregate, UsageAnalyticsItem, UsageConsoleClient, UsageConsoleConfig,
134    UsageConsoleError, UsageConsumptionReceipt, UsageController, UsageCountSnapshot, UsageCredits,
135    UsageDeliveryIssue, UsageDeliveryMode, UsageDeliveryReceipt, UsageDeliverySummary,
136    UsageDeliveryWorker, UsageError, UsageEvent, UsageExtension, UsageExtensionIdError,
137    UsageFeatureCheck, UsageIngestionBatch, UsageInspection, UsageMeasurement, UsageOperations,
138    UsageOperationsError, UsageOverage, UsageOverageRate, UsagePeriod, UsagePlan, UsageProperty,
139    UsageRejection, UsageReporter, UsageReportingError, UsageScope, UsageSummary,
140    UsageValidationError,
141};
142pub use utoipa;
143pub use utoipa_axum::router::OpenApiRouter;
144pub use web_server::api_doc;