Skip to main content

a package for sending app telemetry data to the TelemetrX backend.

Project description

telemetrx-0.1.3

telemetrx is a Python library which facilitates the sending of App telemetry data to the TelemetrX platform, leveraging the TelemetrX API.

Features

The library features the function send_telemetrx() which helps app owners to send telemetry data to the TelemetrX platform with a single line of code.

Installation

Install telemetrx with pip:

pip install telemetrx

Quick Start

Before you start, there are few environment variables that will need to be set:

  • BASE_URL_ENV = Telemetrx API URL for ENV

    Where ENV is either DEV, PROD or STAGE depending on which environment your app is sending data to. If you are unsure what value to set in this environment variable, please contact visimard@cisco.com or vivekksi@cisco.com or anpapath@cisco.com.

  • TELEMETRX_API_KEY = <Your app's API key for TelemetrX>

    This is the app token you have received when registering your app with TelemetrX. If you do not know your app key or have lost/forgotten it, please contact visimard@cisco.com or vivekksi@cisco.com or anpapath@cisco.com

After you make sure that the environment variables above are set, here is an example of how to use the telemetrx library:

from telemetrx import send_telemetrx

telemetry_data = {"attribute1": "value",
                  "attribute2": "value"}

send_telemetrx(telemetry_data=telemetry_data, 
               user="anpapath",
               app_name= "My app",
               telemetrx_env= "prod",
               technology_stripe= "Enterprise"
               )

Requirements

  • Python 3.10+

License

Distributed under a propriatery license. See LICENSE file for more information.

Authors

  • Vivek Singh - vivekksi
  • Vincent Simard - visimard
  • Angeliki Papathanasiou - anpapath

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

telemetrx-0.1.4.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

telemetrx-0.1.4-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file telemetrx-0.1.4.tar.gz.

File metadata

  • Download URL: telemetrx-0.1.4.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.0

File hashes

Hashes for telemetrx-0.1.4.tar.gz
Algorithm Hash digest
SHA256 3aa50185b4344e451757a6fbf0a17177682233de69e2fc9d400da0ae7ca6ca99
MD5 b3f753ea7ea4ecd621d36d8d52fed6bc
BLAKE2b-256 934ff608086cf8c762403ffc769826e3db1918868ff824fb6c9775a5c846aef6

See more details on using hashes here.

File details

Details for the file telemetrx-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: telemetrx-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.0

File hashes

Hashes for telemetrx-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 dfc3c92372585d577937d531c0f382ceeebc0435cfb74cdd6b6959b38bba2d70
MD5 d65a216caeb5b6212edf8016016ce684
BLAKE2b-256 6c43919236419b5353b32ee0a4fe0586c66ce3f0e066b163738568eea7eed5cc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page