:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
from typing import cast
from requests.exceptions import RequestException
from products.warehouse_sources.sources.rudderstack._config import RudderStackSourceConfig
from products.warehouse_sources.sources.rudderstack.canonical_descriptions import CANONICAL_DESCRIPTIONS
from products.warehouse_sources.sources.rudderstack.rudderstack import (
RudderStackResumeConfig,
probe_credentials,
rudderstack_source,
token_for_endpoint,
)
from products.warehouse_sources.sources.rudderstack.settings import BASE_URLS, ENDPOINTS
from products.warehouse_sources.sources.sdk import (
CanonicalDescriptions,
DataWarehouseSourceCategory,
ExternalDataSourceType,
FieldType,
ProductKey,
ReleaseStatus,
ResumableSource,
ResumableSourceManager,
SourceConfig,
SourceFieldInputConfig,
SourceFieldInputConfigType,
SourceFieldSelectConfig,
SourceFieldSelectConfigOption,
SourceInputs,
SourceRegistry,
SourceResponse,
SourceSchema,
build_endpoint_schemas,
detect,
)
@SourceRegistry.register
class RudderStackSource(ResumableSource[RudderStackSourceConfig, RudderStackResumeConfig]):
codebase_detection = detect(
env=(
"^RUDDERSTACK_",
"^NEXT_PUBLIC_RUDDERSTACK_WRITE_KEY$",
"^NEXT_PUBLIC_RUDDERSTACK_DATAPLANE_URL$",
"^NEXT_PUBLIC_RUDDERSTACK_CONFIG_URL$",
"^REACT_APP_RUDDERSTACK_WRITE_KEY$",
"^REACT_APP_RUDDERSTACK_DATAPLANE_URL$",
"^REACT_APP_RUDDERSTACK_CONFIG_URL$",
"^VITE_RUDDERSTACK_WRITE_KEY$",
"^VITE_RUDDERSTACK_DATAPLANE_URL$",
"^VITE_RUDDERSTACK_CONFIG_URL$",
"^GATSBY_RUDDERSTACK_WRITE_KEY$",
"^GATSBY_RUDDERSTACK_DATAPLANE_URL$",
"^GATSBY_RUDDERSTACK_CONFIG_URL$",
"^NG_APP_RUDDERSTACK_WRITE_KEY$",
"^NG_APP_RUDDERSTACK_DATAPLANE_URL$",
"^NG_APP_RUDDERSTACK_CONFIG_URL$",
"^RUDDERTYPER_TOKEN$",
),
script_hosts=("cdn.rudderlabs.com",),
npm=(
"@rudderstack/analytics-js",
"@rudderstack/rudder-sdk-node",
"rudder-sdk-js",
"@rudderstack/rudder-sdk-react-native",
"@rudderstack/analytics-js-service-worker",
"@rudderstack/analytics-js-cookies",
"@rudderstack/ai",
"gatsby-plugin-rudderstack",
"rudder-typer",
"rudder-sdk-cordova",
"rudder-integration-appcenter-cordova",
"rudder-integration-appsflyer-cordova",
"rudder-integration-singular-cordova",
"@rudderstack/rudder-plugin-db-encryption-react-native",
"@capgo/capacitor-rudderstack",
"@rudderstack/rudder-integration-amplitude-react-native",
"@rudderstack/rudder-integration-appcenter-react-native",
"@rudderstack/rudder-integration-appsflyer-react-native",
"@rudderstack/rudder-integration-braze-react-native",
"@rudderstack/rudder-integration-clevertap-react-native",
"@rudderstack/rudder-integration-facebook-react-native",
"@rudderstack/rudder-integration-firebase-react-native",
"@rudderstack/rudder-integration-moengage-react-native",
"@rudderstack/rudder-integration-singular-react-native",
"@rudderstack/rudder-integration-sprig-react-native",
),
pypi=(
"rudder-sdk-python",
"rudderstack-ai",
"profiles-rudderstack",
"profiles-pycorelib",
"profiles-mlcorelib",
"rudderstack-airflow-provider",
"dagster-rudderstack",
),
cargo=("rudderanalytics",),
cocoapods=(
"Rudder",
"RudderStack",
"RudderAdjust",
"RudderAmplitude",
"RudderAppCenter",
"RudderAppsFlyer",
"RudderBranch",
"RudderBraze",
"RudderBugsnag",
"RudderFacebookAppEvents",
"RudderFirebase",
"RudderIntercom",
"RudderKochava",
"RudderMoEngage",
"RudderSingular",
"RudderOneTrustConsentFilter",
"RudderDatabaseEncryption",
"Rudder-Adjust",
"Rudder-Adobe",
"Rudder-Amplitude",
"Rudder-AppCenter",
"Rudder-Appsflyer",
"Rudder-Branch",
"Rudder-Braze",
"Rudder-Bugsnag",
"Rudder-CleverTap",
"Rudder-Comscore",
"Rudder-CustomerIO",
"Rudder-Facebook",
"Rudder-Firebase",
"Rudder-FullStory",
"Rudder-GA4",
"Rudder-Intercom",
"Rudder-Kochava",
"Rudder-Leanplum",
"Rudder-Lotame",
"Rudder-Moengage",
"Rudder-Optimizely",
"Rudder-Qualtrics",
"Rudder-Singular",
"Rudder-Sprig",
),
composer=("rudderstack/rudder-php-sdk", "rudderstack/rudder-sdk-php"),
go=("github.com/rudderlabs/analytics-go",),
maven=(
"com.rudderstack.android.sdk:core",
"com.rudderstack.sdk.java.analytics:analytics",
"com.rudderstack.sdk.java:rudderanalytics-client",
"com.rudderstack.sdk.kotlin:android",
"com.rudderstack.sdk.kotlin:core",
"com.rudderstack.android.sdk:core-mpx",
"com.rudderstack.android.consentfilter:onetrustconsentfilter",
"com.rudderstack.android.amplitude:amplitude",
"com.rudderstack.android.snowplow:adapter",
"com.rudderstack.android.integration:adjust",
"com.rudderstack.android.integration:adobe",
"com.rudderstack.android.integration:amplitude",
"com.rudderstack.android.integration:appcenter",
"com.rudderstack.android.integration:appsflyer",
"com.rudderstack.android.integration:branch",
"com.rudderstack.android.integration:braze",
"com.rudderstack.android.integration:bugsnag",
"com.rudderstack.android.integration:clevertap",
"com.rudderstack.android.integration:comscore",
"com.rudderstack.android.integration:customerio",
"com.rudderstack.android.integration:facebook",
"com.rudderstack.android.integration:firebase",
"com.rudderstack.android.integration:fullstory",
"com.rudderstack.android.integration:ga4",
"com.rudderstack.android.integration:intercom",
"com.rudderstack.android.integration:kochava",
"com.rudderstack.android.integration:leanplum",
"com.rudderstack.android.integration:lotame",
"com.rudderstack.android.integration:moengage",
"com.rudderstack.android.integration:optimizely",
"com.rudderstack.android.integration:qualtrics",
"com.rudderstack.android.integration:singular",
"com.rudderstack.android.integration:sprig",
"com.rudderstack.integration.kotlin:adjust",
"com.rudderstack.integration.kotlin:appsflyer",
"com.rudderstack.integration.kotlin:braze",
"com.rudderstack.integration.kotlin:clevertap",
"com.rudderstack.integration.kotlin:facebook",
"com.rudderstack.integration.kotlin:firebase",
"com.rudderstack.integration.kotlin:sprig",
),
pub=(
"rudder_sdk_flutter",
"rudder_integration_adjust_flutter",
"rudder_integration_amplitude_flutter",
"rudder_integration_appcenter_flutter",
"rudder_integration_appsflyer_flutter",
"rudder_integration_braze_flutter",
"rudder_integration_firebase_flutter",
"rudder_integration_kochava_flutter",
"rudder_integration_leanplum_flutter",
"rudder_plugin_db_encryption",
),
rubygems=("rudder-sdk-ruby", "rudder_analytics_sync"),
swiftpm=(
"github.com/rudderlabs/rudder-sdk-ios",
"github.com/rudderlabs/rudder-sdk-swift",
"github.com/rudderlabs/integration-swift-adjust",
"github.com/rudderlabs/integration-swift-appsflyer",
"github.com/rudderlabs/integration-swift-braze",
"github.com/rudderlabs/integration-swift-clevertap",
"github.com/rudderlabs/integration-swift-facebook",
"github.com/rudderlabs/integration-swift-firebase",
"github.com/rudderlabs/integration-swift-sprig",
"github.com/rudderlabs/rudder-integration-adjust-ios",
"github.com/rudderlabs/rudder-integration-adjust-swift",
"github.com/rudderlabs/rudder-integration-appcenter-swift",
"github.com/rudderlabs/rudder-integration-appsflyer-ios",
"github.com/rudderlabs/rudder-integration-appsflyer-swift",
"github.com/rudderlabs/rudder-integration-branch-swift",
"github.com/rudderlabs/rudder-integration-braze-ios",
"github.com/rudderlabs/rudder-integration-braze-swift",
"github.com/rudderlabs/rudder-integration-bugsnag-swift",
"github.com/rudderlabs/rudder-integration-clevertap-ios",
"github.com/rudderlabs/rudder-integration-customerio-ios",
"github.com/rudderlabs/rudder-integration-facebook-app-events-swift",
"github.com/rudderlabs/rudder-integration-firebase-ios",
"github.com/rudderlabs/rudder-integration-firebase-swift",
"github.com/rudderlabs/rudder-integration-singular-swift",
"github.com/rudderlabs/rudder-integration-sprig-ios",
),
alternative_to=(ProductKey.PIPELINE_DESTINATIONS,),
)
lists_tables_without_credentials = True
supported_versions = ("v2",)
default_version = "v2"
api_docs_url = "https://www.rudderstack.com/docs/api/"
@property
def source_type(self) -> ExternalDataSourceType:
return ExternalDataSourceType.RUDDERSTACK
@property
def get_source_config(self) -> SourceConfig:
return SourceConfig(
name=ExternalDataSourceType.RUDDERSTACK,
category=DataWarehouseSourceCategory.ANALYTICS,
label="RudderStack",
docsUrl="https://posthog.com/docs/cdp/sources/rudderstack",
iconPath="/static/services/rudderstack.png",
keywords=["cdp", "customer data platform", "event streaming"],
releaseStatus=ReleaseStatus.BETA,
fields=cast(
list[FieldType],
[
SourceFieldInputConfig(
name="access_token",
label="Workspace access token",
type=SourceFieldInputConfigType.PASSWORD,
required=True,
secret=True,
placeholder="",
caption="Use a workspace Service Access Token with read access to the selected resources. "
"A Personal Access Token also works.",
),
SourceFieldInputConfig(
name="organization_access_token",
label="Organization access token",
type=SourceFieldInputConfigType.PASSWORD,
required=False,
secret=True,
placeholder="",
caption="Optional. Audit logs require an organization Service Access Token and the RudderStack Enterprise plan.",
),
SourceFieldSelectConfig(
name="region",
label="Region",
required=True,
defaultValue="us",
options=[
SourceFieldSelectConfigOption(label="US", value="us"),
SourceFieldSelectConfigOption(label="EU", value="eu"),
],
),
],
),
)
def get_non_retryable_errors(self) -> dict[str, str | None]:
return {
"401 Client Error": "RudderStack rejected the access token. Replace the invalid or expired token.",
"403 Client Error": "RudderStack denied access to this table. Check the token permissions and account plan.",
"Add an organization Service Access Token": "Add an organization Service Access Token to sync audit logs.",
"RudderStack catalog exceeds": "The catalog exceeds the RudderStack 50-page API limit. Contact RudderStack support.",
}
def get_canonical_descriptions(self) -> CanonicalDescriptions:
return CANONICAL_DESCRIPTIONS
def get_schemas(
self,
config: RudderStackSourceConfig,
team_id: int,
with_counts: bool = False,
names: list[str] | None = None,
force_refresh: bool = False,
api_version: str | None = None,
) -> list[SourceSchema]:
return build_endpoint_schemas(
ENDPOINTS,
{},
names,
descriptions={name: description["description"] for name, description in CANONICAL_DESCRIPTIONS.items()},
should_sync_default={"audit_logs": False, "retl_connections": False, "retl_syncs": False},
)
def get_endpoint_permissions(
self,
config: RudderStackSourceConfig,
team_id: int,
endpoints: list[str],
api_version: str | None = None,
) -> dict[str, str | None]:
return {
name: "Add an organization Service Access Token to sync audit logs."
if name == "audit_logs" and not config.organization_access_token
else None
for name in endpoints
}
def validate_credentials(
self,
config: RudderStackSourceConfig,
team_id: int,
schema_name: str | None = None,
api_version: str | None = None,
) -> tuple[bool, str | None]:
if config.region not in BASE_URLS:
return False, "Select the US or EU region for your RudderStack account."
if schema_name is not None and schema_name not in ENDPOINTS:
return False, "This RudderStack table is not supported."
try:
token = token_for_endpoint(config, schema_name)
if not token or not token.isascii() or any(character.isspace() for character in token):
return False, "Enter a valid RudderStack access token without spaces."
status = probe_credentials(config, schema_name, self.resolve_api_version(api_version))
except ValueError as error:
return False, str(error)
except RequestException:
return False, "Could not connect to RudderStack. Try again."
if status == 200 or (status == 403 and schema_name is None):
return True, None
if status == 401:
return False, "RudderStack rejected the access token. Replace the invalid or expired token."
if status == 403:
return False, "RudderStack denied access to this table. Check the token permissions and account plan."
return False, f"RudderStack returned HTTP {status}. Try again."
def get_resumable_source_manager(self, inputs: SourceInputs) -> ResumableSourceManager[RudderStackResumeConfig]:
return ResumableSourceManager(inputs, RudderStackResumeConfig)
def source_for_pipeline(
self,
config: RudderStackSourceConfig,
resumable_source_manager: ResumableSourceManager[RudderStackResumeConfig],
inputs: SourceInputs,
) -> SourceResponse:
return rudderstack_source(
config, inputs, resumable_source_manager, self.resolve_api_version(inputs.api_version)
)