Skip to content

: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.

4.4 KB
Raw Blame
from typing import Optional, cast

from products.warehouse_sources.sources.airops._config import AirOpsSourceConfig
from products.warehouse_sources.sources.airops.airops import (
    airops_source,
    validate_credentials as validate_airops_credentials,
)
from products.warehouse_sources.sources.airops.settings import ENDPOINTS, INCREMENTAL_FIELDS
from products.warehouse_sources.sources.sdk import (
    CanonicalDescriptions,
    DataWarehouseSourceCategory,
    ExternalDataSourceType,
    FieldType,
    ReleaseStatus,
    SimpleSource,
    SourceConfig,
    SourceFieldInputConfig,
    SourceFieldInputConfigType,
    SourceInputs,
    SourceRegistry,
    SourceResponse,
    SourceSchema,
    build_endpoint_schemas,
    detect,
)


@SourceRegistry.register
class AirOpsSource(SimpleSource[AirOpsSourceConfig]):
    codebase_detection = detect(env=("^(AIR_OPS|AIROPS)_",), npm=("@airops/airops-js",))

    lists_tables_without_credentials = True  # static endpoint catalog — safe for public docs
    api_docs_url = "https://docs.airops.com/api-reference"

    @property
    def source_type(self) -> ExternalDataSourceType:
        return ExternalDataSourceType.AIROPS

    @property
    def get_source_config(self) -> SourceConfig:
        return SourceConfig(
            name=ExternalDataSourceType.AIROPS,
            category=DataWarehouseSourceCategory.ENGINEERING___MONITORING,
            label="AirOps",
            releaseStatus=ReleaseStatus.GA,
            caption="""Enter your AirOps workspace API key to sync your AirOps apps and their executions into the PostHog Data warehouse.

You can create a workspace API key in your [AirOps workspace settings](https://app.airops.com). Regenerating the key immediately invalidates the previous one.""",
            iconPath="/static/services/airops.png",
            docsUrl="https://posthog.com/docs/cdp/sources/airops",
            fields=cast(
                list[FieldType],
                [
                    SourceFieldInputConfig(
                        name="api_key",
                        label="API key",
                        type=SourceFieldInputConfigType.PASSWORD,
                        required=True,
                        placeholder="",
                        secret=True,
                    ),
                ],
            ),
        )

    def get_canonical_descriptions(self) -> CanonicalDescriptions:
        from products.warehouse_sources.sources.airops.canonical_descriptions import CANONICAL_DESCRIPTIONS

        return CANONICAL_DESCRIPTIONS

    def get_non_retryable_errors(self) -> dict[str, str | None]:
        return {
            # A missing, invalid, or regenerated workspace key surfaces as a requests HTTPError once
            # `_fetch_json` calls `raise_for_status()`. No retry can fix a credential problem, so stop
            # the sync. Match the stable status text and base host, not the per-request path/query.
            "401 Client Error: Unauthorized for url: https://api.airops.com": "Your AirOps API key is invalid or has been regenerated. Create a new workspace API key in your AirOps settings, then reconnect.",
            "403 Client Error: Forbidden for url: https://api.airops.com": "Your AirOps API key does not have access to this data. Check the key's workspace permissions, then reconnect.",
        }

    def get_schemas(
        self,
        config: AirOpsSourceConfig,
        team_id: int,
        with_counts: bool = False,
        names: list[str] | None = None,
        force_refresh: bool = False,
        api_version: str | None = None,
    ) -> list[SourceSchema]:
        # AirOps has no server-side timestamp filter and executions mutate after creation, so every
        # table is full refresh only (no incremental / append support — INCREMENTAL_FIELDS is empty).
        return build_endpoint_schemas(ENDPOINTS, INCREMENTAL_FIELDS, names)

    def validate_credentials(
        self,
        config: AirOpsSourceConfig,
        team_id: int,
        schema_name: Optional[str] = None,
        api_version: str | None = None,
    ) -> tuple[bool, str | None]:
        if validate_airops_credentials(config.api_key):
            return True, None
        return False, "Invalid AirOps API key"

    def source_for_pipeline(self, config: AirOpsSourceConfig, inputs: SourceInputs) -> SourceResponse:
        return airops_source(
            api_key=config.api_key,
            endpoint=inputs.schema_name,
            team_id=inputs.team_id,
            job_id=inputs.job_id,
        )