README
¶
OpenTelemetry stacktrace processor
Transform stacktraces from javascript into readable stacktraces to improve OpenTelemetry usability.
About
When collecting stacktraces from javascript based application, the stacktraces are usually based on minified or compiled code.
Example:
padStart@http://localhost:4203/lineSlicer.min.js:1:228
padStart@http://localhost:4203/cubeSlicer.min.js:1:228
To be able to know where the actual problem is, you should combine this with a source map. Commercial tracing solutions provide ways to upload source maps to their dashboard, and they figure it out.
This processor is made so the generic OpenTelemetry collector can have the same functionality. Place the source maps in a directory and the processor will read them at startup. The end result:
padStart@lib/lineSlicer.js:11:53
padStart@http://localhost:4203/cubeSlicer.min.js:1:228
In this example the map for lineSlicer.js is available, but not for cubeSlicer. In that case the line is ignored, so there's always a full picture of the flow present.
Installation
Install as described in the OpenTelemetry docs
Changelog & Releases
This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.
Releases are based on Semantic Versioning, and use the format
of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented
based on the following:
MAJOR: Incompatible or major changes.MINOR: Backwards-compatible new features and enhancements.PATCH: Backwards-compatible bugfixes and package updates.
Contributing
This is an active open-source project. We are always open to people who want to use the code or contribute to it.
We've set up a separate document for our contribution guidelines.
Thank you for being involved! 😍
Setting up development environment
This Go project relies on Go. For development improvements, Python is used.
You need at least:
- Go 1.19
- Python 3.10+
- Poetry
poetry install
As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:
poetry run pre-commit run --all-files
Authors & contributors
The original setup of this repository is by Joost Lekkerkerker
For a full list of all authors and contributors, check the contributor's page.
License
MIT License
Copyright (c) 2023 Joost Lekkerkerker
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Documentation
Source Files