firely/server-dashboard repository overview

Firely Server Dashboard is Firely's out-of-the-box metrics dashboard for Firely Server⁠. It visualizes key metrics collected via OpenTelemetry — request throughput, latencies and error rates, as well as resource ingestion insights — without requiring any external tools or additional setup.

The dashboard is not intended to replace production-grade monitoring solutions such as Grafana or Application Insights. For long-term monitoring, analytics and alerting, export your telemetry data to an OpenTelemetry Collector and visualize it in a dedicated monitoring stack instead.

To run the dashboard, Firely Server (and any related services such as Firely Auth or Firely Server Ingest) must be configured to export OpenTelemetry metrics to the dashboard's OTLP gRPC port (4317).

Open your favorite command line tool and type the command:

$ docker run -d -p 7174:7174 -p 4317:4317 -e FirelyServerUrl="http://host.docker.internal:4080" --name firely.server-dashboard firely/server-dashboard

This will spin up a Firely Server Dashboard container. It maps the host ports 7174 (dashboard UI) and 4317 (OpenTelemetry ingestion via gRPC) to the same container ports. It sets the FirelyServerUrl environment variable to the URL where Firely Server is running, and gives the container the name firely.server-dashboard with the switch --name. At last it will run the container in background mode with the switch -d.

Open a browser and use the address http://localhost:7174/⁠. This will show the Firely Server Dashboard. Metrics data typically becomes visible after about a minute.

Further documentation is on the Firely Server documentation pages, and specifically on the Metrics Dashboard page⁠.