mirror of https://github.com/OneUptime/oneuptime synced 2024-11-22 07:10:53 +00:00

History

Simon Larsen 8ebcb1b659 Update infrastructure agent to use tsx instead of ts-node		2024-04-03 10:47:02 +01:00
..
Jobs	Add ServerProcess interface and processes field to ServerMonitorResponse	2024-04-02 19:47:22 +01:00
Scripts/Build	Remove Linux installation script and update server monitor documentation	2024-03-18 13:22:24 +00:00
Types	Add ServerProcess interface and processes field to ServerMonitorResponse	2024-04-02 19:47:22 +01:00
Utils	Add logging for server processes	2024-04-02 20:29:12 +01:00
Dockerfile.tpl	Remove unnecessary files and update dependencies	2024-03-12 11:06:45 +00:00
Index.ts	Update infrastructure agent to use tsx instead of ts-node	2024-04-03 10:47:02 +01:00
nodemon.json
package-lock.json	Update infrastructure agent to use tsx instead of ts-node	2024-04-03 10:47:02 +01:00
package.json	Update infrastructure agent to use tsx instead of ts-node	2024-04-03 10:47:02 +01:00
README.md	Add deprecated comment to ServerMonitor route and refactor BasicMetrics to get disk paths dynamically	2024-04-01 11:33:59 +01:00
sea-config.json	Update sea-config.json and .gitignore, and add build script to package.json	2024-03-12 13:47:37 +00:00
tsconfig.json	Remove unnecessary files and update dependencies	2024-03-12 11:06:45 +00:00

README.md

OneUptime Infrastructure Agent

The OneUptime Infrastructure Agent is a lightweight, open-source agent that collects system metrics and sends them to the OneUptime platform. It is designed to be easy to install and use, and to be extensible.

Installation

npm i @oneuptime/infrastructure-agent -g

# You can change the host to your own host if you're self hosting the OneUptime platform. 
# You can find the secret key on OneUptime Dashboard. Click on "View Monitor" and go to "Settings" tab.

oneuptime-infrastructure-agent --secret-key=YOUR_SECRET_KEY --oneuptime-url=https://oneuptime.com

Once its up and running you should see the metrics on the OneUptime Dashboard.

Local Development

When you're developing locally, you can run the agent in development mode to send metrics to local oneuptime server.

npm run start -- --secret-key=YOUR_SECRET_KEY --oneuptime-url=http://localhost