https://github.com/traceo-dev/traceo Skip to content Toggle navigation Sign up * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code + Explore + All features + Documentation + GitHub Skills + Blog * Solutions + For + Enterprise + Teams + Startups + Education + By Solution + CI/CD & Automation + DevOps + DevSecOps + Case Studies + Customer Stories + Resources * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles + Repositories + Topics + Trending + Collections * Pricing [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} traceo-dev / traceo Public * Notifications * Fork 3 * Star 192 Traceo is a simple platform to monitor application performance with error handling. License Apache-2.0 license 192 stars 3 forks Star Notifications * Code * Issues 1 * Pull requests 1 * Discussions * Actions * Projects 0 * Security * Insights More * Code * Issues * Pull requests * Discussions * Actions * Projects * Security * Insights traceo-dev/traceo This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags Name already in use A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch? Cancel Create 3 branches 1 tag Code * Local * Codespaces * Clone HTTPS GitHub CLI [https://github.com/t] Use Git or checkout with SVN using the web URL. [gh repo clone traceo] Work fast with our official CLI. Learn more. * Open with GitHub Desktop * Download ZIP Sign In Required Please sign in to use Codespaces. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching Xcode If nothing happens, download Xcode and try again. Launching Visual Studio Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit @piotr-szewczyk @piotrek98 piotr-szewczyk and piotrek98 fix/readme udpates (#57) ... 1a15981 Feb 20, 2023 fix/readme udpates (#57) * fix/removed unnecessary details * Update README.md * Update README.md * fix/readme update, missing screenshots * fix/readme update * fix/missing url --------- Co-authored-by: Piotrek 1a15981 Git stats * 220 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github fix/readme udpates (#57) February 20, 2023 18:15 configs feat: preparation for public release (#52) February 16, 2023 22:24 lib feat/handle logs from sdk as an array of logs February 19, 2023 17:07 public feat/merge develop (#56) February 19, 2023 20:39 scripts/docker feat/merge develop (#56) February 19, 2023 20:39 .dockerignore added docker configuration and bash scripts October 28, 2022 14:40 .gitignore feat/added support for persist sqlite db inside docker volume February 19, 2023 14:02 CHANGELOG.md fix/multiple fixing due to errors on vercel build September 4, 2022 19:07 Dockerfile feat/demo mode and configs improvements February 18, 2023 18:10 LICENSE Add license 1 (#54) February 19, 2023 20:19 README.md fix/readme udpates (#57) February 20, 2023 18:15 View code [ ] Traceo Development status SDK Installation Database Guide Incidents Logs Runtime configuration Metrics Support License README.md Traceo Traceo is an open source set of tool for monitoring of application health by collecting and aggregating data from the software. Development status Not ready for production use. SDK To start using the Traceo platform, you need to integrate with the Traceo SDK, which will start monitoring the status of your application. Installation At this point, the installation of the Traceo platform is done by using the docker image. To pull or run already existing docker image: docker run -d --name=traceo -p 3000:3000 traceo/traceo Application will be available at: http://localhost:3000. Default user is admin/admin. If you want to use custom port then you shuld use: docker run -d --name=traceo -p :3000 traceo/traceo Database By default, Traceo Platform uses the SQLite database. Once the container is stopped, all your data will be deleted. To avoid this, create a docker volume and mount it at application startup. docker volume create traceo-volume docker run -d --name=traceo -v traceo-volume:/usr/traceo -p 3000:3000 traceo/traceo If you want to integrate with PostgreSQL database you have to set the environment variables as below: docker run \ -d -p 3000:3000 \ -e PG_HOST="POSTGRES_HOST" \ -e PG_PORT="POSTGRES_PORT" \ -e PG_DB_NAME="POSTGRSES_DB_NAME" \ -e PG_PASS="POSTGRES_PASSWORD" \ -e PG_USER="POSTGRES_USER" \ --name=traceo \ traceo/traceo Guide Incidents An incident is an exception caught by the SDK which extracts all the most important information about it and sends it to Traceo. Each incident is unique and if another incident of the same type occurs, then he is grouped to the first one. The uniqueness of the incident is checked by comparing the content sended by the SDK. [traceo-inc] An incident can have one of three statuses: Resolved, Unresolved, and In Progress. This status should be updated as work progresses to resolve the issue. Incident details contain the most important information about the given error. As the SDK parses the incident, parser breaks down each stack trace into individual traces, from which it extracts information about the location of the error. Thanks to this, it is able to retrieve the code where the exception occurred. [traceo-inc] Logs Another important feature of Traceo is logger feature which allows you to record the necessary information from the operation of the application. Each log is displayed in the application console (stdout) and sent to the Traceo platform, which can be viewed in the Explore tab. [traceo-log] Runtime configuration Runtime configuration is a collection of data that is retrieved from the application during startup. In the set of these data are eq. information about the operating system, scripts or dependencies used in your application. Depending on the use of a specific SDK, the data may be different. Metrics Metrics are a set of data taken from a given source, correlated with the time of their occurrence. In Traceo, metrics are used to record data about the software your application runs on, including CPU usage, memory usage, RSS and more. To start collecting data from software, Traceo first needs a place to store this information. For this purpose, the previously prepared InfluxDB instance must be connected to the platform in Settings|Data Source tab. [traceo-met] Remeber also to configure options in your TraceoClient configuration in your app. More informations about it is here. Support Feel free to create Issues, Pull Request or Discussions. License Traceo is licensed under the Apache License, Version 2.0. About Traceo is a simple platform to monitor application performance with error handling. Topics nodejs typescript error-monitoring bug-tracker tracing error-handling error bugs Resources Readme License Apache-2.0 license Stars 192 stars Watchers 5 watching Forks 3 forks Releases 1 0.3.12 Latest Feb 19, 2023 Packages 0 No packages published Contributors 2 * @piotrek98 piotrek98 Piotrek * @piotr-szewczyk piotr-szewczyk Piotrek Szewczyk Languages * TypeScript 96.8% * JavaScript 2.0% * Other 1.2% Footer (c) 2023 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.