Docs - Community (Support & Feedback) - Feature request - Bug report
highlight.io: The open-source, fullstack monitoring platform.
highlight.io is a monitoring tool for the next generation of developers (like you!). Unlike the age-old, outdated tools out there, we aim to build a cohesive, modern and fully-featured monitoring solution, something we wished WE had. And it's all open source :)
At a high level, highlight.io's feature set is:
We strive to make highlight.io as easy to install as a few lines of code in any environment.
Read more about our features, values and mission below, and get started at https://highlight.io today!
Table of Contents
Get started
Hosted highlight.io (free to get started!)
The fastest and most reliable way to get started with highlight.io is signing up for free at app.highlight.io. After making an account, getting started is as easy as installing the client SDK snippet.
Hobby self-hosted
Deploy a hobby instance in one line on Linux with Docker (we recommend at least 8GB of RAM, 4 CPUs, and 64 GB of disk space):
git clone --recurse-submodules https://github.com/highlight/highlight
# or `git submodule update --init --recursive` on git < 2.13
cd docker && ./run-hobby.sh
After a brief frontend load time, the app should be accessible at https://localhost. Use the password set in docker/.env variable ADMIN_PASSWORD with any valid email address.
Good for docs
- Console logs: Analyze the logs printed (
console.error,console.log, etc..) to the console from your frontend -> docs - Embedded Error Monitoring: See the errors associated with a given session to understand what the user was doing leading up to them.
- Session Comments: Comment on errors to communicate with your team on user frustration, bugs, and more! -> docs
- Integrations with your favorite tools -> docs
Error Monitoring: Understand WHAT bugs are happening.
- Customizable Error Grouping: Customize rules for grouping repeated errors -> docs
- Customizable Alerting Rules: Customize how often, and where alerts are sent -> docs
- Embedded Session Replay: See all of the sessions associated with any given error.
- SDK Support: Support for a long (and growing!) list of SDKs.
- Integrations with your favorite tools -> docs
Logs: Dig deeper into what's happening on your server.
- Powerful Search: Search across all your logs, with automatic property collection -> docs
- Log Alerts: Set thresholds for your log alerts, and view them in the alerts dashboard -> docs
- Embedded Session Replay and Errors: See all of the sessions & errors associated to a log.
- SDK Support: Support for a long (and growing!) list of SDKs.
- Integrations with your favorite tools -> docs
Traces: Track the performance of operations on your server.
- Powerful Search: Search across all your traces, with automatic property collection -> docs
- Log Alerts: Set thresholds for your log alerts, and view them in the alerts dashboard -> docs
- Embedded Session Replay, Errors and Logs: See all of the sessions, errors, and logs associated to a trace.
- SDK Support: Support for a long (and growing!) list of SDKs.
- Integrations with your favorite tools -> docs
More?! Metrics? Traces? Merch?
Have an idea for what we should build next? Please share our community or via a Github Issue!
Read a full list of highlight.io features.
SDKs
All of our SDKs for highlight.io can be found in the sdk directory. To get started with these SDKs, we recommend the getting started guide in our docs.
Contributors
Jay Khatri 💻 📖 |
Vadim Korolik 💻 readme truncated — read the full docs on github Frequently asked questionsIs Highlight free to use?Highlight is open source. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead. What does Highlight do?Real-time observability for modern web applications What is Highlight written in?Highlight is primarily written in TypeScript. Its source is publicly available at https://github.com/highlight/highlight, and it has 9,375 GitHub stars. What is a good open source alternative to Datadog?Highlight is one of the open source options listed as an alternative to Datadog, FullStory, Sentry (hosted). Compare licences, stars and activity side by side on the Highlight profile. |