Files
homarr/apps/docs/docs/widgets/tracearr/index.mdx
T

60 lines
3.0 KiB
Plaintext

---
title: "Tracearr"
description: "Monitor media server streams, user activity, and policy violations."
hide_title: true
---
import { WidgetInteractionGuide } from "@site/src/components/widgets/interactions";
import { AddingWidget } from "@site/src/components/widgets/adding";
import { WidgetConfig } from "@site/src/components/widgets/configuration";
import { WidgetHeader } from "@site/src/components/widgets/header";
import { WidgetIntegrations } from "@site/src/components/widgets/integrations";
import { tracearrWidget } from ".";
import { tracearrIntegration } from "@site/docs/integrations/tracearr";
<WidgetHeader widget={tracearrWidget} categories={["Media Monitoring"]} />
The Tracearr widget provides a real-time monitoring dashboard for your media server activity. It displays active streams, user statistics, recent watching history, and policy violations. Compact mode renders every enabled section in that familiar order without hiding or truncating sections based on widget height.
When multiple Tracearr integrations are selected, every stream, violation, and activity row keeps its source identity and an integration-scoped key. Data from healthy sources remains visible if another source fails, and a warning identifies each unavailable integration without exposing private request details. If every selected integration fails, the widget reports an error; if cached data remains visible after a later total failure, a stale-data warning is shown.
### Sections
| Section | Description |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| **Stats Bar** | Displays Active Streams, Total Users, Transcode Count, and Total Bandwidth at a glance. |
| **Active Streams** | Shows currently playing media with poster art, user info, progress bar, resolution, and transcoding status (Direct Play or Transcode). |
| **Recent Activity** | A paginated list of watching history with user avatars and watched status. |
| **Violations** | Alerts for policy violations (e.g., concurrent stream limits) with severity levels. |
### Screenshots
import widgetOverview from "./img/widget-overview.png";
import streamsAndStats from "./img/streams-and-stats.png";
<div className="flex flex-col gap-2">
<img src={widgetOverview} alt="tracearr-widget-overview" width={128 * 4} />
<img src={streamsAndStats} alt="tracearr-streams-and-stats" width={128 * 4} />
</div>
<WidgetInteractionGuide />
### Adding the widget
<AddingWidget />
### Supported Integrations
<WidgetIntegrations
items={[
{
integration: tracearrIntegration,
},
]}
/>
### Configuration
<WidgetConfig configuration={tracearrWidget.configuration} />