Package: auklet
Auklet for PythonThis is the official Python agent forAuklet. It officially supports Python 2.7.9+ and 3.4-3.7, and runs on most POSIX-based operating systems (Debian, Ubuntu Core, Raspbian, QNX, etc).FeaturesAutomatic report of unhandled exceptionsAutomatic Function performance issue reportingLocation, system architecture, and system metrics identification for all issuesAbility to define data usage restrictionComplianceAuklet is an edge first application performance monitor; therefore, starting with version 1.0.0 we maintain the following compliance levels:Automotive Safety Integrity Level B (ASIL B)If there are additional compliances that your industry requires please contact the team athello@auklet.io.QuickstartTo install the agent withpip:pipinstallaukletTo setup Auklet monitoring in your application:fromauklet.monitoringimportMonitoringauklet_monitoring=Monitoring(api_key="<API_KEY>",app_id="<APP_ID>",release="<CURRENT_COMMIT_HASH>")auklet_monitoring.start()# Call your main functionmain()auklet_monitoring.stop()AuthorizationTo authorize your application you need to provide both an API key and app ID. These values are available in the connection settings of your application as well as during initial setup.Optional: Release TrackingYou can track releases and identify which devices are running what variant of code. To do this, you may provide the git commit hash of your deployed code and a version string you can modify. This release value should be passed into the constructor through the release argument, and your custom version should be passed via the version argument. The release value must be the git commit hash that represents the deployed version of your application. The version value is a string that you may set to whatever value you wish to define your versions. Please note that you can provide either a release value, version value, or both.Providingreleaseenables code snippets to be shown for identified errors if you’ve linked your GitHub.Includingversionallows you to track what version of code had the issue.curl-XPOSThttps://api.auklet.io/v1/releases/\-H"Content-Type: application/json"\-H"Authorization: JWT <API_KEY>"\-d'{"application": "<APP_ID>", "release": "'$(gitrev-parseHEAD)'", "version": "<YOUR_DEFINED_VERSION>"}'Get Release via SubprocessIf you package and deploy your entire Git repository (including the.gitdirectory), and if you havegitinstalled on your devices, you can get the commit hash via a subprocess:git_commit_hash=subprocess.check_output(['git','rev-parse','HEAD']).decode('utf8').strip('\n')Get Release via Environment VariableIf you package your app and deploy it without access togit, you can pass the commit hash to your app using the environment variableAPPLICATION_GIT_COMMIT_HASH:git_commit_hash=os.environ.get("APPLICATION_GIT_COMMIT_HASH")Get Release via FileLastly, if it is difficult or impossible to set an environment variable via your deployment platform, you can include a new file in your packaged deployment which contains the commit hash. You can read from this file and supply the value to the constructor.At packaging time, write the commit hash to a file and then include it in your package:gitrev-parseHEAD>path/to/git_commit_hash.txtAt runtime, read the included file as follows:release_file=open("git_commit_hash.txt","r")git_commit_hash=release_file.read().decode('utf8').strip('\n')Define Your Own VersionYou can also provide your own version string in the constructor:fromauklet.monitoringimportMonitoringauklet_monitoring=Monitoring(api_key="<API_KEY>",app_id="<APP_ID>",release="<CURRENT_COMMIT_HASH>",version="<DEFINED_VERSION>")ResourcesAukletPython DocumentationIssue Tracker