: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 Optional, cast
from products.warehouse_sources.sources.firehydrant._config import FireHydrantSourceConfig
from products.warehouse_sources.sources.firehydrant.firehydrant import (
BASE_URLS,
FireHydrantResumeConfig,
firehydrant_source,
validate_credentials as validate_firehydrant_credentials,
)
from products.warehouse_sources.sources.firehydrant.settings import ENDPOINTS, FIREHYDRANT_ENDPOINTS, INCREMENTAL_FIELDS
from products.warehouse_sources.sources.sdk import (
CanonicalDescriptions,
DataWarehouseSourceCategory,
ExternalDataSourceType,
FieldType,
ReleaseStatus,
ResumableSource,
ResumableSourceManager,
SourceConfig,
SourceFieldInputConfig,
SourceFieldInputConfigType,
SourceFieldSelectConfig,
SourceFieldSelectConfigOption,
SourceInputs,
SourceRegistry,
SourceResponse,
SourceSchema,
detect,
)
@SourceRegistry.register
class FireHydrantSource(ResumableSource[FireHydrantSourceConfig, FireHydrantResumeConfig]):
codebase_detection = detect(
env=("^(FIRE_HYDRANT|FIREHYDRANT)_",), go=("github.com/firehydrant/firehydrant-go-sdk",)
)
supported_versions = ("v1",)
default_version = "v1"
api_docs_url = "https://docs.firehydrant.com/reference"
lists_tables_without_credentials = True # static endpoint catalog — safe for public docs
@property
def source_type(self) -> ExternalDataSourceType:
return ExternalDataSourceType.FIREHYDRANT
@property
def connection_host_fields(self) -> list[str]:
# `region` picks the host the stored API key is sent to. Retargeting it must re-require the
# secret so a preserved key can't be aimed at a different regional endpoint without re-entry.
return ["region"]
@property
def get_source_config(self) -> SourceConfig:
return SourceConfig(
name=ExternalDataSourceType.FIREHYDRANT,
category=DataWarehouseSourceCategory.ENGINEERING___MONITORING,
label="FireHydrant",
releaseStatus=ReleaseStatus.BETA,
caption="""Enter your FireHydrant API key to pull your incident management data into the PostHog Data warehouse.
You can create a bot token or personal API key in your [FireHydrant API keys settings](https://app.firehydrant.io/organizations/api_keys). Bot tokens are recommended for automation that isn't tied to a specific user.""",
iconPath="/static/services/firehydrant.png",
docsUrl="https://posthog.com/docs/cdp/sources/firehydrant",
fields=cast(
list[FieldType],
[
SourceFieldInputConfig(
name="api_key",
label="API key",
type=SourceFieldInputConfigType.PASSWORD,
required=True,
placeholder="",
secret=True,
),
SourceFieldSelectConfig(
name="region",
label="Region",
required=True,
defaultValue="us",
options=[
SourceFieldSelectConfigOption(label="US (api.firehydrant.io)", value="us"),
SourceFieldSelectConfigOption(label="EU (api.eu.firehydrant.io)", value="eu"),
],
),
],
),
)
def get_canonical_descriptions(self) -> CanonicalDescriptions:
from products.warehouse_sources.sources.firehydrant.canonical_descriptions import CANONICAL_DESCRIPTIONS
return CANONICAL_DESCRIPTIONS
def get_non_retryable_errors(self) -> dict[str, str | None]:
# 401/403 surface as a requests HTTPError when `_fetch_page` calls `raise_for_status()`.
# Retrying can never satisfy a credential problem, so stop the sync. Match the stable status
# text and base host, not the per-request path/query. Derive from BASE_URLS so a newly added
# region stays covered without updating two places.
unauthorized = "Your FireHydrant API key is invalid or has been revoked. Create a new API key in your FireHydrant settings, then reconnect."
forbidden = "Your FireHydrant API key is missing the permissions needed to sync this data. Grant the required permissions in your FireHydrant settings, then reconnect."
errors: dict[str, str | None] = {}
for base_url in BASE_URLS.values():
errors[f"401 Client Error: Unauthorized for url: {base_url}"] = unauthorized
errors[f"403 Client Error: Forbidden for url: {base_url}"] = forbidden
return errors
def get_schemas(
self,
config: FireHydrantSourceConfig,
team_id: int,
with_counts: bool = False,
names: list[str] | None = None,
force_refresh: bool = False,
api_version: str | None = None,
) -> list[SourceSchema]:
def _build_schema(endpoint: str) -> SourceSchema:
endpoint_config = FIREHYDRANT_ENDPOINTS[endpoint]
return SourceSchema(
name=endpoint,
# FireHydrant has no uniform server-side incremental cursor, so every endpoint is
# full refresh only.
supports_incremental=False,
supports_append=False,
incremental_fields=INCREMENTAL_FIELDS.get(endpoint, []),
should_sync_default=endpoint_config.should_sync_default,
detected_primary_keys=endpoint_config.primary_keys,
)
schemas = [_build_schema(endpoint) for endpoint in ENDPOINTS]
if names is not None:
names_set = set(names)
schemas = [s for s in schemas if s.name in names_set]
return schemas
def validate_credentials(
self,
config: FireHydrantSourceConfig,
team_id: int,
schema_name: Optional[str] = None,
api_version: str | None = None,
) -> tuple[bool, str | None]:
return validate_firehydrant_credentials(config.api_key, config.region)
def get_resumable_source_manager(self, inputs: SourceInputs) -> ResumableSourceManager[FireHydrantResumeConfig]:
return ResumableSourceManager[FireHydrantResumeConfig](inputs, FireHydrantResumeConfig)
def source_for_pipeline(
self,
config: FireHydrantSourceConfig,
resumable_source_manager: ResumableSourceManager[FireHydrantResumeConfig],
inputs: SourceInputs,
) -> SourceResponse:
return firehydrant_source(
api_key=config.api_key,
endpoint=inputs.schema_name,
team_id=inputs.team_id,
job_id=inputs.job_id,
resumable_source_manager=resumable_source_manager,
region=config.region,
)