signalflow-client-python 1.3.0

No project description provided

signalflow-client-python

---

Table of Contents

• Installation
• Run a SignalFlow computation
• License

Installation

To install the SignalFlow Python client library, open a terminal and run the following command:

pip install signalflow-client-python

Run a SignalFlow computation

The following example allows you run a SignalFlow computation from the command line. For additional examples, see the examples directory.

1. Install the signalfx package:

   pip install signalfx
   

2. Create a .py file that includes the following content:

   #!/usr/bin/env python
   
   import argparse
   import signalfx  # noqa
   from signalfx.signalflow import messages, SignalFlowClient  # noqa
   
   
   if __name__ == "__main__":
       parser = argparse.ArgumentParser(
           description="SignalFx SignalFlow streaming analytics demo"
       )
       parser.add_argument(
           "--stream-endpoint",
           help="SignalFx SignalFlow stream API endpoint",
           default="https://stream.signalfx.com",
       )
       parser.add_argument("token", help="Your SignalFx API access token")
       parser.add_argument("program", help="SignalFlow program to execute")
       options = parser.parse_args()
   
       client = SignalFlowClient(
           token=options.token,
           endpoint=options.stream_endpoint,
       )
   
       try:
           # Execute the computation and iterate over the message stream
           print("Requesting computation: {0}".format(options.program))
           c = client.execute(options.program)
           print("Waiting for data...")
           for msg in c.stream():
               if isinstance(msg, messages.DataMessage):
                   print(
                       "\033[34;1m{0}\033[;0m @{1}: {2}".format(
                           "data",
                           msg.logical_timestamp_ms,
                           ", ".join(
                               [
                                   "\033[;1m{0}\033[;0m: {1}".format(k, v)
                                   for k, v in msg.data.items()
                               ]
                           ),
                       )
                   )
               elif isinstance(msg, messages.EventMessage):
                   print(
                       "\033[35;1m{0}\033[34;1m@\033[;0m @{1}: {2}".format(
                           "event",
                           msg.timestamp_ms,
                           ", ".join(
                               [
                                   "\033[;1m{0}\033[;0m: {1}".format(k, v)
                                   for k, v in msg.properties.items()
                               ]
                           ),
                       )
                   )
               elif isinstance(msg, messages.MetadataMessage):
                   print(
                       "\033[32;1m{0}\033[;0m for \033[;1m{1}\033[;0m:\n  {2}".format(
                           "metadata",
                           msg.tsid,
                           "\n  ".join(
                               [
                                   "\033[;1m{0}\033[;0m: {1}".format(k, v)
                                   for k, v in msg.properties.items()
                               ]
                           ),
                       )
                   )
       except KeyboardInterrupt:
           print(" Detaching from computation...")
       finally:
           client.close()
       print("Done.")
   

3. Run the Python script, specifying values for the streaming endpoint (optional), the API access token, and the SignalFlow program.

   For example:

   python <file-name>.py --stream-endpoint https://stream.us0.signalfx.com <api-token> "data('sf.org.num.orguser').publish()"
   

License

signalflow-client-python is distributed under the terms of the Apache-2.0 license.