README.md

signalflow-client-python

---

Table of Contents

• Installation
• Run a SignalFlow computation
• License

SignalFlow is the SignalFx real-time analytics computation language. The SignalFlow API allows SignalFx users to execute real-time streaming analytics computations on the SignalFx platform. For more information, see the Splunk Observability Cloud developer documentation:

• SignalFlow Overview
• SignalFlow API Reference

The SignalFlow Python library is a client that opens a connection to SignalFx, allowing you to execute SignalFlow programs against the back end and then stream data back to the client.

The following SignalFlow program returns the current number of users in your organization:

data('sf.org.num.orguser').publish()

Tip

The SignalFx UI uses the SignalFlow language to produce charts, graphs, and alerts. You can reuse SignalFlow programs from the UI in the code that you write using the SignalFlow Python client library.

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 signalflow-client-python package:

   pip install signalflow-client-python

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

#!/usr/bin/env python

import argparse

from signalfx.signalflow import SignalFlowClient


def 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():
            print(f"Message: {msg}")
    except KeyboardInterrupt:
        print("Detaching from computation...")
    finally:
        client.close()
    print("Done.")


if __name__ == "__main__":
    main()

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.