Add a resource
A resource is one thing Excubius monitors: a SQL Server instance, a web endpoint, a report server, a host. When you add one, Excubius sets up the default checks of its type at once. This guide shows how to add a resource with the Add resource wizard, test its connection, discover what runs on it, and edit or delete it.
Before you begin
- You need the Entity admin role on the entity that will hold the resource.
- The credential the resource needs is stored, or you are ready to create it in the wizard. See Store a credential for the collector.
- The Excubius server reaches the system on the right port. See Network paths.
Resources that a source reports, such as Azure resources from Azure Monitor or devices from NinjaOne, appear by themselves. You add only what the native collector reaches. Databases and linked servers are not added by hand either: you discover them from their instance.
Add the resource
- Console
- API
- Open Resources and select Add resource.
- Type: choose what it is. Each type shows how many checks it gets by default and the details it needs.
- Place and name: choose the Entity, which decides what it inherits (thresholds, channels, credentials), and enter the Name shown everywhere, for example
sql-ventas-01. - Connection: enter the details of the type, required ones first. They are checked before you go on.
- Tags: add
key:valuepairs, at leastenv,roleandclient, and a Criticality from 1 (low) to 5 (critical). - Credential: choose a suitable credential within reach, None to use the parent resource's, or New credential to create one here.
- Review what you entered, then select Create resource.
curl -s "${H[@]}" -X POST "$BASE/resources" -d "{
\"entity_id\": \"$PROD\", \"type\": \"web_endpoint\", \"name\": \"portal-ventas\",
\"attributes\": {\"url\": \"https://ventas.ciguapa.example/\", \"domain\": \"ciguapa.example\"},
\"tags\": {\"env\": \"prod\", \"role\": \"web\", \"client\": \"ciguapa\"}, \"criticality\": 4
}" | jq '{id, name, checks_provisioned}'
$BASE is https://<your server>/api/v1 and H holds your bearer token; see the API reference.
The default checks are set up at once and the first values arrive within a minute or two. The last screen offers Test connection, Discover for SQL Server instances, Open the resource and Add another.
Details per type
| Type | Required | Other details |
|---|---|---|
| SQL Server instance | host | port (1433 by default); instance for a named instance without a fixed port, reached through SQL Server Browser on UDP 1434 |
| Always On availability group | ag_name | Usually created by discovery, with its listener, replicas and databases |
| SQL Server Reporting Services | portal_url | test_report_path to render one report; host, port, instance and report_server_db (ReportServer by default) for the execution log check |
| Web endpoint / portal | url | expect_status, expect_text; domain (the registrable domain) for domain expiry |
| Windows host | — | ip; without it the collector connects to the resource name |
| Linux host | — | ip and ssh_port (22 by default); without ip the collector connects to the resource name |
| PostgreSQL server | — | host, port |
| Entra ID tenant / domain services | — | tenant_id, domain; holds the identity checks |
| Monitoring platform itself | — | heartbeat_url; holds the platform-wide checks such as update feeds and cloud posture |
| Azure resources | — | resource_id; usually added by the Azure Monitor source |
Test the connection
On the resource page, select Test connection. The collector picks the test up within about 10 seconds and connects with the resource's credential.
| Type | A successful test shows |
|---|---|
| SQL Server instance, availability group | Server name, version, edition and latency, the permissions of the login with any that are missing, and a warning when the login is sysadmin |
| Report server, web endpoint | The address, HTTP status and version, and latency |
A failed test shows the error kind with a hint:
| Error kind | Check |
|---|---|
auth | The login and password, and that the instance accepts SQL logins |
unreachable | The host name, the port and the firewall between the Excubius server and the system |
timeout | The network path; the system did not answer in time |
query | A missing permission of the login |
config | Something to fix in Excubius: the host, the credential or a stored secret |
When the test stays at waiting for the collector and ends with No collector picked it up, the collector is not running, has no token or does not offer that transport. See Collector errors.
Discover what runs on an instance
On a SQL Server instance, select Discover. Discovery reads the server, its availability groups with their replicas, roles and listener, its databases, its linked servers and a SQL Agent summary. It adds them, or updates them, as child resources with their own checks, and reports how many were created, updated and no longer found.
- Run discovery again whenever the topology changes.
- A child that is no longer found is marked missing and kept with its history. It is never deleted by discovery; delete it yourself when it is gone for good.
- On an availability group, add every replica as an instance and run discovery on one of them. See Quickstart: add an availability group.
Edit or delete a resource
- Edit changes the name, the criticality, the tags and the credential. Connection details and the entity are changed through the API:
PATCH /api/v1/resources/{id}withattributesorentity_id. - Delete removes the resource with its discovered children, checks, metrics and alerts. The monitored system itself is never touched.
Editors switch checks on or off and change their interval and thresholds for one resource on its Checks tab; see Resources and the resource page.