Skip to main content

F5 TEEM Library

Project description

Introduction

Python library providing an interface for F5's TEEM infrastructure to provide usage analytics to F5.

Usage (Anonymous API)

from f5teem import AnonymousDeviceClient

client_info = {
    'name': 'f5-example-product',
    'version': '1.0.0',
    'id': '<asset UUID>'
}
telemetry_client = AnonymousDeviceClient(client_info, api_key='<API KEY>')
telemetry_client.report(
    {
        'foo': 'bar'
    },
    telemetry_type='Installation Usage',
    telemetry_type_version='1'
)

By default, this library will include in the report telemetry client properties including:

  • The type of Operating System where telemetry is sent from (for example, 'Linux')

Example Telemetry Record

{
    "digitalAssetName": "f5-example-product",
    "digitalAssetVersion": "1.0.0",
    "digitalAssetId": "<asset UUID>",
    "documentType": "Installation Usage",
    "documentVersion": "1",
    "observationStartTime": "",
    "observationEndTime": "",
    "epochTime": "",
    "telemetryId": "",
    "telemetryRecords": [
        {
            "foo": "bar",
            "telemetryClientProperties": {
                "os": "linux"
            }
        }
    ]
}

Use TEEM staging environment

  • Set environment variable
    export TEEM_API_ENVIRONMENT='staging'
    

Additional Notes

Future Improvements

  • f5-teem-python should support Reg Key API when running on BIG-IP (similar to node based f5-teem library)
  • f5-teem-python should honor the phone home setting when running on BIG-IP. tmsh modify sys software update auto-phonehome disabled

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

f5-teem-1.0.2.tar.gz (4.9 kB view hashes)

Uploaded source

Built Distribution

f5_teem-1.0.2-py3-none-any.whl (10.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page