Skip to main content

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

Project description

telemetrx-0.1.1

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.2.tar.gz (4.6 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: telemetrx-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 163348f7425a8d400ffecc5743504503ed581fc37db657f5fe01f80cf842d512
MD5 23dca3f5f081c60956c0e75b89641abf
BLAKE2b-256 f31fb5a260be752e6dc432b914fbdd5c2731fba68b111f27f121f9c072266ad8

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