{"repo":"highlight/highlight","free":true,"listed":false,"github":"https://github.com/highlight/highlight","clone":"git clone https://github.com/highlight/highlight.git","description":"highlight.io: The open source, full-stack monitoring platform. Error monitoring, session replay, logging, distributed tracing, and more.","language":"TypeScript","stars":9367,"topics":["apm","full-stack","golang","metrics","monitoring","observability","open-source","self-hosted","session-replay","tracing","typescript"],"license":null,"category":"observability_platform","readme_excerpt":"

\n \"docs-thumbnail\"\n

\n

\n PRs Welcome\n \"Join\n \"GitHub\n \"GitHub\n

\n\n

\n Docs - Community (Support & Feedback) - Feature request - Bug report\n

\n\n# [highlight.io](https://highlight.io): The open-source, fullstack monitoring platform.\n\nhighlight.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](#we-build-a-cohesive-product), [modern](#we-build-for-todays-developer) and [fully-featured](#features) monitoring solution, something we wished WE had. And it's all open source :)\n\nAt a high level, highlight.io's feature set is:\n- [Session Replay](#session-replay-understand-why-bugs-happen)\n- [Error Monitoring](#error-monitoring-understand-what-bugs-are-happening)\n- [Logging](#logging)\n\nWe strive to make highlight.io as easy to install as a few lines of code in any environment.\n\nRead more about our [features](#features), [values](#our-values) and [mission](#our-mission) below, and get started at https://highlight.io today!\n\n## Table of Contents\n\n- [Get started for free](#get-started)\n- [Features](#features)\n- [SDKs](#sdks)\n- [Contributors](#contributors)\n- [Mission](#our-mission)\n- [Values](#our-values)\n\n## Get started\n\n### Hosted highlight.io (free to get started!)\n\nThe fastest and most reliable way to get started with highlight.io is signing up for free at [app.highlight.io](https://app.highlight.io). After making an account, getting started is as easy as installing the [client SDK snippet](https://www.highlight.io/docs/getting-started/overview#For-your-frontend).\n\n### Hobby self-hosted\n\nDeploy 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):\n\n```bash\ngit clone --recurse-submodules https://github.com/highlight/highlight\n# or `git submodule update --init --recursive` on git < 2.13\ncd docker && ./run-hobby.sh\n```\n\nAfter 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.\n\nGood for <10k sessions and <50k errors ingested monthly. See our [docs for more info and limitations](https://www.highlight.io/docs/general/company/open-source/hosting/self-host-hobby).\n\n### Enterprise self-hosted\n\nSee our [enterprise self-hosted docs](https://www.highlight.io/docs/general/company/open-source/hosting/self-host-enterprise) to deploy a scalable, production-ready instance with support from our team.\n\n\n## Features\n\n### Session Replay: Understand WHY bugs happen.\n\n- **Dom-based High-fidelity Replay**: Replay every interaction and dom change that happened in a given browser session (powered by https://github.com/rrweb-io/rrweb)\n- **Outgoing Network Requests**: See all the network requests (and their contents) in a given session to reproduce the data that was sent/received by your frontend -> [docs](https://www.highlight.io/docs/general/product-features/session-replay/dev-tools)\n- **Console logs**: Analyze the logs printed (`console.error`, `console.log`, etc..) to the console from your frontend -> [docs](https://www.highlight.io/docs/general/product-features/session-replay/dev-tools)\n- **Embedded Error Monitoring**: See the errors associated with a given session to understand what the user was doing leading up to them.\n- **Session Comments**: Comment on errors to communicate with your team on user frustration, bugs, and more! -> [docs](https://www.highlight.io/docs/general/product-features/general-features/comments)\n- **Integrations with your favorite tools** -> [docs](https://highlight.io/docs/general/integrations/overview)\n\n

\n\"Frame\n

\n\n### Error Monitoring: Understand WHAT bugs are happening.\n\n- **Customizable Error Grouping**: Customize rules for grouping repeated errors -> [docs](https://www.highlight.io/docs/general/product-features/error-monitoring/grouping-errors)\n- **Customizable Alerting Rules**: Customize how often, and where alerts are sent -> [docs](https://www.highlight.io/docs/general/product-features/general-features/alerts)\n- **Embedded Session Replay**: See all of the sessions associated with any given error.\n- **SDK Support**: Support for a long (and growing!) list of [SDKs](#sdks).\n- **Integrations with your favorite tools** -> [docs](https://highlight.io/docs/general/integrations/overview)\n\n

\n\"error-monitoring\"\n

\n\n### Logs: Dig deeper into what's happening on your server.\n\n- **Powerful Search**: Search across all your logs, with automatic property collection -> [docs](https://www.highlight.io/docs/general/product-features/general-features/search)\n- **Log Alerts**: Set thresholds for your log alerts, and view them in the alerts dashboard -> [docs](https://www.highlight.io/docs/general/product-features/general-features/alerts)\n- **Embedded Session Replay and Errors**: See all of the sessions & errors associated to a log.\n- **SDK Support**: Support for a long (and growing!) list of [SDKs](#sdks).\n- **Integrations with your favorite tools** -> [docs](https://highlight.io/docs/general/integrations/overview)\n\n

\n\"logging\"\n

\n\n### Traces: Track the performance of operations on your server.\n\n- **Powerful Search**: Search across all your traces, with automatic property collection -> [docs](https://www.highlight.io/docs/general/product-features/general-features/search)\n- **Log Alerts**: Set thresholds for your log alerts, and view them in the alerts dashboard -> [docs](https://www.highlight.io/docs/general/product-features/general-features/alerts)\n- **Embedded Session Replay, Errors and Logs**: See all of the sessions, errors, and logs associated to a trace.\n- **SDK Support**: Support for a long (and growing!) list of [SDKs](#sdks).\n- **Integrations with your favorite tools** -> [docs](https://highlight.io/docs/general/integrations/overview)\n\n

\n\"logging\"\n

\n\n\n### More?! Metrics? Traces? Merch?\n\nHave an idea for what we should build next? Please share our [community](https://highlight.io/community) or via a Github Issue!\n\n[Read a full list of highlight.io features](https://highlight.io/docs).\n\n## SDKs\n\nAll of our SDKs for highlight.io can be found in the `sdk` [directory](https://github.com/highlight/highlight/tree/main/sdk). To get started with these SDKs, we recommend the [getting started guide](https://www.highlight.io/docs/getting-started/overview) in our docs.\n\n## Contributors\n\n\n\n\n\n \n \n \n \n \n \n
\"Jay
Jay Khatri
💻 📖		\"Vadim
Vadim Korolik
💻 📖		\"Zane
Zane Mayberry
💻 📖		\"Eric
Eric Thomas
💻 📖