Dashboards & reports

Three pages at the top of the sidebar show your data:

• Overview: the home page, with the current project's key numbers.
• Dashboards: your own live views, built from templates, a visual builder or JSON.
• Reports: tables of real data as PDF, Excel or CSV, on demand or on a schedule, plus styled PDF reports with charts.

All three need Read only on Dashboards & reports. Creating and editing needs Read & modify. They show the current project's data, plus agents and notifications shared with every project. OpsNexus shows real data only: when nothing is connected, you see empty states instead of sample numbers.

#Overview

The Overview greets you and shows what needs attention. Its content depends on what you can see:

• Key numbers: Pipelines, Builds · 24 h, Failed · 24 h, Agents online, and, if you have access, Cloud spend · month and Open alerts. Each tile links to its page.
• Builds per day · last 14 days and Build health · 14 days: success rate, succeeded, failed, total builds and average duration.
• Cloud spend: month-to-date spend and daily usage for the last 30 days.
• Servers & alerts: open alerts by severity and CPU and memory per server.
• Security findings: open findings by severity.
• Recent builds and Recent activity from the audit log.

Shortcuts at the top lead to New pipeline, View builds and Cloud costs, depending on your permissions. If no CI/CD tool is connected yet, the page asks you to Add integration.

#Dashboards

#The dashboard list

Open Dashboards. The list can be filtered to all, home, shared or private, and searched by name. A dashboard is either Private (only you see it) or Shared with your organization.

To create one:

• Select New dashboard for a blank dashboard.
• Select Use template on a template.
• Select Import JSON to paste or upload a definition.

#Templates

The gallery also shows Kubernetes, Docker, Security and Artifact templates marked Coming with the module. They can't be used yet.

#Edit a dashboard

1. Open the dashboard and select Edit.
2. Change the Name, the Refresh interval (15 seconds to 15 minutes) and Share with organization.
3. Select Add widget, then choose:
   • Data: the data source.
   • Show as: the widget type. Only types that fit the data are offered.
   • Title.
   • Platform filter and Period (days), for sources that support them.
4. Drag widgets to reorder them. Use the arrows to make a widget narrower, wider, shorter or taller, and the cross to remove it.
5. Select Save dashboard.

The editor has two tabs: Visual builder and JSON. In the JSON tab, edit the definition and select Validate & apply.

Other actions on a dashboard: Export JSON, Duplicate (the copy is private and yours) and Set as home. You can edit or delete dashboards you own. Editing other people's shared dashboards needs Full access on Dashboards & reports.

#Widget types

#Data sources

#Dashboard JSON

{
  "refresh_seconds": 60,
  "widgets": [
    { "id": "w1", "type": "metric", "title": "Success rate", "source": "builds.success_rate", "params": {}, "w": 1, "h": 1 },
    { "id": "w2", "type": "bar", "title": "Builds per day", "source": "builds.trend", "params": { "days": 14, "platform": "jenkins" }, "w": 3, "h": 1 }
  ]
}

Invalid JSON is rejected with a message for each problem, for example which widget types can show a given source.

#Reports

Reports has two tabs: Generate and Scheduled.

#Report types

Reports cover the current project. The Audit log report covers the whole organization and is only listed for people with Read only on Audit logs.

#Generate a report

1. Open Reports, tab Generate.
2. In Generate a report, pick a report.
3. Set From and To.
4. Choose the Format: PDF, Excel or CSV.
5. Select Generate & download.

PDF reports are landscape A4 and show up to 5,000 rows. Use Excel or CSV for larger data. CSV files include a byte-order mark so Excel opens them as UTF-8.

Recent reports lists generated and scheduled reports, with period, format, row count and size, and a Download button. Reports are kept for 90 days by default (REPORT_RETENTION_DAYS).

#Schedule a report

Scheduled reports are sent through an email (SMTP) notification channel. If you don't have one, the tab asks you to set one up first. See Notifications.

1. Open the Scheduled tab and select New schedule.
2. Enter a Name and pick the Report.
3. Set Every: Day, Week or Month.
4. Set Covering (days): how many days back each report covers, from 1 to 366.
5. Choose the Format.
6. Enter Email to (comma-separated) and pick the channel in Send through.
7. Select Save.

The schedule list shows the next run and the result of the last run: Sent, or a failure such as an email error. Select Send now to run a schedule at once. Managing schedules needs Read & modify on Dashboards & reports.

#Report plugins: PDF with charts

The Report plugins · PDF with charts card makes styled PDF reports with bar, pie, donut and line charts.

To make one:

1. Select the report's button.
2. Pick a Layout, or keep Built-in look (not saved).
3. For period-based reports, choose the Period (last 7 to 365 days; the Cost report goes up to 90).
4. Under Style, pick Classic, Modern, Minimal or Dark. Under Chart colours, pick a palette or an accent colour.
5. Optionally set a Title (optional), Subtitle (optional), Page size (A4 or Letter, portrait or landscape) and a Logo (optional) in PNG or JPEG under 200 KB.
6. Turn Cover page with contents on or off.
7. Under Sections, turn sections on or off, pick the chart for each, and reorder them.
8. Select Download PDF.

To reuse the look, enter a Layout name under Save this look for the project and select Save layout. Turn on Default for this report to make it the default layout. Layouts are saved per project and need Read & modify on Dashboards & reports.

#Related pages

• Audit logs
• Cost & budgets
• Notifications