Python Airflow custom sensor - which methods to implement

Question

I'm trying to write a custom sensor that inherits BaseSensorOperator and SSHOperator. in the sensor body I override poke and execute method.

  class mysensor (BaseSensorOperator,SSHOperator):
      template_fields = ("my_param")
      def __init__ (
          self,
          my_param = None,
          *args,
          **kawags):
      self.my_param = my_param
      super().__init__(
          command = "some bash command",
          ssh_conn_id = "some connection"
          *args,
          **kwargs)

def poke(self, context):
    ... (implemented poke)
def execute():
    ...(implemented execute)

Elad Kalif · Accepted Answer · 2022-08-26 20:34:04Z

2

Custom sensors are required to implement only the poke function. You should not override the execute function (unless you really know what you are doing). The execute function is implemented in BaseSensorOperator and that is what gives sensors their capabilities.

In your case you should not use SSHOperator, you should use SSHHook directly.

Your Sensor should look like:

from airflow.providers.ssh.hooks.ssh import SSHHook

class Mysensor(BaseSensorOperator):
    ...

    def poke(self,context):
      hook = SSHHook(...)
      # add your sensor logic here

edited Aug 26, 2022 at 20:34

answered Aug 26, 2022 at 20:28

Elad Kalif

16.4k3 gold badges29 silver badges63 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Python Airflow custom sensor - which methods to implement

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related