> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Google Pub/Sub Connector | Collate Messaging Integration

> Connect Google Pub/Sub to Collate with our comprehensive connector guide. Set up topic metadata ingestion, schema extraction, and subscription tracking.

export const MetadataIngestionUi = ({connector, selectServicePath, addNewServicePath, serviceConnectionPath}) => {
  return <>
   <p>
      To ingest metadata from your sources, you need to create a service connection.
      The service connects your source system with Collate. Once you create
      a service, you can use it to configure your ingestion workflows.<br />
      <br />
      To create a service connection and ingest your metadata, follow the steps below:
  </p>
  <Steps>
    <Step title="Select the Service">
    <ol>
          <li>
            On the left navigation bar, click <strong>Settings</strong>.
          </li>
          <li>
            On the next page, click <strong>Services</strong>, and then select the service.
            <img src="/public/images/connectors/visit-services-page.png" alt="Visit Services Page" />
          </li>
    </ol>
   </Step>


   <Step title="Create a New Service">

       To add a new service connection, click <strong>Add New Service</strong>.
      <img src="/public/images/connectors/create-new-service.png" alt="Create a new Service" />


   </Step>


     <Step title="Select the Connector">
       Select <strong>{connector}</strong> as the service type and click <strong>Next</strong>.


       {selectServicePath && <img src={selectServicePath} alt="Select Service" />}
   </Step>


   <Step title="Name and Describe your Service">
       Enter a unique, descriptive <strong>Service Name</strong> and <strong>Description</strong>.
       <ul>
         <li><strong>Service Name</strong>: Collate identifies services by their service name. Enter a name that distinguishes this deployment from other services, including other {connector} services you are ingesting metadata from.</li>
       </ul>


       <Note>
           The service name cannot be changed after it is set.
       </Note>


       {addNewServicePath && <img src={addNewServicePath} alt="Add New Service" />}
   </Step>


   <Step title="Configure the Service Connection">
       Set up the connection settings required for {connector}. <br /><br />

       Configure the following connection options to set up the service and start ingesting metadata from your sources. The right-hand panel displays help documentation for the selected connection type in the product UI

       {serviceConnectionPath && <img src={serviceConnectionPath} alt="Configure Service connection" />}
   </Step>
   </Steps>
   </>;
};

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/pubsub.svg" name="Google Pub/Sub" stage="PROD" availableFeatures={["Topics"]} unavailableFeatures={["Sample Data"]} />

In this section, we provide guides and references to use the Google Pub/Sub connector.
Configure and schedule Google Pub/Sub metadata workflows from the Collate UI:

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
* [Troubleshooting](/connectors/messaging/pubsub/troubleshooting)

## Requirements

The Google Cloud service account used for ingestion needs the following identity and access management (IAM) permissions:

### Metadata Ingestion

| Permission                  | Purpose                                                                                                                          |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `pubsub.topics.list`        | List topics in the project                                                                                                       |
| `pubsub.topics.get`         | Read topic details; required per topic when fetching its subscriptions via `list_topic_subscriptions`                            |
| `pubsub.subscriptions.list` | Project-wide subscription list used for the dead letter topic scan                                                               |
| `pubsub.subscriptions.get`  | Read individual subscription details for every subscription returned for a topic, including subscriptions in a different project |

### Schema Registry

| Permission            | Purpose                                         |
| --------------------- | ----------------------------------------------- |
| `pubsub.schemas.list` | List schemas in the Schema Registry             |
| `pubsub.schemas.get`  | Read schema definitions (Avro, Protocol Buffer) |

The built-in Google Cloud Platform (GCP) role **`roles/pubsub.viewer`** grants all of the above permissions and is the recommended role for Collate ingestion.

## Metadata Ingestion

<MetadataIngestionUi connector={"PubSub"} selectServicePath={"/public/images/connectors/pubsub/select-pubsub.png"} addNewServicePath={"/public/images/connectors/pubsub/name-pubsub.png"} serviceConnectionPath={"/public/images/connectors/pubsub/connection-details-pubsub.png"} />

## Connection Details

<Steps>
  <Step title="Connection Details">
    * **GCP Credentials**: Google Cloud service account credentials used to authenticate with Pub/Sub. Provide a service account key JSON containing `type`, `projectId`, `privateKeyId`, `privateKey`, `clientEmail`, and `clientId`. For more information, see [Creating and managing service account keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys).
    * **Project ID** (optional if using inline GCP credentials): GCP Project ID where Pub/Sub topics are located. The project ID is only derived automatically when using inline service account credentials. If you're using a credentials file path, Application Default Credentials, an external account, or the Pub/Sub emulator, you must set this field explicitly, or ingestion fails with `Project ID is required`.
    * **Host and Port** (optional): Pub/Sub API endpoint. Defaults to `pubsub.googleapis.com`. Set to the emulator address (for example, `localhost:8085`) when using a local emulator.
    * **Use Emulator** (optional): Set to `true` to connect to a local [Pub/Sub emulator](https://cloud.google.com/pubsub/docs/emulator) instead of the production service.
    * **Schema Registry Enabled** (optional, default: `true`): Fetch topic schemas from the Pub/Sub Schema Registry. Supports Avro and Protocol Buffer schema types. Set to `false` if your project does not use the Schema Registry.
    * **Include Subscriptions** (optional, default: `true`): Fetch subscription details for each topic. Only subscription names are persisted to topic metadata; acknowledgment deadlines, retention durations, push endpoints, and dead letter policies are read but not stored. When a subscription has a BigQuery export configuration, Collate uses it to extract lineage from the Pub/Sub topic to the target BigQuery table, though the export configuration itself is not persisted.
    * **Include Dead Letter Topics** (optional, default: `false`): Include dead letter topics in metadata extraction. By default, dead letter topics are excluded to keep the topic list focused on primary business topics.
  </Step>

  <Step title="Test the Connection">
    Once the credentials have been added, click on *Test Connection* and *Save* the changes.

    <img src="https://mintcdn.com/collatedocs/L7psA65ao88vmcRI/public/images/connectors/test-connection.png?fit=max&auto=format&n=L7psA65ao88vmcRI&q=85&s=2133f0d65f18df1e57f69d2cc3bdeff4" alt="Test Connection" width="1494" height="310" data-path="public/images/connectors/test-connection.png" />
  </Step>

  <Step title=" Configure Metadata Ingestion">
    In this step we will configure the metadata ingestion pipeline,
    Please follow the instructions below

    <img src="https://mintcdn.com/collatedocs/12mtkhFtvTP7FUxZ/public/images/connectors/configure-metadata-ingestion-messaging.png?fit=max&auto=format&n=12mtkhFtvTP7FUxZ&q=85&s=e8338e77a5bd984998fca6b4094b7b87" alt="Configure Metadata Ingestion" width="1518" height="1164" data-path="public/images/connectors/configure-metadata-ingestion-messaging.png" />

    #### Metadata Ingestion Options

    * **Name**: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
    * **Topic Filter Pattern (Optional)**: Use it to control whether to include topics as part of metadata ingestion.
      * **Include**: Explicitly include topics by adding a list of comma-separated regular expressions to the 'Include' field. OpenMetadata will include all topics with names matching one or more of the supplied regular expressions. All other topics will be excluded.
      * **Exclude**: Explicitly exclude topics by adding a list of comma-separated regular expressions to the 'Exclude' field. OpenMetadata will exclude all topics with names matching one or more of the supplied regular expressions. All other topics will be included.
    * **Ingest Sample Data (toggle)**: Set the 'Ingest Sample Data' toggle to ingest sample data from the topics.
    * **Enable Debug Log (toggle)**: Set the 'Enable Debug Log' toggle to set the default log level to debug.
    * **Mark Deleted Topics (toggle):** Set the 'Mark Deleted Topics' toggle to flag topics as soft-deleted if they are not present anymore in the source system.
  </Step>

  <Step title="Schedule the Ingestion and Deploy">
    Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The
    timezone is in UTC. Select a Start Date to schedule for ingestion. It is
    optional to add an End Date.

    Review your configuration settings. If they match what you intended,
    click Deploy to create the service and schedule metadata ingestion.

    If something doesn't look right, click the Back button to return to the
    appropriate step and change the settings as needed.

    After configuring the workflow, you can click on Deploy to create the
    pipeline.

    <img src="https://mintcdn.com/collatedocs/piJyXg9wW6Ik1lg-/public/images/connectors/schedule.png?fit=max&auto=format&n=piJyXg9wW6Ik1lg-&q=85&s=f1add591824b44456f0e2ff259a21c6f" alt="Schedule the Workflow" width="2733" height="1083" data-path="public/images/connectors/schedule.png" />
  </Step>

  <Step title="View the Ingestion Pipeline">
    Once the workflow has been successfully deployed, you can view the
    Ingestion Pipeline running from the Service Page.

    <img src="https://mintcdn.com/collatedocs/cOe_QuHYxAbkMtTI/public/images/connectors/view-ingestion-pipeline.png?fit=max&auto=format&n=cOe_QuHYxAbkMtTI&q=85&s=8c754af74f99ee70e714f6f707b827e4" alt="View Ingestion Pipeline" width="2733" height="1271" data-path="public/images/connectors/view-ingestion-pipeline.png" />

    <Tip>
      If [AutoPilot](/how-to-guides/admin-guide/applications/autopilot) is enabled, workflows like usage tracking, data lineage, and similar tasks will be handled automatically. Users don’t need to set up or manage them - AutoPilot takes care of everything in the system.
    </Tip>
  </Step>
</Steps>

## Troubleshooting

<Columns cols={2}>
  <Card title="Google Pub/Sub Troubleshooting" href="/connectors/messaging/pubsub/troubleshooting">
    Learn more about how to troubleshoot common Google Pub/Sub connector issues and resolve authentication or ingestion errors.
  </Card>
</Columns>