Integrations

Blackbird cluster (powered by Telepresence) integrates with the following third-party services to enhance your monitoring capabilities:

• Prometheus: Track key metrics related to your traffic manager, including the number of active intercepts, connected users, and resource consumption.
• Grafana: Create visually appealing and interactive dashboards that provide deeper insights into your telepresence activities and traffic manager metrics.

Prometheus

Integrating with Prometheus enables real-time monitoring and performance insights for your system. With this integration, you can track key metrics related to your traffic manager, including the number of active intercepts, connected users, and resource consumption. Prometheus also allows you to monitor developer usage patterns, such as the number of intercepts used and session durations.

To integrate with Prometheus:

1. Specify the Prometheus port by setting a new environment variable for your traffic manager.

2. After configuring the Prometheus port, validate its exposure by port-forwarding the port using Kubernetes.

3. Access the Prometheus dashboard by navigating to http://localhost:9090 in your web browser, and view a comprehensive set of built-in metrics and custom metrics designed to enhance tracking capabilities.

   Name	Type	Description	Labels
   agent_count	Gauge	Number of connected traffic agents.
   client_count	Gauge	Number of connected clients.
   active_intercept_count	Gauge	Number of active intercepts.
   session_count	Gauge	Number of sessions.
   tunnel_count	Gauge	Number of tunnels.
   tunnel_ingress_bytes	Counter	Number of bytes tunnelled from clients.
   tunnel_egress_bytes	Counter	Number of bytes tunnelled to clients.
   active_http_request_count	Gauge	Number of currently served HTTP requests.
   active_grpc_request_count	Gauge	Number of currently served gRPC requests.
   connect_count	Counter	The total number of connects by user.	client, install_id
   connect_active_status	Gauge	Flag to indicate when a connect is active. 1 for active, 0 for not active.	client, install_id
   intercept_count	Counter	The total number of intercepts by user.	client, install_id, intercept_type
   intercept_active_status	Gauge	Flag to indicate when an intercept is active. 1 for active, 0 for not active.	client, install_id, workload

4. Enable scraping to ensure these metrics are collected regularly by your Prometheus server and to maintain a historical record. If you're using the default Prometheus configuration, you can do this by specifying the following pod annotations. These annotations instruct Prometheus to scrape metrics from the traffic manager pod, allowing you to track consumption metrics and other important data over time.

Grafana

Integrating with Grafana allows you to create visually appealing and interactive dashboards that provide deeper insights into your telepresence activities and traffic manager metrics. Blackbird developed a dedicated Grafana dashboard for your convenience. This dashboard is designed to provide you with comprehensive monitoring and visualization tools to effectively manage your environment. For more information, see Grafana.

Use the following JSON model to configure your Dashboard.