Google Pub/Sub Connector | OpenMetadata Messaging Integration

• Requirements
• Metadata Ingestion
• Troubleshooting

​

Requirements

​

Metadata Ingestion

​

Schema Registry (when schemaRegistryEnabled is true)

{
  "bindings": [
    {
      "role": "roles/pubsub.viewer",
      "members": [
        "serviceAccount:<your-service-account>@<project-id>.iam.gserviceaccount.com"
      ]
    }
  ]
}

​

Metadata Ingestion

​

Step 1: Add New Service

1. Navigate to Settings > Services.
2. Click Add New Service.

​

Step 2: Select a Service and Connector

​

Step 3: Add Service Name and Description

• Enter a unique, descriptive Service Name. OpenMetadata identifies services by their service name. Enter a name that distinguishes this deployment from other Pub/Sub services you are ingesting metadata from.
• Optional: Enter a Description for the service.

​

Step 4: Configure Connection Options

​

Enter Connection Details

• GCP Credentials: GCP service account credentials for authenticating with Pub/Sub. Provide a service account key in JSON format, or use Application Default Credentials when running on GCP infrastructure (GCE, GKE, Cloud Run). See Creating a GCP Service Account for details.
• Project ID (optional): GCP Project ID where Pub/Sub topics are located. If not specified, the project ID is read from the service account credentials.
• Host and Port (optional): Pub/Sub API endpoint URL. Defaults to pubsub.googleapis.com. When connecting to a local Pub/Sub emulator, set this to the emulator address (for example, localhost:8085) and enable Use Emulator.
• Use Emulator (optional): Connect to a local Pub/Sub emulator instead of the production service. Useful for development and testing. When enabled, hostPort must be set to the emulator address (not the default pubsub.googleapis.com).
• Enable Schema Registry (optional, default: true): Fetch topic schemas from the Pub/Sub Schema Registry. Supports Avro and Protocol Buffer schema types. Disable if your project does not use the Schema Registry.
• Include Subscriptions (optional, default: true): Include subscription metadata for each topic. When enabled, subscription names, acknowledgment deadlines, retention durations, push endpoints, dead letter policies, and BigQuery export configurations are captured.

• Include Dead Letter Topics (optional, default: false): Include dead letter topics in metadata extraction. By default, dead letter topics are detected via subscription policies and excluded to keep the topic list focused on primary business topics.
• Topic Filter Pattern (optional): Regex pattern to selectively include or exclude topics by name. Use includes for an allow-list and excludes for a deny-list. Example: exclude internal topics with excludes: ["^_.*"].

​

Test Connection

​

Step 5: Configure Ingestion Options

​

How Filter Patterns Work

• Include: Add one or more comma-separated regular expressions. OpenMetadata ingests only topics whose names match at least one expression. Leave blank to include all topics.
• Exclude: Add one or more comma-separated regular expressions. OpenMetadata skips any topic whose name matches an expression. Leave blank to exclude nothing.

• contains: matches any name containing the value. For example, orders matches my_orders_topic and orders_2024.
• starts with: matches names beginning with the value. For example, prod_ matches prod_events and prod_orders.
• ends with: matches names ending with the value. For example, _raw matches events_raw and logs_raw.
• is exactly: matches the exact name only. For example, analytics matches only analytics.
• matches regex: matches names using a regular expression. For example, ^prod_.*_v\d+$ matches prod_events_v1.

• Topic: Controls which topics OpenMetadata ingests from the source.
• Scan Mode: Choose between Scan all (default) or Only specific to enable include rules.
• Always exclude: Add permanent exclusion rules. Topics matching these rules are never ingested, regardless of include rules.
• Preview: Shows a real-time summary of what will be in scope based on your current rules.
• Include rules (available only in Only specific mode): Click + Add to define a rule.

​

Step 6: Create & Deploy

​

Configure Metadata Agent and Schedule Ingestion

1. Navigate to Settings > Services and select the service type.
2. Click the service you have added.
3. Select the Agents tab and click Add Agent > Metadata. For some services, the dropdown is not available and clicking Add Agent takes you directly to the agent configuration page.
4. On the Configure Ingestion page, do the following and click Next.
   • Name this Ingestion: Enter a unique recognizable name for this ingestion pipeline.
   • Agent Setup: Configure the core parameters for this agent. The following fields are available:

     Field	Default	Description
     Generate Sample Data	Off	Option to turn on/off generating sample data during metadata extraction.
     Mark Deleted Topics	On	Soft-delete topics in OpenMetadata when they are removed from the source. Associated entities like sample data and lineage are also deleted.

     
   • Filter Patterns: Apply include or exclude rules to scope which topics this agent ingests. These follow the same filter options described in Step 5: Configure Ingestion Options.
   • Scope & Behaviour: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs:

     Toggle	Default	Description
     Enable Debug Log	Off	Sets the ingestion log level to DEBUG. Useful for troubleshooting.
     Override Metadata	Off	When on, source values overwrite existing descriptions, tags, owners, and display names in OpenMetadata. When off, OpenMetadata only updates fields that have no existing value.

     
5. On the Schedule Interval page, set when the agent runs:
   • Schedule: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   • On-Demand: No automatic schedule; trigger the agent manually when needed.
   
6. Click Add to deploy the agent.

​

Related