Skip to main content

Pub/Sub Controller

Description

Fetch the Subscription of the GCP Pub/Sub regularly, and if there is a message execute the script specified by the key in the message.

GCP Pub/SubのSubscriptionを定期的にFetchし、 メッセージがあればメッセージ内のキーで指定されたスクリプトを実行する。

Installation and Try to this sample.

  1. Create Pub/Sub topic and subscription on GCP. (ex: test-topic/test-sub)

  2. pip install pubsub_controller

  3. pubsubcontroller init and input your Pub/Sub setting. (ex: GCP_PROJECT_ID=your project id / SUBSCRIPTION_ID=test-sub)

  4. pubsubcontroller subscribe

  5. Subscriber will start immediately.

  6. Open Another Terminal Window.

  7. pubsubcontroller publish test-topic test-message '{"target":"exec_sample","text":"test_text"}'

  8. In the Subscriber’s window you will see the contents of the message you just published!

Installation and Try to this sample.

  1. Create a new python file under “exec_classes” directory.

    • The same Python filename as the name specified by the attribute “target” key of the message to be published is executed.

  2. Implement def main (message_data, message_attr) and describe what you want to do after receiving the message.

    • “message_data” contains the contents of the received message.

    • “message_attr” contains optional attributes of the received message.

Details

  • Settings pubsub_controller/settings.py Required parameters are set here. (It is set automatically by the pubsubcontroller init command)

    • GCP PROJECT ID Your GCP ProjectID

    • SUBSCRIPTION ID Enter the Subscription ID to be used. If the Subscription name is projects/hoge-project/subscriptions/fuga, please enter fuga.

    • Interval Second Enter the interval to fetch Subscription in seconds.

  • Subscriber If you need a new subscriber, please refer to apps/subscriber/pull/exec_classes/exec_sample.py and create it.

  • Pull Subscriber This is a resident process that pulls Subscription.

    • config For reference, I am creating a supervisor config file. apps/subscriber/pull/config/pull_subscriber.ini

  • Publisher Execute from the CLI or Python script and publish the message to the topic.

    • Exec on CommandLine

      • pubsubcontroller publish test test-message '{"target":"exec_sample","text":"test_text"}'

      • arguments

        • arg1 = topic name

        • arg2 = message data

        • arg3 = message attribute(json format)

    • Exec on PythonCode

      from apps.publisher.publish_message import publish
      
      publish('test-topic', 'test_data', {'target':'exec_sample','text':'test_text'})

Metadata

Release files for pubsub-controller 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pubsub-controller 1.0.1
File Size Uploaded
pubsub_controller-1.0.1.tar.gz 6.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pubsub-controller 1.0.1
File Interpreter ABI Platform
pubsub_controller-1.0.1-py2-none-any.whl Python 2 none any Details

Total release size: 20.7 kB

Release files / pubsub_controller-1.0.1.tar.gz

Download URL pubsub_controller-1.0.1.tar.gz
Size 6.6 kB
Tags Source
SHA-256 checksum
How to use checksums
bb26c4b0b875fea102818ad80c0e98ed48618629f7ab833f14002823fad09648
BLAKE2b-256 checksum
How to use checksums
af50e322aa066c67425ef26ecc63e94e8c65b53dcd186f4678eb99089f518f5f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / pubsub_controller-1.0.1-py2-none-any.whl

Download URL pubsub_controller-1.0.1-py2-none-any.whl
Size 14.1 kB
Tags Python 2
SHA-256 checksum
How to use checksums
c9f182deb3a6862335110053db42ba21fccd8f316c15bc3f7d1d183bc2b24d0c
BLAKE2b-256 checksum
How to use checksums
bb9704192c62e7184a99b79bce141e09aae8b74421095d3e512416751ec30308
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

3 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page