rjenkinsjr / Auklet-Releaser-C

Official Auklet C/C++ Releaser Tool

Home Page:https://auklet.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Auklet for C

Maintainability

This is the C releaser for Auklet. It officially supports C and C++, and runs on most POSIX-based operating systems (Debian, Ubuntu Core, Raspbian, QNX, etc).

Features

  • Automatic crash reporting
  • Automatic function performance issue reporting
  • Location, system architecture, and system metrics identification for all issues
  • Ability to define data usage restrictions

Requirements

You will need a 64-bit (x86-64) Linux machine to run the Auklet releaser. Also, to successfully run the releaser, you'll need to have created an application on the Auklet Website.

Prerequisites

Before an application can send data to Auklet, it needs to be integrated with the Auklet library, libauklet.a. See the README for the Auklet Agent for integration instructions.

Quickstart

Getting Started

  1. Follow the C/C++ Agent Quickstart Guide to integrate the C/C++ agent.

  2. Set the following environment variables in the environment from which you will be creating releases (CI environment, build server, local system, etc):

    • AUKLET_APP_ID
    • AUKLET_API_KEY
  3. Add the following commands to your build/CI environment:

     curl https://s3.amazonaws.com/auklet/releaser/latest/auklet-releaser-linux-amd64-latest > release
     chmod +x release
    
  4. If you do not already have a debug version of your application, you'll need to create a -dbg file. Application-dbg does not need to actually contain debug info.

     cp <InsertYourApplication>{,-dbg}
    
  5. Then you can create a release.

     release <InsertYourApplication>
    

Your code is almost ready to be analyzed by Auklet! Check out the README on the Auklet Client's repository for instructions of how to run your application with Auklet.

Advanced Settings

Releasing a Stripped Application

If you want to release a stripped executable (one without debug info), copy the debuggable executable before running strip:

cp <InsertYourApplication>{,-dbg}
strip <InsertYourApplication>

Questions? Problems? Ideas?

To get support, report a bug or suggest future ideas for Auklet, go to https://help.auklet.io and click the blue button in the lower-right corner to send a message to our support team.

About

Official Auklet C/C++ Releaser Tool

https://auklet.io

License:Apache License 2.0


Languages

Language:JavaScript 54.0%Language:Go 22.9%Language:Shell 22.6%Language:Dockerfile 0.5%