Skip to content

Twingate-Community/dashboards

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

Twingate Community Dashboards 📊

Welcome to the ultimate collection of monitoring dashboards for your Twingate deployment! This repository is your one-stop shop for gaining deep insights into your network performance, security posture, and operational efficiency.

🚀 Elevate Your Twingate Deployment

Transform your Twingate network from a black box into a fully observable, data-driven infrastructure. Whether you're a network administrator, security engineer, or DevOps professional, these dashboards will give you the visibility you need to optimize performance, troubleshoot issues, and make informed decisions.

📈 Available Dashboards

Twingate Insights Dashboard

Location: grafana/insights.json

Our flagship monitoring dashboard provides comprehensive visibility into your Twingate network behavior:

  • 🔄 Transport Analytics: Real-time breakdown of traffic across direct connections, relay/hydra, and relay/quic transports
  • 📊 Traffic Monitoring: Track inbound/outbound bytes and transfer rates across your entire network
  • ⚡ Performance Metrics: Monitor Connector uptime, resource counts, and network efficiency
  • 📋 Quick Stats: At-a-glance performance indicators for rapid assessment

Key Features:

  • Compatible with Grafana 12.2.1+
  • Prometheus data source integration
  • Real-time metrics visualization
  • Multi-panel layout for comprehensive monitoring

� Expand the Collection

This is just the beginning! We believe the best dashboards come from real-world experience and community collaboration. Help us grow this collection by contributing dashboards that solve your specific monitoring challenges.

💡 Got Ideas? We Want to Hear Them

Have ideas for dashboards that would benefit the Twingate community? We'd love to hear about them:

  • 🐛 Submit suggestions via GitHub Issues - tell us what monitoring challenges you're facing
  • 🚀 Share your dashboards via Pull Requests - contribute your own creations to help others
  • 📊 Request specific metrics - let us know what data points would be most valuable to you

🛠️ Getting Started

Prerequisites

  • Grafana instance (v12.2.1 or higher)
  • Prometheus data source configured
  • Twingate Connector(s) with metrics collection enabled TODO: Add link to health metrics guide here

Installation

  1. Download the dashboard file:

    • Navigate to the dashboard you want (e.g., grafana/insights.json)
    • Click the "Download" button or "Raw" then save the file
    • Alternatively, copy the JSON content directly from GitHub
  2. Import into Grafana:

    • Open your Grafana instance
    • Navigate to DashboardsImport
    • Upload the downloaded .json file or paste the JSON content
    • Configure your Prometheus data source when prompted
  3. Start monitoring:

    • Access your newly imported dashboard
    • Customize time ranges and variables as needed
    • Set up alerts for critical metrics

📋 Requirements

  • Grafana: Version 12.2.1 or higher
  • Data Source: Prometheus with Twingate metrics collection
  • Twingate Metrics: Ensure your Twingate Connectors are configured to export metrics

🤝 Contributing

We welcome contributions from the Twingate community! Help us build the most comprehensive dashboard collection:

  • Submit new dashboards for different use cases
  • Improve existing visualizations with better queries or layouts
  • Add documentation for setup and customization
  • Share your monitoring strategies and best practices

How to Contribute

  1. Fork this repository
  2. Create a feature branch (git checkout -b feature/new-dashboard)
  3. Add your dashboard files and documentation
  4. Submit a pull request with detailed description

🔧 Customization

All dashboards are designed to be easily customizable:

  • Variables: Adjust connector filters, time ranges, and aggregation levels
  • Thresholds: Set custom alert levels for your environment
  • Layouts: Rearrange panels to match your monitoring workflow
  • Styling: Modify colors, legends, and display options

📞 Support & Community

  • Issues: Report bugs or request features via GitHub Issues
  • Community: Connect with other Twingate users and share your experiences on Reddit

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🌟 Why Choose These Dashboards?

  • Production-Ready: Built and tested by the Twingate community
  • Best Practices: Incorporates monitoring expertise from network professionals
  • Continuous Updates: Regular improvements and new features
  • Community-Driven: Shaped by real-world use cases and feedback
  • Comprehensive Coverage: Everything from basic monitoring to advanced analytics

Ready to take your Twingate monitoring to the next level? Start with our Insights dashboard and join the growing community of users gaining unprecedented visibility into their networks!


Made with ❤️ by the Twingate Community

About

Collection of Grafana dashboards built and curated by the Twingate Community

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors