documentation/self-host/enterprise-edition/observability.mdx
Observability support helps you understand what's happening inside your self-hosted Hoppscotch instance. With OpenTelemetry integration, you can track performance, diagnose issues faster, and gain insights into how your APIs are being used.
This feature provides real-time visibility into your application's health, making it easier to maintain a reliable service for your team.
Observability gives you the ability to understand your system's internal state by analyzing the data it produces. Instead of guessing why something went wrong, you can see exactly what happened and when.
With Hoppscotch's observability integration, you get access to:
Implementing observability in your Hoppscotch instance helps you:
Hoppscotch uses OpenTelemetry, an industry-standard framework for collecting observability data. OpenTelemetry is vendor-neutral, meaning you can use it with your preferred monitoring tools.
Here's how the data flows:
This setup gives you complete visibility without vendor lock-in.
Track every API request from start to finish, even as it moves through different parts of your system. See exactly how long each step takes and where delays occur.
Monitor your instance's health with up-to-the-minute performance data:
Access detailed logs that include trace IDs, making it easy to find all related information when investigating an issue:
Set up alerts to notify you when something needs attention:
Before enabling observability, make sure you have:
You can deploy the observability stack in two ways:
Best for smaller instances or teams getting started. This approach is quick to set up and works well for most use cases.
<Tip>Check out our detailed guide: Set Up OpenTelemetry Stack with Docker</Tip>
Recommended for larger organizations with high-traffic instances requiring high availability and automatic scaling.
Deploy the OpenTelemetry Collector
Set up the Collector to receive data from your Hoppscotch instance. You can use our example configuration or customize it for your needs.
Connect Storage Backends
Choose where to store your observability data:
Configure Hoppscotch
From the Admin Dashboard, navigate to the Observability settings and enter your Collector endpoint details.
Set Up Visualization
Deploy Grafana or your preferred tool to create dashboards and visualize your data.
Traces show you the complete story of each request:
Each step includes timing information, making it easy to spot slow operations.
Metrics give you quantitative insights:
All observability data is linked together. When you're investigating an issue, you can:
Don't try to monitor everything at once. Begin with:
Add more advanced monitoring as you become comfortable with the basics.
Create alerts based on what matters to your team:
Schedule time to review your observability data:
Observability itself uses resources. Balance insight with overhead:
Your observability data may contain sensitive information. Hoppscotch automatically:
You can further customize what data is collected and retained based on your privacy requirements.
The observability features are designed to have minimal impact on your instance:
These overheads are typically insignificant compared to the benefits of having comprehensive monitoring.
Configure how long to keep observability data:
Adjust these based on your storage capacity and regulatory requirements.
If you don't see data in your observability tools:
If the observability stack is using too many resources:
If some traces are incomplete:
If you need assistance with observability:
<Info>Observability is available exclusively in Hoppscotch Enterprise Edition. Learn more about Enterprise Edition or contact us for a demo.</Info>
Now that you understand observability, you can:
Monitor your instance effectively and maintain a reliable, high-performance API development platform for your organization.